Skip to main content
This guide walks through a complete atlasFishing install. Follow the steps in order, especially if you are new to FiveM resources.

​
Requirements

  • atlasBridge
  • A supported framework/inventory through atlasBridge, or bridge default mode
  • The included atlasFishing/web/dist folder
  • Inventory items and item icons installed in your inventory
atlasFishing depends on atlasBridge. If atlasBridge starts after atlasFishing, the fishing resource will not initialize correctly.

​
Folder placement

Recommended layout: 
resources/
  [ATLAS]/
    atlasBridge/
    atlasFishing/
The resource names must be exact: 
atlasBridge
atlasFishing
Both resources include name checks. If a customer renames the folders, the console tells them what happened and the resource blocks startup.

​
server.cfg

Minimal setup: 
ensure atlasBridge
ensure atlasFishing
Typical setup with common dependencies: 
ensure oxmysql
ensure ox_lib
ensure ox_inventory
ensure qbx_core

ensure atlasBridge
ensure atlasFishing
If you use qb-core, es_extended, qb-target, or ox_target, start those before atlasBridge as well.

​
Inventory items

atlasFishing uses real inventory items for the rod, bait, and catches. The resource includes item definitions for common inventories.
  1. Open atlasFishing/items/ox_inventory.lua.
  2. Copy the full item block.
  3. Paste it inside the item table in ox_inventory/data/items.lua.
  4. Restart ox_inventory and the Atlas resources.

​
Item icons

The resource includes both PNG and WebP icon folders: 
atlasFishing/items/icons/png
atlasFishing/items/icons/webp
Use the format your inventory supports. Many inventories still expect PNG filenames, so PNG is the safest choice unless you know your UI supports WebP.

​
UI files

Confirm this file exists: 
atlasFishing/web/dist/index.html
If web/dist is missing, the supplies shop, boat rental shop, and minigames cannot open.

​
Streamed props

atlasFishing includes streamed rod/fish/critter props and registers: 
data_file 'DLC_ITYP_REQUEST' 'stream/fishing_props.ytyp'
Do not remove the stream folder unless you are replacing the props and updating the config.

​
Editable files

atlasFishing is distributed with asset escrow. Most logic is protected, but these files stay open so you can configure the resource and add hooks:
FilePurpose
config.luaAll settings — locations, prices, items, minigames, selling, boat rental
editable/client.luaClient hooks (Fishing.Hooks) — e.g. hide your HUD on minigame open
editable/server.luaServer hooks (Fishing.Hooks) — e.g. log every catch and sale
items/*.luaInventory item definitions to paste into your inventory
The client/server gameplay logic is encrypted and does not need editing for a normal install.

​
Hooks

editable/server.lua and editable/client.lua expose Fishing.Hooks callbacks that fire at key moments. Leave a body empty to do nothing. Useful for logging, custom rewards, or HUD toggles: 
-- editable/server.lua
Fishing.Hooks = {
    OnFishCaught = function(src, fish) end, -- fish = { key, label, tier, price, ... }
    OnSell = function(src, count, value) end,
}

-- editable/client.lua
Fishing.Hooks = {
    OnMinigameOpen = function(id) end,   -- id = 'tension' | 'whirlpool' | 'castmeter' | 'rhythm'
    OnMinigameClose = function(id, result) end, -- result = 'success' | 'fail' | 'timeout' | 'cancel'
    OnCastStart = function() end,
    OnCatch = function(data) end,         -- data = { label, item, tier, prop, junk }
    OnCancel = function(reason) end,
}

​
First in-game test

1

Start the server

Watch the console for atlasBridge and atlasFishing messages.
2

Visit the fisherman

The default fisherman ped is configured at Config.ped.coords.
3

Open Supplies

Buy a fishing rod and bait.
4

Cast near water

Use the rod while facing water. If water validation is enabled, casting away from water is rejected.
5

Complete the minigame

The minigame opens in NUI and returns success or failure to the fishing flow.
6

Sell fish

Return to the fisherman and sell catches.

​
Production checklist

  • Resource names are unchanged.
  • atlasBridge starts before atlasFishing.
  • Inventory items exist.
  • Item icons are in the correct inventory image folder.
  • web/dist/index.html exists.
  • Fisherman and boat rental locations are moved from placeholder coordinates.
  • Prices and fish rewards are balanced for your economy.
  • Minigames are tested by a normal player, not only an admin.