> For the complete documentation index, see [llms.txt](https://docs.sleepycode.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sleepycode.eu/scripts/fishing.md).

# Fishing

## Fishing

Fishing is a premium FiveM fishing script with a React NUI menu.

It includes a reel-in minigame, weight-based pricing, a species collection, conditions, rankings, and boat rental.

{% hint style="success" %}
Works with **ESX, QBCore, Qbox, ox\_core, vRP, and standalone**.

No SQL database is required. The script stores data in a local JSON file.
{% endhint %}

### At a glance

| Feature              | Includes                                                      |
| -------------------- | ------------------------------------------------------------- |
| **36 species**       | Weight-based pricing, personal records, and rarity tiers      |
| **5 rod tiers**      | Durability, three upgrade levels, and tier-specific minigames |
| **Collection album** | Every species and one completion reward                       |
| **Conditions**       | Weather and time change bite rates and species pools          |
| **Ranking**          | Cyclic leaderboard and biggest-catch board                    |
| **Logs**             | Discord, ox\_lib logger, console, and anti-cheat rejections   |

### Documentation

Use these pages to install, configure, and manage the resource.

* [Installation](/scripts/fishing/installation.md)
* [Configuration](/scripts/fishing/configuration.md)
* [Locations and Fish](/scripts/fishing/locations-and-fish.md)
* [Features](/scripts/fishing/features.md)
* [Integrations and Data](/scripts/fishing/integrations-and-data.md)
* [Commands and Troubleshooting](/scripts/fishing/commands-and-troubleshooting.md)

### Requirements

| Resource        | Required    | Purpose                                    |
| --------------- | ----------- | ------------------------------------------ |
| `PolyZone`      | Yes         | Default fishing-zone provider              |
| `ox_lib`        | Optional    | Alternative zone provider and `ox` logging |
| `ox_inventory`  | Recommended | Item images and metadata                   |
| Weather sync    | Optional    | Enables `Config.Conditions`                |
| Target resource | Optional    | Supports ox\_target and qb-target          |

The framework bridge detects the active framework automatically.

### Quick start

1. Place the resource in `resources/[esx_addons]/sc_fishing`.
2. Start PolyZone or configure ox\_lib as the zone provider.
3. Add `ensure sc_fishing` after your framework and inventory.
4. Check the console for missing inventory items.
5. Add item entries and matching `.png` icons.

The first startup creates `database/database.json`.

### Editable files

The Cfx asset escrow release keeps configuration and integrations editable.

| Path                     | Purpose                                |
| ------------------------ | -------------------------------------- |
| `shared/config.lua`      | Client-safe gameplay configuration     |
| `shared/sv_config.lua`   | Server-only settings and security      |
| `locales/*.json`         | UI and notification translations       |
| `bridge/**/*.lua`        | Framework and third-party integrations |
| `fxmanifest.lua`         | Dependency imports and load order      |
| `database/database.json` | Runtime data created automatically     |

{% hint style="info" %}
The open bridge layer supports custom money, inventory, notification, target, and vehicle key systems.
{% endhint %}