Arch-Orbital-HUD

A general purpose HUD for Dual Universe, based on DU Orbital Hud 5.450 and earlier

For assistance, see my personal Discord or the OSIN discord channel Discord

Donations are accepted but not expected. You may donate to Archaegeo in game via Wallet or to https://paypal.me/archaegeo for Paypal.

Table of Contents

|Change Log | |Warnings |Installation| |Usage / Hotkey Reference |Variable Persistence |Customization |Examples and Tutorials |Credits |

Features List (More coming, for now use this link)

https://docs.google.com/document/d/1HcoCwX9QqZt6SBJYQAZOf7sYLWXVJeUnE68RndYnPDY/

Return to Table of Contents

Warnings

DISCLAIMER: We do not accept any responsibility for incorrect use of the autopilot, which may result in fiery reentry, mountain impacts or undesired entrance into PvP. Read and heed the warnings below!

⚠️ Autopilot (Space) - Ensure you have LOS (line of sight) to the target body before engaging as autopilot is direct flight and does not detect bodies (will fly into a planet / body if in between starting position and destination).

⚠️ Auto-Rentry - Not suitable for bodies without atmosphere.

Return to Table of Contents

Installation

This section is broken down into three parts.
1) Pre-installation notes.
2) Instructions to locate the release (which also contains install instructions).
3) Post-installation notes.
Please read this section in its entirety before proceeding with the installation.

1) Pre-installation Notes:

▪️ Button - If manually connected to the seat, will be pressed when you enter (sit), and open / extend when you exit (stand).

▪️ Databank - Although not required, we recommend a databank to be used. This allows the HUD to save your user preferences and some long-term variables. In addition, flight status is saved if you leave and return to the seat. Databanks must be manually slotted the first time you install script.

▪️ Doors / Forcefields - If manually connected to the seat, will close / retract when you enter (sit), and open / extend when you exit (stand). Ensure they are closed / retracted before connecting to the seat.

▪️ Fuel tanks - If not manually connected provide a rough estimate of fuel levels (set parameters for fuel tank handling, fuel tank optimization, and container optimization). If manually connected, more accurate readings are provided and a non-HUD widget is updated.

How to Install

1. Go here: https://github.com/Archaegeo/Archaegeo-Orbital-Hud/releases and then scroll down the the Assets and click on ArchHUD.conf, this should trigger a download for this file.
2. Save the file to %ProgramData%\Dual Universe\Game\data\lua\autoconf\custom (or equivalent directory if you did not do default install), the filename does not matter (as long as it's still .conf)
3. If using a databank, manually link the databank to the control unit(s) that will be running the HUD PRIOR to the next step.
4. In-game, right click your seat and go to Advanced -> Update custom autoconf list - If you get a YAML error, you did not follow the above directions correctly.
5. Again, right click your seat and select Advanced -> Run Custom Autoconfigure -> ArchHud - Archaegeo
6. IMPORTANT: Right click the seat and set the user control scheme to Keyboard (Advanced -> Change Control Scheme -> Keyboard). This is necessary for the HUD to work, but you can change the actual control scheme in the next step - fear not virtual joystick aces!
7. To most easily set up user preferences the first time, right click the seat, choose Advanced -> Edit LUA Parameters. You may also change control scheme using a Button while seated and change all other user parameters.
8. If you have a Databank installed on your vehicle your parameters will save when you stand up. Saved parameters will be restored any time you upgrade the HUD to a new version.
9. Please see https://github.com/Archaegeo/Archaegeo-Orbital-Hud/blob/master/UserSettings.md for an explanation of all settings.

FOR COCKPIT USAGE:

1. Manually connect databank to cockpit. Run the ArchHUD on the cockpit per normal install instructions above.
2. Install a Programming Board on ship.
3. Manually connect same databank connected to cockpit to programming board.
4. Edit Lua Parameters and set Cockpit to true (This can be done from another control unit via buttons to support both cockpit and chair/remote flying)
5. Paste the CockpitPB.json script to the programming board. Activate programming board before getting in cockpit (or after if visible from cockpit)

FOR SOUND SUPPORT:

1. Download and extract to location of your choice the ZIP file found at https://github.com/ZarTaen/DU_logfile_audioframework/releases
2. Download the archHudSoundPack.zip file found at https://github.com/Archaegeo/Archaegeo-Orbital-Hud/blob/master/archHudSoundPack.zip.
3. In the audiopacks folder of the Logfile extraction, extract the archHudSoundPack.zip. This should result in a subfolder named archHUD
4. Any sound file in the audiopack may be replaced with a different sound file using same filename if you choose to personalize.
5. If you dislike any particular sound and do not want to replace it but still want the other sounds, simply remove its .mp3 file from the soundpack folder.
6. Run the DU_logfile_audioframework.exe file found in the extract file, (source code is available at the above github site for those who are concerned)
7. Voices can be turned off by setting voices user variable to false. Alerts can be turned off by setting alerts to false.
8. Sound volumes can be controlled by the soundVolume setting, which defaults to 100.
9. Alt-7 will toggle all sounds on or off
10. NOTE: You MUST change the name of the soundpack subfolder and the userVariable soundFolder to something other than "archHUD". Use /G soundFolder NewName in lua chat for existing systems. This is to prevent others from making your PC play sounds they think you have installed.
11. STREAMERS ONLY: For your viewers to hear the sounds/voices, you will need to add the DU_logfile_audioframework.exe as an audio source for your stream.

3) Post-installation Note:

