DU-Orbital-HUD

A general purpose HUD for Dual Universe

Cockpits are NOT supported.

For assistance, see our Discord

Donations are accepted! We have a Donation Station in Sanctuary District 3 and more to come or you can always contact us and do a VR trade. We do not spend any time mining or building so our funds to test features are limited.

Table of Contents

Features List

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!

⚠️ Auto-Land - Use with supervision. Will only engage if brakes > total mass. Uses brakes and hovers / vertical engines to lower you to a safe landing.

⚠️ Autopilot (Space) - Not suitable for interplanetay trips less than 2SU. 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).

⚠️ Autopilot to Saved Location - Accurate within roughly 15m of saved and selected location assuming a brake landing is available. If Coast Landing is displayed, you will need to resume control upon arrival at your destination.

⚠️ Auto-Rentry - Not suitable for bodies without atmosphere. Not suitable for bodies with high altitudes (Thades etc.). Know the altitude of the surface before using! Alt-Space and/or Alt-C may be used to adjust hover altitude as needed.

Return to Table of Contents

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.

▪️ 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 talent). If manually connected, more accurate readings are provided and a non-HUD widget is updated.

2) On the right side of this page, locate and click on "Releases" or select the "Release" listed as the latest. Detailed changelog and installation instructions are located there.

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:

Variable Persistence

As mentioned briefly above, your custom variables are saved between reloading configurations if you attach a databank to the ship (and use Alt+7 to save them). 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

Customization

Right click the seat and go to Advanced -> Edit Lua Parameters to see them all. Mouse over a name to see its purpose and potential settings.

