> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atlasscripts.net/llms.txt
> Use this file to discover all available pages before exploring further.
# atlasFishing Overview
> A complete FiveM fishing activity built on atlasBridge — supplies shop, bait progression, four NUI minigames, six rarity tiers, selling, and optional boat rentals.
`atlasFishing` is a complete fishing activity for FiveM, built on [`atlasBridge`](/atlas-bridge/overview). One fisherman ped sells supplies and buys your catch; players cast near water, play a quick minigame, and reel in fish across six rarity tiers. Progression is bait-driven — better bait, better odds.
Because it runs on the bridge, it works on **ESX, QBox, QB-Core, or standalone** with **ox / qb / qs** inventories — no per-framework glue. The bridge handles framework, inventory, UI, target/interaction, money, and entity cleanup, so the fishing logic stays the same on every stack.
Place the resource, set the start order, register the inventory items, and run a smoke test. Includes a fast-path speed run.
The authoritative guide to every `config.lua` block — ped, cast, tiers, baits, fish, zones, minigames, selling, shop, boat rental.
The item keys the script expects and how to register them per inventory.
How Tension, Whirlpool, Cast Meter, and Reel Rhythm work and how to tune them.
## The player loop
Walk up to the fisherman ped and interact (default key **E**) to open **Supplies** or **Sell**.
Purchase a `fishing_rod` and at least one bait from the supplies shop. Bait sets your catch odds.
Use the rod near water (or from a boat). A cast progress bar runs, then a random idle wait before the bite.
One of four NUI minigames opens. Land it to hook the catch.
The server rolls a catch weighted by tier, bait, and zone. The fish spawns, flops on the ground, and the player picks it up and holds it.
Return to the fisherman and sell. Payouts go to the configured money account.
## Feature map
Each feature maps to one config block. Use this to jump straight to what you want to tune.
| Feature | Configure in |
| --------------------------------------------- | -------------------------------------------- |
| Fisherman ped, blip, interaction method | `Config.ped` |
| Rod item, prop, and idle animation | `Config.rod` |
| Cast timing, water requirement, boats | `Config.cast` |
| Rarity tiers (base weights) | `Config.tiers` |
| Bait ladder — price, fail %, tier multipliers | `Config.baits` |
| Fish & junk — tier, price, prop, weighting | `Config.fish`, `Config.junk` |
| Hotspot zones (rarity multipliers) | `Config.zones` |
| Catch spawn, pickup, hold, and flop | `Config.catchSeq` |
| The four NUI minigames + SFX | `Config.minigame` |
| Cancel fishing on death | `Config.death` |
| Selling mode and payout account | `Config.sell` |
| Supplies shop catalog | `Config.shop` |
| Optional boat rental | `Config.boatrental` |
| Player-facing messages | `Config.notify` |
| Logging / custom rewards (hooks) | `editable/client.lua`, `editable/server.lua` |
## Dependencies
`atlasFishing` declares `dependency 'atlasBridge'` and will not initialize without it.
* [`atlasBridge`](/atlas-bridge/overview) — hard dependency, started **before** this resource.
* A supported framework + inventory detected by the bridge, or standalone mode.
* OneSync.
* The committed `web/dist` NUI build (ships with the resource).
* Inventory items registered in your inventory (rod, baits, fish).
The resource folder must stay named **`atlasFishing`**. `shared/guard.lua` checks the name on startup; if it is renamed, the script prints a console warning and disables itself until the folder name is restored.
## Next steps
Get the resource running, items registered, and a working catch.
Tune tiers, bait, prices, and payouts for your server.