Settings

Every setting in config.lua, taken from the file itself. The comments in the file and this page always say the same thing.

`Config.Framework`

Your framework: "esx", "qb-core", "qbox", "ox" or "custom". With "custom" the resource loads public/framework.lua instead.

Setting	Default	What it does
`name`	`"esx"`
`esxMode`	`"legacy"`	Only when name is "esx": "legacy" uses the export, "old" waits for the shared object event that older forks still use.
`esxSharedObjectEvent`	`"esx:getSharedObject"`
`moneyAccount`	`"cash"`	Where the fish market pays into: "cash" or "bank".

`Config.UI`

Notifications: "ox_lib" or "custom" (loads public/ui.lua).

Setting	Default	What it does
`name`	`"ox_lib"`

`Config.Language`

Any file in languages/, without the extension.

Config.Language = "english"

`Config.Debug`

Prints what the resource is doing to the console.

Config.Debug = false

`Config.Fishing`

Setting	Default	What it does
`afkFishing`	`true`	Keep casting until the player stops. Off means one cast per menu.
`baseCastTime`	`8000`	The low end of how long a cast lies in the water, in milliseconds, before the rod divides it.
`maxCastTime`	`15000`	The high end. Every cast rolls a time between the two, and the rod divides that as well.
`pauseBetweenCatches`	`2000`	Breather between two casts.
`baseSuccessChance`	`60`	Hit rate in percent, before the rod multiplier is applied.
`maxSuccessChance`	`95`	The ceiling after it. No rod reaches past this.
`experience`	`a table`

`Config.Rods`

One entry per rod, keyed by its item name.

Key	What it does
`color`	the color that marks the rod in the menu
`successMultiplier`	multiplies the hit rate, capped by maxSuccessChance
`timeMultiplier`	higher is faster, the cast time is divided by it
`rewardMultiplier`	multiplies the amount caught
`luckModifier`	shifts the odds toward the rarer entries in the pool

Setting	Default	What it does
`wood_rod`	`a table`
`metal_rod`	`a table`
`gold_rod`	`a table`

`Config.ItemImage`

Where item pictures come from. %s is the item name.

Ships with its own, so nothing has to be set up. Point it at your inventory to reuse the art you already have:

ox_inventory   nui://ox_inventory/web/images/%s.png
qb-inventory   nui://qb-inventory/html/images/%s.png

Config.ItemImage = "nui://ktx_fishing/dist/web/images/%s.svg"

`Config.Items`

Everything that can be caught. A spot below only says which of these it holds and how likely they are.

An item without a price is not bought at the market.

Setting	Default	What it does
`tin_can`	`{ label = "Tin Can", price = 3 }`	Junk. Every spot has one, so a cast can also be a laugh.
`glass_bottle`	`{ label = "Glass Bottle", price = 4 }`
`old_boot`	`{ label = "Old Boot", price = 6 }`
`mackerel`	`{ label = "Mackerel", price = 26 }`	The everyday catch that carries the economy.
`carp`	`{ label = "Carp", price = 28 }`
`trout`	`{ label = "Trout", price = 32 }`
`salmon`	`{ label = "Salmon", price = 45 }`	Worth going out for.
`tuna`	`{ label = "Tuna", price = 75 }`
`octopus`	`{ label = "Octopus", price = 90 }`
`king_crab`	`{ label = "King Crab", price = 190 }`	One per spot, and only there. The reason to travel.
`shark`	`{ label = "Shark", price = 260 }`
`golden_fish`	`{ label = "Golden Fish", price = 280 }`
`dolphin`	`{ label = "Dolphin", price = 320 }`
`pearl`	`{ label = "Pearl", price = 220 }`	Rare enough to talk about.
`treasure_chest`	`{ label = "Treasure Chest", price = 480 }`

The spots that ship with the resource. Their areas are built in and fixed. Switch one off with enabled = false, or rename it with name. chance values are weights and the draw runs over their sum, so a spot that misses 100 keeps its ratios. Every such spot is named in a warning when the resource starts, on the server and on every client.

Setting	Default	What it does
`delPerroPier`	`a table`
`alamoSea`	`a table`
`chumashCoast`	`a table`
`paletoBayPier`	`a table`

`Config.CustomSpots`

Your own spots. Same shape, but you give them a place.

`Config.Seller`

The fish market. A ped stands in the world and pays for the catch.

Both bonuses only ever add on top of your price:

paid = price * amount * (1 + experience% + luck%)

Setting	Default	What it does
`enabled`	`true`
`ped`	`a table`
`locations`	`a table`	One market per fishing spot.
`experienceBonus`	`a table`	Grows with the player's fishing experience, capped.
`luckBonus`	`a table`	A chance per sale for one extra surcharge.

`Config.Database`

Experience, sessions and catches. The tables are created on first start. Turned off, a fishing session still runs in memory, but the experience of a player is gone the moment they disconnect and no catch is kept at all.

Setting	Default	What it does
`enabled`	`true`
`tables`	`a table`