.NET Arduino Heads-Up Display

ArduinoHUD turns your Arduino and LCD setup into an informational display that provides some data about your current gameplay.

Big thanks to ZyDevs for the inspiration and base sketch.

Features

v3.0

• Updated to use Script Hook V .NET v2.5.1. This is required, the script won't work without it.
• Fixed "BUSTED" display
• Refactored the way screens are cycled through, allowing for world/player information to display even while driving
• Added forced screen cycling via push button
  • For help connecting your push button, use this tutorial: https://www.arduino.cc/en/tutorial/pushbutton
  • Update the ArduinoHUD.ino sketch with your corresponding push button digital pin
  • Update the ArduinoHUD.ini preferences file to set ToggleFormat to "ARDUINO" to disable the timed cycling

v2.0

• Added wanted level display via five LEDs
  • For help connecting your LEDs, use this tutorial: https://www.arduino.cc/en/Tutorial/Blink
  • Update the ArduinoHUD.ino sketch with your corresponding LED digial pins (LED1_PIN should be the right-most LED)

v1.0

• While walking
  • Displays current time, weather and neighborhood
  • Displays player health and armor percentage
• While driving
  • Displays current vehicle name and speed (in format configured via ArduinoHUD.ini)
  • Displays current vehicle body and engine health
• Displays when player is dead

Installation

1. Connect your LCD to your Arduino and test out its functions before installing the GTA script. If the "Hello World" tutorial is failing, then the script won't work. For installation help, visit: https://www.arduino.cc/en/Tutorial/HelloWorld.
2. Open the ArduinoHUD.ino sketch in the Arduino app and make any necessary customizations
   • If your pins differ from the defaults, be sure to edit the LiquidCrystal instantiator
   • Update LCD_NUM_COLUMNS and LCD_NUM_ROWS to match your device
   • If using LEDs, update the LED digital pins (LED1_PIN should be the right-most LED)
   • If using a push button, update the push button digital pin
3. Upload the sketch to your Arduino
4. Install Community Script Hook V .NET v2.5.1
5. Place ArduinoHUD.dll and ArduinoHUD.ini into your GTAVRoot/scripts folder (if the folder doesn't exist, create it)
6. Open Arduino.ini in Notepad and edit your settings and preferences
   • COMPort should match your Arduino's port name (you can find this in the Arduino app under Tools > Port)
   • Edit HourFormat and SpeedFormat to your liking. Examples are given in the .ini file.
   • Set ToggleFormat to "ARDUINO" only if you have set up a push button

Known Issues

• Minimum LCD column count is 12, and some screens may have weather text slightly cut off

License

The source code is available on GitHub, feel free to use it in any way you want: https://github.com/5mods/ArduinoHUD