https://github.com/brycecanyoncounty/bcc-water

https://github.com/brycecanyoncounty/bcc-water

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/brycecanyoncounty/bcc-water
• Owner: BryceCanyonCounty
• License: gpl-3.0
• Created: 2023-02-22T21:46:16.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-07T05:19:07.000Z (5 months ago)
• Last Synced: 2024-09-08T05:40:57.126Z (5 months ago)
• Language: Lua
• Size: 177 KB
• Stars: 5
• Watchers: 2
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bcc-water

#### Description

Add the canteen and bucket items to a store or crafting station for players to buy or make. Fill your canteen and buckets at waterpumps while in town or **crouch and hold still** in wild waters to show drink, wash and fill prompts. See features for more details.

#### Features

- Carry a canteen of water to drink

- Drink 4 times from a full canteen

- Quenches thirst when using supported metabolism scripts

- Refill canteen and buckets at waterpumps, sinks, rivers and lakes

- Drink directly from rivers and lakes to save the water in your canteen

- Separate health, stamina and thirst config values for drinking from canteen and wild waters

- Players can wash in rivers and lakes

- Players can take damage from drinking wild water

#### Dependencies

- [vorp_core](https://github.com/VORPCORE/vorp-core-lua)

- [vorp_inventory](https://github.com/VORPCORE/vorp_inventory-lua)

- [bcc-utils](https://github.com/BryceCanyonCounty/bcc-utils)

#### Supported Metablolism Scripts

- VORP Metabolism

- Fred Metabolism

- Outsider Needs Metabolism

- RSD Metabolism

- NXT Metabolism

- Andrade Metabolism

- FX-HUD

#### Installation

- Add `bcc-water` folder to your resources folder

- Add `ensure bcc-water` to your `resources.cfg`

- Ensure this script *after* your metabolism script

- Run the included database file `water.sql`

- Add images from `img` folder to: `...\vorp_inventory\html\img\items`

- Add items to a store or crafting station for player use

- Set your metabolism script in the `config/main.lua` file

- Restart server

#### Credits

- green_canteen

#### GitHub

- https://github.com/BryceCanyonCounty/bcc-water