• -- Edit LUA Variable user settings. Must be global to work with databank system as set up due to using _G assignment
• useTheseSettings = false -- export: (Default: false) Toggle on to use the below preferences. Toggle off to use saved preferences. Preferences will save regardless when exiting seat.
• freeLookToggle = true -- export: (Default: true) Set to false for vanilla DU free look behavior.
• BrakeToggleDefault = true -- export: (Default: true) Whether your brake toggle is on/off by default. Can be adjusted in the button menu. Of is vanilla DU brakes.
• RemoteFreeze = false -- export: (Default: false) Whether or not to freeze you when using a remote controller. Breaks some things, only freeze on surfboards
• RemoteHud = false -- export: (Default: false) Whether you want full HUD while in remote mode, experimental, might not look right.
• brightHud = false -- export: (Default: false) Enable to prevent hud dimming when in freelook.
• VanillaRockets = false -- export: (Default: false) If on, rockets behave like vanilla
• InvertMouse = false -- export: (Default: false) If true, then when controlling flight mouse Y axis is inverted (pushing up noses plane down) Does not affect selecting buttons or camera.
• userControlScheme = "virtual joystick" -- export: (Default: "virtual joystick") Set to "virtual joystick", "mouse", or "keyboard"
• ResolutionX = 1920 -- export: (Default: 1920) Does not need to be set to same as game resolution. You can set 1920 on a 2560 to get larger resolution
• ResolutionY = 1080 -- export: (Default: 1080) Does not need to be set to same as game resolution. You can set 1080 on a 1440 to get larger resolution
• SafeR = 130 -- export: (Default: 130) Primary HUD color
• SafeG = 224 -- export: (Default: 224) Primary HUD color
• SafeB = 255 -- export: (Default: 255) Primary HUD color
• PvPR = 255 -- export: (Default: 255) PvP HUD color
• PvPG = 0 -- export: (Default: 0) PvP HUD color
• PvPB = 0 -- export: (Default: 0) PvP HUD color
• centerX = 960 -- export: (Default: 960) X postion of Artifical Horizon (KSP Navball), Default 960. Use centerX=700 and centerY=880 for lower left placement.
• centerY = 540 -- export: (Default: 540) Y postion of Artifical Horizon (KSP Navball), Default 540. Use centerX=700 and centerY=880 for lower left placement.
• throtPosX = 1300 -- export: (Default: 1300) X position of Throttle Indicator, default 1300 to put it to right of default AH centerX parameter.
• throtPosY = 540 -- export: (Default: 540) Y position of Throttle indicator, default is 540 to place it centered on default AH centerY parameter.
• vSpdMeterX = 1525 -- export: (Default: 1525) X postion of Vertical Speed Meter. Default 1525 (use 1920x1080, it will scale)
• vSpdMeterY = 250 -- export: (Default: 250) Y postion of Vertical Speed Meter. Default 250 (use 1920x1080, it will scale)
• altMeterX = 550 -- export: (Default: 550) X postion of Altimeter. Default 550 (use 1920x1080, it will scale)
• altMeterY = 540 -- export: (Default: 540) Y postion of Altimeter. Default 500 (use 1920x1080, it will scale)
• fuelX = 100 -- export: (Default: 100) X position of fuel tanks, default is 100 for left side, set both fuelX and fuelY to 0 to hide fuel
• fuelY = 350 -- export: (Default: 350) Y position of fuel tanks, default 350 for left side, set both fuelX and fuelY to 0 to hide fuel
• circleRad = 400 -- export: (Default: 400) The size of the artifical horizon circle, recommended minimum 100, maximum 400. Looks different > 200. Set to 0 to remove.
• DeadZone = 50 -- export: (Default: 50) Number of pixels of deadzone at the center of the screen
• DisplayOrbit = true -- export: (Default: true) Show Orbit display when valid or not. May be toggled with shift Buttons
• OrbitMapSize = 250 -- export: (Default: 250) Size of the orbit map, make sure it is divisible by 4
• OrbitMapX = 75 -- export: (Default: 75) X postion of Orbit Display Disabled
• OrbitMapY = 0 -- export: (Default: 0) Y position of Orbit Display
• showHud = true -- export: (Default: true) Uncheck to hide the HUD and only use autopilot features via ALT+# keys.
• ShowOdometer = true -- export: (Default: true) Uncheck to hide the odometer panel up top.
• hideHudOnToggleWidgets = true -- export: (Default: true) Uncheck to keep showing HUD when you toggle on the widgets via ALT+3.
• ShiftShowsRemoteButtons = true -- export: (Default: true) Whether or not pressing Shift in remote controller mode shows you the buttons (otherwise no access to them)
• YawStallAngle = 35 --export: (Default: 35) Angle at which the ship stalls when yawing (Stabilizers: 70, Wings: 55, Ailerons: 30)
• PitchStallAngle = 35 --export: (Default: 35) Angle at which the ship stalls when pitching (Stabilizers: 70, Wings: 55, Ailerons: 30)
• speedChangeLarge = 5 -- export: (Default: 5) The speed change that occurs when you tap speed up/down, default is 5 (25% throttle change).
• speedChangeSmall = 1 -- export: (Default: 1) the speed change that occurs while you hold speed up/down, default is 1 (5% throttle change).
• brakeLandingRate = 30 -- export: (Default: 30) Max loss of altitude speed in m/s when doing a brake landing, default 30. This is to prevent "bouncing" as hover/boosters catch you. Do not use negative number.
• MaxPitch = 30 -- export: (Default: 30) Maximum allowed pitch during takeoff and altitude changes while in altitude hold. You can set higher or lower depending on your ships capabilities.
• ReentrySpeed = 1050 -- export: (Default: 1050) Target re-entry speed once in atmosphere in km/h.
• AtmoSpeedLimit = 1050 -- export: (Default: 1050) Speed limit in Atmosphere in km/h. If you exceed this limit the ship will attempt to break till below this limit.
• SpaceSpeedLimit = 30000 -- export: (Default: 30000) Space speed limit in KM/H. If you hit this speed but are not in active autopilot, engines will turn off.
• ReentryAltitude = 2500 -- export: (Default: 2500) Target alititude when using re-entry.
• AutoTakeoffAltitude = 1000 -- export: (Default: 1000) How high above your ground starting position AutoTakeoff tries to put you
• TargetHoverHeight = 50 -- export: (Default: 50) Hover height when retracting landing gear
• LandingGearGroundHeight = 0 --export: (Default: 0) Set to AGL-1 when on ground (or 0)
• MaxGameVelocity = 8333.00 -- export: (Default: 8333.00) Max speed for your autopilot in m/s, do not go above 8333.055 (30000 km/hr), can be reduced to safe fuel, use 6944.4444 for 25000km/hr
• TargetOrbitRadius = 1.4 -- export: (Default: 1.4) How tight you want to orbit the planet at end of autopilot. The smaller the value the tighter the orbit. 1.4 sets an Alioth orbit of 56699m.
• AutopilotInterplanetaryThrottle = 1.0 -- export: (Default: 1.0) How much throttle, 0.0 to 1.0, you want it to use when in autopilot to another planet to reach MaxGameVelocity
• warmup = 32 -- export: (Default: 32) How long it takes your engines to warmup. Basic Space Engines, from XS to XL: 0.25,1,4,16,32
• MouseYSensitivity = 0.003 --export: (Default: 0.003) For virtual joystick only
• MouseXSensitivity = 0.003 -- export: (Default: 0.003) For virtual joystick only
• autoRollPreference = false -- export: (Default: false) [Only in atmosphere]
  When the pilot stops rolling, flight model will try to get back to horizontal (no roll)
• autoRollFactor = 2 -- export: (Default: 2) [Only in atmosphere]
  When autoRoll is engaged, this factor will increase to strength of the roll back to 0
  Valid values: Superior or equal to 0.01
• rollSpeedFactor = 1.5 -- export: (Default: 1.5) This factor will increase/decrease the player input along the roll axis
  (higher value may be unstable)
  Valid values: Superior or equal to 0.01
• turnAssist = true -- export: (Default: true) [Only in atmosphere]
  When the pilot is rolling, the flight model will try to add yaw and pitch to make the construct turn better
  The flight model will start by adding more yaw the more horizontal the construct is and more pitch the more vertical it is
• turnAssistFactor = 2 -- export: (Default: 2) [Only in atmosphere]
  This factor will increase/decrease the turnAssist effect
  (higher value may be unstable)
  Valid values: Superior or equal to 0.01