▪️ This HUD uses on-screen buttons, and so needs to be able to use your mouse. The only way to keep DU from trying to use your mouse for input is to set the Control Scheme to Keyboard. You can then right click the seat, Advanced -> Edit LUA Parameters and find the checkboxes to choose which control scheme you would actually like to use.

Return to Table of Contents

Usage

The HUD makes use of on-screen buttons and keyboard controls. An overview followed by more detailed descriptions are below:

Item	Key(s)	Brief Description
UI Overlay	Hold SHIFT	Displays the UI overlay with mouse-over buttons. Hover with mouse over a button (not click!) and let go of SHIFT to select it.
Save Location	Hold SHIFT then selecting the Save Position mouseover	Will save the current location in the databank (if installed). This location may be selected by the autopilot option to automatically fly to the destination. It will not monitor for impeeding structures or ships. Monitor during use. Locations will be named by planet/moon and a number.
Update Location	Hold SHIFT then selecting the Update Position mouseover	Select a previously saved location in the Interplanetary Helper to change its name with the name of the closest atmo radar target name.
Vanilla Widget View	Option 3, or ALT-3	Toggles hud off and vanilla widgets on. Good for when you need to get FPS back in crowded places.
Autopilot Destination / Destination Select	Option 1 and Option 2, ALT-1 and ALT-2 or SHIFT-R and SHIFT-T	Cycles through autopilot destinations (planets / bodies / saved waypoints).
Autopilot	Option 4, or ALT-4	Alt-4 will fly to selected waypoint. Alt-4-4 will perform orbital hop to same player waypoint.
Lock Pitch	Option 5, or ALT-5	Will lock your target pitch at current pitch and attempt to maintain that pitch (this is different from Altitude Hold) Most other AP features will cancel Lock Pitch.
Altitude Hold	Option 6, or ALT-6	Toggles the altitude hold functionality. Tries to keep the current altitude in spite of planetary curvatore. Depending on ship's lift/force, the actual height may be less than the targeted height! Adjust altitude with (left) ALT-C (down) and (left) ALT-SPACE (up) in increments (growing increments if key is kept held down).
Follow Me	Option 8, or ALT-8	Engage follow mode if you are using Remote Control.
Enable Gyro	Option 9, or ALT-9	Engage gyro if on ship. Changes ships perceived orientation to gyro's orientation.
Anti-Gravity Generator	ALT-G (default mapping) or HUD button	Once engaged, hold ALT-C to lower target height or ALT-Space to raise target height. The AGG's actual height will only change at 4m/s up or down toward the target altitude. Initiate new target altitude before leaving seat and AGG will continue changing.

