Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 3.17 KB

README.md

File metadata and controls

84 lines (56 loc) · 3.17 KB
By blackfirefly000
Copyright C 2024
Used with permission

Modified from [Release][Free] Helicopter & Plane HUD by xabypuce
Copyright C 2022

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
at your option any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

CREDITS:
xabypuce - Helicopter & Plane HUD - UI improvements, visuals 
blackfirefly000 - All the Boat Stuff, a little more visual stuff

From xabyuce: “Hi! Feel free to modify and release it!"

Credits to xabypuce: [Release][Free] Helicopter & Plane HUD. Go download it! It pairs really well with BoatHUD!

SUPPORT:

Contact blackfirefly000 on Discord or the FiveM Forums for suggestions, comments, support, and other concerns. Support is mainly provided on discord. If you would like to assist in the project, message me on Discord or through the FiveM forums.

INSTALLATION | REQUIREMENTS | DOWNLOAD | HOW TO USE:

  • INSTALLATION:

    • Drag "boatHUD" folder into your server resources folder
    • Add "start boatHUD" to your server.cfg
  • REQUIREMENTS:

    • NONE!
  • DOWNLOAD:

  • OPTIONAL ANCHOR SCRIPT:

    • To anchor the boat: "-" in your NUMPAD
    • This keybind is changeable in the keybinds setting of your game

V1.0.0:

  • FEATURES:

    • Engine indication including overheating warnings

    • Oil indication with oil temp, pressure, and level warnings

    • Anchor script and anchor indicator

    • Bilge indicator (bilge doesn't work, just lets you know if you're upside down or the hull is super damaged

    • Water Depth in ft or m.

    • Speed in Knots and either MPH or KPH

    • Compass Heading

    • Coordinates

PLANNED FEATURES:

  • Make bilge indication work if submerged
  • Make bilge work????

CONFIGURATION:

Notes: READ ME PLEASE. No support will be given for issues discussed here. Please use your brain!

  1. All config options ONLY support the values they say they do.

  2. Anchor script can be disabled. Turn it off if you're having another script handle boat anchoring.

  3. Units can be changed between Freedom Units ("Imperial") and something else ("Metric"). I don't know what a kilometer is so idk why you'd want that

Dedicated to the former members of the Goon City Roleplay Fire Department. You know why lmao

My Github: https://github.com/blackfirefly000 My Profile: https://forum.cfx.re/u/blackfirefly000/summary