• TrajectoryAlignmentStrength = 0.002 -- export: (Default: 0.002) How strongly AP tries to align your velocity vector to the target when not in orbit, recommend 0.002
• torqueFactor = 2 -- export: (Default: 2) Force factor applied to reach rotationSpeed
  (higher value may be unstable)
  Valid values: Superior or equal to 0.01
• pitchSpeedFactor = 0.8 -- export: (Default: 0.8) For keyboard control
• yawSpeedFactor = 1 -- export: (Default: 1) For keyboard control
• brakeSpeedFactor = 3 -- export: (Default: 3) When braking, this factor will increase the brake force by brakeSpeedFactor * velocity
  Valid values: Superior or equal to 0.01
• brakeFlatFactor = 1 -- export: (Default: 1) When braking, this factor will increase the brake force by a flat brakeFlatFactor * velocity direction>
  (higher value may be unstable)
  Valid values: Superior or equal to 0.01
• DampingMultiplier = 40 -- export: (Default: 40) How strongly autopilot dampens when nearing the correct orientation
• fuelTankHandlingAtmo = 0 -- export: (Default: 0) For accurate estimates, set this to the fuel tank handling level of the person who placed the element. Ignored for slotted tanks.
• fuelTankHandlingSpace = 0 -- export: (Default: 0) For accurate estimates, set this to the fuel tank handling level of the person who placed the element. Ignored for slotted tanks.
• fuelTankHandlingRocket = 0 -- export: (Default: 0) For accurate estimates, set this to the fuel tank handling level of the person who placed the element. Ignored for slotted tanks.
• ContainerOptimization = 0 -- export: (Default: 0) For accurate estimates, set this to the Container Optimization level of the person who placed the tanks. Ignored for slotted tanks.
• FuelTankOptimization = 0 -- export: (Default: 0) For accurate unslotted fuel tank calculation, set this to the fuel tank optimization skill level of the person who placed the tank. Ignored for slotted tanks.
• ExtraLongitudeTags = "none" -- export: (Default: "none") Enter any extra longitudinal tags you use inside '' seperated by space, i.e. "forward faster major" These will be added to the engines that are control by longitude.
• ExtraLateralTags = "none" -- export: (Default: "none") Enter any extra lateral tags you use inside '' seperated by space, i.e. "left right" These will be added to the engines that are control by lateral.
• ExtraVerticalTags = "none" -- export: (Default: "none") Enter any extra longitudinal tags you use inside '' seperated by space, i.e. "up down" These will be added to the engines that are control by vertical.
• ExternalAGG = false -- export: (Default: false) Toggle On if using an external AGG system. If on will prevent this HUD from doing anything with AGG.
• UseSatNav = false -- export: (Default: false) Toggle on if using Trog SatNav script. This will provide SatNav support.
• apTickRate = 0.0166667 -- export: (Default: 0.0166667) Set the Tick Rate for your autopilot features. 0.016667 is effectively 60 fps and the default value. 0.03333333 is 30 fps.
• hudTickRate = 0.0666667 -- export: (Default: 0.0666667) Set the tick rate for your HUD. Default is 4 times slower than apTickRate
• ShouldCheckDamage = true --export: (Default: true) Whether or not damage checks are performed. Disabled for performance on very large ships
• CalculateBrakeLandingSpeed = false --export: (Default: false) Whether BrakeLanding speed at non-waypoints should be calculated or use the brakeLandingRate user setting. Only set to true for ships with low mass to lift capability.
• autoRollRollThreshold = 0 --export: (Default: 0) The minimum amount of roll before autoRoll kicks in and stabilizes (if active)
• AtmoSpeedAssist = true --export: (Default: true) Whether or not atmospheric speeds should be limited to a maximum of AtmoSpeedLimit
• ForceAlignment = false --export: (Default: false) Whether velocity vector alignment should be forced when in Altitude Hold
• minRollVelocity = 150 --export: (Default: 150) Min velocity, in m/s, over which advanced rolling can occur
• VertTakeOffEngine = false --export: (Default: false) Set this to true if you have VTOL engines on your construct. Changes Auto Takeoff to Vertical Takeoff.

Return to Table of Contents

Examples and Tutorials

Note: The videos below may become out of date.

https://www.youtube.com/watch?v=jQSkI0OcATU&feature=emb_logo - Demonstration of Use and Features

https://github.com/Dimencia/DU-Orbital-Hud/blob/master/ButtonHUD_example_1.png

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.

https://github.com/Dimencia/DU-Orbital-Hud/blob/master/ButtonHUD_example_2.png

The usual hotkeys apply, but it should be easier to use the new button system. We will be converting this to work with screens and a Remote Controller once the screen flicker bug is fixed. For now, many options are missing from the buttons since Remote Controllers must use the hotkeys

Return to Table of Contents

No Autopilot Version

No Autopilot features version available at https://github.com/Archaegeo/DU-Orbital-HUD-NO-AP

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

Archeageo and his work on the HUD

Return to Table of Contents