chore(readme): re-wrote
Added description, image qbox logo, and more useful info
This commit is contained in:
@@ -1,2 +1,44 @@
|
|||||||
|

|
||||||
|
|
||||||
# qbx_divegear
|
# qbx_divegear
|
||||||
Items to help players breathe & move underwater
|
|
||||||
|
A Qbox resource that enables the functionality of diving and air tank items.
|
||||||
|
|
||||||
|
Works with [qbx_diving](https://github.com/Qbox-project/qbx_diving/), a coral diving and collection resource, also developed by the Qbox community!
|
||||||
|
|
||||||
|
# Features
|
||||||
|
|
||||||
|
- Able to set the length of time an air tank will refill your tank
|
||||||
|
- Limitations for refilling underwater (to limit endless use of air tanks)
|
||||||
|
- animations and timers during refill
|
||||||
|
- Text that displays current air time at the bottom of the player's screen when underwater and wearing gear
|
||||||
|
|
||||||
|
# ox_inventory items
|
||||||
|
|
||||||
|
Place these items in ox_inventory's item.lua if you don't have them already:
|
||||||
|
|
||||||
|
```
|
||||||
|
['diving_fill'] = {
|
||||||
|
label = 'Diving Tube',
|
||||||
|
weight = 3000,
|
||||||
|
stack = false,
|
||||||
|
close = true,
|
||||||
|
description = "used to refill your diving gear's oxygen supply."
|
||||||
|
},
|
||||||
|
|
||||||
|
['diving_gear'] = {
|
||||||
|
label = 'Diving Gear',
|
||||||
|
weight = 30000,
|
||||||
|
stack = false,
|
||||||
|
close = true,
|
||||||
|
description = "A diving set that let's swim underwater. Blub blub!"
|
||||||
|
},
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
# ox_inventory images
|
||||||
|
|
||||||
|
Missing images for your items? Here are some free-to-use images!
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|
|||||||
Reference in New Issue
Block a user