Players
How players use scuba diving with the default settings, from the clerk's menu and the dive shop to scuba gear and air, groups, a dive, opening crates, the pawn shop, the rental boat and levels.
This page follows a player through a dive with the default settings. Everything named here is set in the files under config/; see configuration.
The clerk
A clerk with a clipboard stands on the docks under a Scuba Diving blip. Players walk up and pick Talk to open the Scuba Diving menu:
| Row | What it does |
|---|---|
| Scuba Diving | Level 1/5 | The player's level and XP, with a progress bar. Pointing at it shows Next Level and Remainder. |
| Statistics | Crates collected, deepest dive and distance swum underwater, all time |
| The Leaderboards | The top 10 divers by XP, each with their level and crates. The top three get a trophy in gold, silver and brown. |
| The Dive Shop | Scuba gear, oxygen tanks and whatever else you sell |
| The Pawn Shop | Buys the player's finds for cash |
| Create Group or Manage Group | Every dive starts from a group, even a group of one |
| Rent a Boat or Return Boat | A rental boat at the dock |
| Start Diving or Stop Diving | Shown to a group's leader |
The leaderboard reads saved stats, which are written as players leave and when the resource stops, so it trails players who are online. With setup.job set, only that job sees the clerk, his blip and the shops.
Scuba gear
Buying it
The Dive Shop lists each item with its price. A player picks one, enters how many, and pays in cash, standing at the clerk. Scuba gear comes in five grades, and each grade needs that diving level to buy and to wear:
| Item | Price | Level | Air underwater |
|---|---|---|---|
Scuba Gear (ls_scuba_gear_1) | $250 | 1 | About 5 minutes |
Scuba Gear (ls_scuba_gear_2) | $500 | 2 | About 10 minutes |
Scuba Gear (ls_scuba_gear_3) | $1,000 | 3 | About 15 minutes |
Scuba Gear (ls_scuba_gear_4) | $2,000 | 4 | About 20 minutes |
Scuba Gear (ls_scuba_gear_5) | $5,000 | 5 | About 25 minutes |
Oxygen Tank (ls_oxygen_tank) | $100 | Any | Refills scuba gear |
Gear and tanks come full. A grade above the player's level is refused with "I don't think I'm experienced enough to do this".
Putting it on
Using a scuba gear item plays Changing clothes.. for 5 seconds, in or out of the water, and the inventory can't be opened meanwhile. The player changes into dive clothes, a tank and mask go on that everyone nearby sees, and they can breathe underwater with a light on. Using it again takes it all off and puts their own outfit back.
It won't go on when the player's level is below the gear's, or when it's empty ("Your oxygen tank is empty!").
Air
The air only runs down while the diver is underwater: every 10 seconds under, the gear loses its grade's share, which is where the minutes above come from. While they're under, a readout shows:
Oxygen Remaining: 86.64%
Current Depth: 124ft
Record Depth: 239ft
Crates Found: 0/4
The air left is saved to the item whenever the diver surfaces and when the gear comes off. When it runs out, the player is told "Your oxygen tank is empty!" and the gear comes off on its own, leaving only their own breath to reach the surface. The gear also comes off if the item leaves their inventory.
Refilling
An oxygen tank tops up scuba gear, up to full:
- ox_inventory: drag the Oxygen Tank onto the Scuba Gear. As much air moves across as fits.
- Other inventories: use the Oxygen Tank. A slider asks how much to move, up to what fits, into the first scuba gear in the inventory that the player's level allows.
The tank loses what it gives. On other inventories, an empty tank or full gear is refused with a message.
Groups
Every dive belongs to a group. Create Group makes the player its leader; on their own, they dive as a group of one. Manage Group then has:
- Add Member, for the leader: enter a player's server ID. Both are told, and the new member joins the group's next dive.
- Every other member by character name (or
Player 12withsetup.hideNames). The leader clicks one to remove them. - Leave Group. When the leader leaves, the group is disbanded, every member is told "Your group was disbanded" and their hotspot is cleared.
A player is in one group at a time, and can't be added while they lead or belong to another. You can cap a group's size and require both players to be at the clerk to add someone; see start.
A dive
The leader picks Start Diving. Every member gets a message from the Diving Expert: "Hey! It's me. Give me some time to try and locate some info on hotspots you might find some crates. When I get something - I'll let you know!"
15 to 30 seconds later the second message arrives, "Hey! I got some info on a hotspot! Head over to the area marked on your GPS and see if you can find anything. Good luck!", and a red circle 150 meters in radius appears on every member's map. It's one of ten zones off the coast, never the one the server handed out last.
Between 2 and 6 crates lie on the seabed inside the circle. They appear as a diver enters it, and any within 30 meters is outlined in green.
Pickup shows on a crate only while the player is swimming underwater in scuba gear. They hold still for 3 seconds (Picking up..), and the crate goes into their inventory along with 1 to 5 XP. It vanishes for the rest of the group. A player whose inventory is full is told "You cannot carry this much" and the crate stays.
When the last crate is up, the circle clears for everyone and the leader is asked Continue Diving?: Continue starts the next dive straight away, with new messages and a new hotspot, and Stop ends it.
The leader can also pick Stop Diving in the menu at any time.
The messages arrive as mail on most phones. With lb-phone the player needs an email address set up in Mail; with npwd they come as a text. Without a supported phone, each shows as a dialog titled Scuba Diving.
Opening crates
A crate is an item, opened anywhere: on the boat, on the dock, at home. Using it plays Opening crate.. for 2 seconds with a box in hand, and the player can walk meanwhile. Then every item in the loot table for the player's level and every level below it rolls on its own chance, so one crate usually gives several things:
| Level | Items and chance (one of each) |
|---|---|
| 1 | Old Boot 100%, Wood Plank 80%, Rusted Padlock 60%, Rusted Key 40%, Rusted Gear 30%, Seashell 30%, Seaweed 25%, Rusted Muffler 25%, Broken CD 20%, Diving Goggles 20%, Fishing Net 15%, Old Camera 15%, Military Helmet 10%, Old Compass 10%, Old Watch 5%, Conch Shell 5% |
| 2 | Bottle of Rum 50% |
| 3 | Treasure Map 50% |
| 4 | Silver Bracelet 50% |
| 5 | Ancient Artifact 50% |
So a level 3 diver rolls for everything in levels 1, 2 and 3. Cancelling the bar keeps the crate. Once it opens, anything that doesn't fit in the inventory is lost, with "You cannot carry this much".
The pawn shop
The Pawn Shop buys the level 1 finds for cash, as many at a time as the player has:
| Item | Price |
|---|---|
| Old Boot, Wood Plank, Rusted Padlock, Rusted Key, Rusted Gear | $5 |
| Seashell, Seaweed, Rusted Muffler, Broken CD, Diving Goggles | $15 |
| Fishing Net, Old Camera, Military Helmet | $25 |
| Old Compass, Old Watch, Conch Shell | $50 |
The level 2 to 5 finds aren't on the list by default: sell them through your other scripts, or add them to shop.pawn.items.
The rental boat
Rent a Boat takes a $500 deposit in cash and puts a dinghy in the water beside the clerk's dock, with a full tank and its keys from your fuel and keys scripts. A player has one rental at a time. On the boat, Toggle anchor drops or lifts the anchor in a second. Return Boat, back at the clerk, takes the boat away and pays $250 back.
Levels and stats
XP comes from crates: 1 to 5 for each one a player picks up. The levels:
| Level | Total XP |
|---|---|
| 1 | 0 |
| 2 | 2,500 |
| 3 | 10,000 |
| 4 | 20,000 |
| 5 | 50,000 |
Each level unlocks that grade of scuba gear and that tier of loot. Players can't lose a level. Statistics keeps three totals: Crates picked up, Depth (the deepest the player has been in scuba gear) and Swam (distance swum underwater in scuba gear), in feet unless you switch to meters.
At 1 to 5 XP a crate, the default levels take a long time: around 800 crates for level 2. To level faster, lower the thresholds in experience or raise each zone's xp.
Still stuck? Ask in our Discord: the people who write the scripts answer.
Last updated
scuba diving
Requirements, install steps, items and first start for scuba diving, a FiveM activity where players gear up, follow a hotspot out to sea and bring crates up from the seabed.
Configuration
Every scuba diving option in the four files under config/, with its key, default value and what it changes, plus the text prompt setting and languages.