Speedometer

{:links-list}

INSTALLATION

  1. Open the downloaded ZIP product file and drop the folder in it somewhere in your resources folder.
  2. Add your product key (get it here) to the settings.ini file
  3. Add start BigDaddy-Speedometer to your server.cfg.

DO NOT RENAME THE FOLDER.

If you change the name of the folder it will not function correctly so leave the name as it is.

{:is-danger}

CONFIGURATION

SETTING DEFAULT DESCRIPTION
[licensing]
key1 none Product key
[vehicle]
speedUnit MPH Can be set to MPH or KM/H
showSeatbelt true Whether to show the seatbelt icon
hazardsDelay 2000 How long you have to hold the hazards key before they engage
useSeatbelt true Whether to use seatbelt functionality or not
exemptEmergency false Exempt emergency vehicles from seatbelt functions
singleTapToExit true If seatbelt is buckled, single tapping F exits the vehicle without unbuckling. If set to false, you can double tap F to exit without unbuckling
seatbeltTattle false Tell nearby police if drivers are unbuckled
tattleDistance 100 How far away police can be for tattling
tattleMinSpeed 10 Minimum speed vehicle must be driving to be tattled on
tattleChance .1 Chance of the tattle happening (0 = no chance 1 = 100% chance you can set to anything between the two)
useNoReverseBraking true Enable no reverse braking behavior
AcceleratorIsBrakeInReverse true Use accelerator as brake while reversing
airbags true You can disable airbag functionality by setting this to false
airbagBlacklist caddy,caddy2 Comma separated list (no spaces) of spawn codes/models you do not want to have airbags
minimalSpeedOffsetLeft 14 Percentage of the screen from the left that the minimal speed display sits
minimalSpeedOffsetBottom 10 Percentage of the screen from the bottom that the minimal speed display sits
passengerSeatbeltOffsetLeft 15 Percentage of the screen from the left that the passenger seatbelt icon sits
passengerSeatbeltOffsetBottom 21 Percentage of the screen from the bottom that the passenger seatbelt icon sits
graphicalOffsetLeft 50 Percentage of the screen from the left the graphical speedometer sits
graphicalOffsetBottom 3 Percentage of the screen from the bottom the graphical speedometer sits
graphicalTranslate true If true, it will translate the graphical speedometer back to the left by half its width. Used if you put 50 in the graphicalOffsetLeft setting to center it
ONEgraphicalOffsetLeft 50 Percentage of the screen from the left the ONE theme speedometer sits
ONEgraphicalOffsetBottom -6 Percentage of the screen from the bottom the ONE theme speedometer sits
ONEgraphicalTranslate true If true, it will translate the ONE theme speedometer by half its width for centering
scale .8 UI scale multiplier between 0 and 1
loseHealthOnEjection true if set to true, player will lose health just by being ejected without a seatbelt
[settings]
HideRadarOnFoot false If true, the minimap is hidden when not in a vehicle
ForceElectric iak_wheelchair,teslapd Comma separated list of model names that you want to be electric but aren't
ForceGas Comma separated list of model names that you want to be Gasoline but aren't
showPrompts false Whether to show prompt text
DesyncKey 987617020000 Do not change this or the script will stop working
[keys] See the validkeys.txt file that came with this script for valid key names
seatbeltSecondary LEFT CTRL Seatbelt is a two key function, this is the first key
seatbelt Z Key to engage/disengage seatbelt, this is the second key
airbagSecondaryKey LEFT ALT Two key function, this is the first key
airbagKey X Key to reset airbags, this is the second key
cruiser HOME Set a speed limiter, this is NOT a cruise control it only temporarily sets the max speed. You will still be required to press the forward key

HOW TO PLAY

When you get in a car or plane, helicopter, motorcycle, etc. the speedometer will show on screen. If in a vehicle that has seatbelts, you will hear the seatbelt warning for a few seconds. Pressing CTRL+Z (configurable) will buckle and unbuckle your seatbelt. If you are not buckled there is a chance you will be thrown from the vehicle during a collision. Passengers as well (this is configurable and can be disabled). You can configure to exempt emergency vehicles from seatbelt functionality.

The fuel gauge works with LegacyFuel (or any other fuel script that uses the standard fuel functions within the game). The engine gauge shows engine health and works with RealisticVehicleDamage or other vehicle damage/health scripts as long as they follow the standard health scale.

DEFAULT KEYBINDS

All keybinds can be rebound in the settings.ini

Key INFO
- (MINUS) Left Blinker
= (EQUALS) Right Blinker
BKSP (BACKSPACE) Hazards (HOLD to toggle)
H Headlights on/off/bright
CTRL+Z Seatbelt Toggle

COMMANDS

COMMAND INFO
/speedomenu opens the speedometer menu (Requires ox_lib) where you can do all the functions below without the commands
/toggle-speedometer Toggle the speedometer on/off
/toggle-speedometervis Toggle graphical hud vs. the minimal one which is text only
/speedoedit go into edit mode where you can move the speedometer around on the screen and save the position
/theme change graphical themes

EXPORTS

There is an export built in to toggle the UI on and off exports["BigDaddy-Speedometer"]:ToggleUI(bool) [true/false]

KNOWN ISSUES

LUXART:

The blinker/hazzards functions conflict with LUXART Vehicle Control. If you want to use this speedometer, I suggest disabling the functions in LUXART so they don't run into each other. If you leave LUXART on and disable them in this speedometer, the blinkers on this speedometer hud will not flash when active.