Item	Detailed Description
User text input	To use, hit TAB and then ENTER to send messages to LUA Chat (this will not cause the known tab fps slideshow if the chat tab is open first). Currently supported commands: /commands - shows command list and help /G VariableName value - changes the global variablename (corresponding to the same-named LUA parameter) to the specified new value. Note: names are case-sensitive! Examples: /G AtmoSpeedLimit 1300 sets that LUA parameter to 1300km/h or /G circleRad 100 would shrink the artifical horizon down to 100 from default 400. /agg height - Sets the AGG target height to height (in meters). Note that it must still move to this height at 4m/s like normal. /addlocation savename waypointpaste - Adds a new saved location based on waypoint. The savename must not contain spaces/blanks! Not as accurate as going to location and using Save button. /setname name - renames the current selected saved postion to "name"
UI Overlay	Hold SHIFT to show the UI overlay with buttons (not in freelook!). Mouse over a button and let go of SHIFT to select it (not clicking it). While holding SHIFT, press R/T (speedup/speeddown) to cycle between autopilot targets.
Free Look	ALT is now a toggle for free-look. Because of the way we had to use Keyboard mode, it can't re-center when you lock it back, but that can be desirable in some situations
Autopilot Destination / Destination Select	ALT-1 and ALT-2 (Option1 and Option2) to scroll between target planets for Autopilot and display. This also works using SHIFT-R and SHIFT-T to scroll. This widget will not display if no planet is selected (ie you must press one of these hotkeys after entering the seat in order to show the widget)
HUD Toggle	ALT-3 toggles the HUD and other widgets off/on. Orbital display and autopilot information will still show if HUD is off. There is a parameter you can set to have HUD and Widgets on at same time.
Autopilot	ALT-4 to engage Autopilot for interplanetary travel, if you are in space and have a planet targeted. Ensure you have a clear line of sight to the target. This will align to the target, realign slightly to point 200km to the side of the target, accelerate, cut engines when at max, start braking when appropriate, and hopefully achieve a stable orbit around the target. You can set your target orbit distance in parameters, default is 100km. Recommend do not go less then 35km.
Lock Pitch	ALT-5 (Option 5) will lock your pitch at current pitch and attempt to maintain that pitch (this is different from Altitude Hold) Most other AP features will cancel Lock Pitch.
Altitude Hold -	ALT-6 to toggle Altitude Hold.
Follow Mode	ALT-8 will toggle Follow Mode when using a Remote Controller. This makes your craft lift off and try to follow you wherever you go via hover/vBooster engines and tilting the ship. It will not go below ground unless you dig out a big enough hole that it would naturally go down while hovering.
Toggle Gyro	ALT-9 to toggle a linked gyro on or off. If a gyro is installed on your ship, this will change your ships perceived orientation from Core to Gyro. This is used to allow you to control flight based on gyro orientation and not core orientation.
Radar	Radar indicates below minimap number of targets or if it is jammed (atmosphere in space or space in atmosphere). The radar widget only pops up if targets are detected. The periscope widget only pops up if you click a target and successfully identify it. All widgets close automagically.
Return to Table of Contents

Variable Persistence

As mentioned briefly above, your custom variables are saved between reloading configurations if you attach a databank to the ship. However, all variables in the program are saved in the databank when you exit the seat. This means it will be exactly as you left it - if you were landed when you got out, it won't jump off the ground when you get it.

This also means that when using autopilot, you can relatively easily move between a seat and Remote Controller; it will be down for a short time while you swap, but everything is saved and it will pick up where it left off.|

Return to Table of Contents

Examples and Tutorials

Return to Table of Contents

No Autopilot Version

There is not currently a working No Autopilot version

Return to Table of Contents

Credits

Rezoix and his HUD - https://github.com/Rezoix/DU-hud

JayleBreak and his orbital maths/atlas - https://gitlab.com/JayleBreak/dualuniverse/-/tree/master/DUflightfiles/autoconf/custom

Dimencia and all of his hard math work on the autopilot and other features.

Return to Table of Contents