Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 4.56 KB

README.md

File metadata and controls

101 lines (68 loc) · 4.56 KB
Raw
Common bait

brz-fishing-ci Maintainability Test Coverage

Highly customisable fishing script for FiveM servers

This script is 100% free, you can support my work by giving a star to this repository or becoming a sponsor.

Become a sponsor 💜

Supported inventory scripts

  • qb-inventory
  • qs-inventory
  • ox_inventory.

Supported notification scripts

  • ox_lib
  • qb-core

Note: Want to support other scripts? consider leaving the repository a star and open a feature request.

⚡️ Features

Unique User Interface

Designed from scratch, inspired by fishing mechanics in games like New World and Sea of Thieves.

Unique UI

Unique Fishing Mechanics

  • Realistic rod with line that moves according to the fish
  • Fish catching animation
  • Water splash effects
  • 2D ui positioning locked to fishe's world position

Unique UI

Highly customisable!

You can change pretty much any aspect of the script, from the fishing mechanics to the UI, everything is customisable.

The script is also 100% unit tested, so you can be sure that your changes won't break anything, it also makes the script easy read, understand and maintain by you or other contributors.

Integration with other frameworks

The script is designed to be framework agnostic, but it has built-in support for qb-core and Quasar Framework (qs-inventory). Integrating with other frameworks is easy, given the script's modular architecture.

Installing

Please read the installation guide for more information.

Default fishing items

Item name Description
Common bait fishingrod1 Rod object the player will be assigned with when start fishing.
Fishing rod commonbait Consumable item automatically used when the casting minigame finishes.
fishfish Common fish, can be found at any fishing spot.
dolphindolphin Uncommon fish, can be found at the deep sea.
hammersharkhammershark Uncommon fish, can be found at the deep sea.
tigersharktigershark Rare fish, can be found at the deep sea.
killerwhalekillerwhale Epic fish, can be found at the deep sea in some seasons of the year.
humpbackhumpback Legendary fish, can be found at the deep sea in some seasons of the year.
stingraystingray Rare fish, can be found at the deep sea.

👨‍💻 Contributing

  1. Clone the repository into your local server.
cd <server_root_path>/txdata/resources
git submodule add https://github.com/brazucas/fivem-brz-fishing-ts.git brz-fishing
  1. Install NodeJS and nvm.
    • Tip: You can quickly install nvm by running npm install -g nvm.
  2. Install the correct Node version, project dependencies and test if tests and build are working:
cd brz-fishing
nvm install
nvm use
yarn
yarn test
yarn build
  1. Work on your changes and test them with yarn test
  2. Make sure the build is successful with yarn build
  3. Create a pull request

Note: Contributions not covered by tests will not be accepted.