***************************
 LeFix' Speedometer v1.1.3
***************************

Overview:
1. Description
2. Installation
3. Known Bugs
4. Changelog
5. Links

****************
 1. Description
****************

This mod provides various analogue speedos for boat/bicycle/car/motorcycle/planes/helicopters/trains.
Addditionally a RPM gauge, gear and damage indicator for cars and motorcycles.
Furthermore a vertical speed gauge for planes and helicopters.

Changes in the mod menu have an instant effect on the hud.
(Provided that you're in the same vehicle type as the hud you're changing)

Open it with F10 (Default)
and navigate with:
-arrow keys, enter + esc
-numpad 2468,  5   +  0 
-Gamepad DPad, A   +  B

All settings can changed in the .ini manually too.
But the menu provides a save and load function.
(Save function possibly doesn't work because of missing admin rights or when the game folder is declared as read-only,
then you should adjust the mod using the menu and copy the values manually to the .ini, so it loads the settings on game restart)

One last thing: !!!
For a correct RPM and gear gauge it's important to check the setting under GENERAL -> GAMEVERSION
(You will see the difference)


*****************
 2. Installation
*****************

1. Install ScriptHookV, this normally needs an update when GTA V gets an update too. 

2. Extract the .rar/.zip into your GTA V main folder

   It should contain now:
    -"LeFixSpeedo.asi"
    -"LeFixSpeedo" folder

3. Edit the settings to your preferences!
    -Manually by editing the settings.ini loacted in the folder (Deprecated)
    -With the mod menu ingame. (Recommended. Open with F10 (Default))

One last thing once again: !!!
For a correct RPM and gear gauge it's important to check the setting under GENERAL -> GAMEVERSION
(You will see the difference)

-----------------

Note:
You can edit/replace any image.
(The filenames and the size(pixel) have to be unchanged to work properly.)

The needle rotation correlates with the values defined in the ini @[CONSTANTS] and are defined for each speedo background.

In the picture folder is an example for a carbon fiber background.
Share your own design with other users or with me using email gaming@die-optimisten.net so I can include it to the picture folder.


***************
 3. Known Bugs
***************
-The actual gear isn't read in the gamefiles and is an estimation using the rpm
    ->the gear isn't 100% accurate.

-Sometimes the primary vehicle color in game looks slightly different than the color returned by the native method
    ->using the "primary vehicle color as needle color" feature, both colors won't match sometimes.

-The native I use in my code for checking the presence of the mobile phone doesn't work properly in planes?!
    ->the hud won't dissapear while using the mobilephone in planes and helicopters.

**************
 4. Changelog
**************

v1.1.3
(unfinished 1.2)
-reworked the menu (reduced lines of code and improved GUI)
-slow cars (trucks/offroad etc. will use low speedo background)
-using rpm leds won't disable the gear indicator anymore
-optional fadeout as passenger
-characterwheel fadeout
-renamed INI file and moved to LeFixSpeedo folder (!)

v1.1.2b
-bugfix: no velocity needle in planes when vertical speed is shown
-bugfix: doesn't save extra gauge position correctly

v1.1.2a
-gameversion setting more understandable (text changed)

v1.1.2
-Added optional RPM LEDs (F1 like)
-Added hint if gameversion is set wrong
-Correct fade out while using the internet
-Improved code for needle color (primary vehicle color)

v1.1.1
-added train support (J10/Pearson's mod recommended: https://www.gta5-mods.com/scripts/railroad-engineer)

v1.1
-added mod menu (with gamepad support)
-reorganized picture folder
-added vertical speed gauge for planes/helicopters

v1.0.8a
-Revised the readme.

v1.0.8
-bigger range of valid values for hud offset and hud size supporting ultrawidescreen and very high resolution

v1.0.7
-added a speedfactor, default is 1.0 like before
 e.g. Increase it in planes so the speedo shows more realistic values for planes
 e.g. Decrease it in cars in order to show the speed it actually looks like

v1.0.6a
-fixed static needle in boats in case of 'isOriginal' set to true/1

v1.0.6
-added plane specific speedo (up to the maximum speed of the gameengine)
-now boat actually uses slower background if game is not modified
-removed optional anchor, completely independ mod now

v1.0.5
-added options to set the intensity and freqency of the damage indicator
-damage indicator is now optional
-only reloads settings.ini when pressing F10 twice (outdated)
-changed images need game restart (outdated)

v1.0.4
-added option to use vehicles primary color for the needle
-Removed small gear bug. No longer jumps between two gears. (Gamepad users)

v1.0.3
-much more accurate shifts for gamepad users (50% throttle etc.)
-small loss of accuracy on keyboard :/

v1.0.2
-added boat anchor

v1.0.1
-changed some graphics
-added the toggle key setting again
-display N while using handbrake
-donwshifting is way more accurate
-changed the damage indicator slightly

v1.0
-rewritten the majority of code
-added gear indicator

v0.9.1
-added slightly lower speedo for slower cars

v0.9
-added damage indicator
-added optional FPV fadeout

v0.8.1
-improved rpm gauge
-added boat speedo (horizontal speed)
-added options to enable/disable speedo in different types of vehicle

v0.8
-added bicycle speedo
-Better opacity during day/night cycle

v0.7.2
-more realistic rpm values
-added color setting for needles

v0.7.1
-added gameversion setting to fix RPM

v0.7
-HUD is correct on every screenratio and sreenresolution
-RPM works

v0.6.1
-HUD is now resizable
-Chooseable key to toggle the mod

v0.6
-added adjustable background
-few code optimizations

v0.5
-new/better graphcis
-added rpm gauge
-added placement settings
-added keyboardlistener, F9 to activate/refresh and F10 deactivate the mod


v0.4
-basic ini settings implemented
-easier installation

v0.3
-added MPH Version

v0.2
-fixed FPS loss


**********
 5. Links
**********

Check for updates on
https://de.gta5-mods.com/scripts/speedometer-improvedalexbladeversion

Questions or suggestions?
->Contact me with an email:
gaming@die-optimisten.net


Thanks for reading.

LeFix