Configuration — ns-fishing

Everything a server owner changes stays editable under escrow: config.lua, data/*.lua, locales/*.lua.

config.lua

data/species.lua

One entry per catchable: id, item, habitats (fresh / salt / deep), optional zones (only bites there), rarity, minLevel, minRod, kg = { min, max }, price (average weight, one star), xp, difficulty (1–100), behavior (smooth, mixed, dart, sinker, floater), tags (small, bottom, predator, big), legendary, junk, protected, optional when. A protected species bites only in protected zones (with enough police on duty), sells only at a black market and never appears in orders, tournaments or events; it cannot be legendary or junk. Data.Valuables lists fixed-price items (pearls). A new species needs an item and a locale key item_<item>.

when limits when a species bites (with Config.Features.Windows):

when = { hours = { 21, 5 } }                                -- 21:00-05:00 (wraps past midnight, the end hour is excluded)
when = { weather = { 'RAIN', 'THUNDER' } }                  -- GTA weather names
when = { hours = { 21, 5 }, weather = { 'THUNDER' } }       -- both must match

A malformed when skips the species with an error in the console. Weather names shown in the journal come from the locale keys weather_<NAME>.

data/gear.lua

• Data.Rods: item, tier, price (0 = not sold), minLevel, bar, power, size.
• Data.Baits: item, price, minLevel, speed, tags = { tag = multiplier }, junk, legendary, treasure.
• Data.Upgrades: per kind the effect per level and levels = { { price, minLevel } }. line.tension lowers the line tension rate per level.

data/achievements.lua

{ id, stat, goal, tier, reward = { money, xp }, title? }. Name from the locale key ach_<id>, title from title_<title>. stat is one of fish_caught, legendary_caught, treasures_found, total_earnings, biggest_kg, species (discovered), orders_done, tournament_wins, three_star_catches, crew_goals. tier 1 / 2 / 3 shows a bronze / silver / gold medal. Rewards are paid once when the goal is reached, also for goals reached before the achievement existed (checked when the player connects). Invalid entries are skipped with a console error.

data/zones.lua

{ id, type, center = vector3, radius, minLevel, requireBoat, blip, protected }. protected = true makes a marine reserve (protected species live there; any catch there can be reported). The smallest circle containing the player wins. Locale key zone_<id> names the zone. Zones placed with /fishlocations carry their own name.

Admin

All need ACE ns-fishing.admin (or framework admin with Config.Admin.useFrameworkAdmin).

/fishlevel, /fishxp, /fishupgrade, /fishgive, /fishtournament and /fishevent also work from the server console. The player must be online. /fishreset also removes the player's achievements and title.

Location tool (/fishlocations)

Place fish markets, boat docks and fishing zones in game. Every change is saved to data/locations.json and used at once by every player: no restart.

• The panel docks on the right so you still see the world: a sea chart with every zone (to scale), market and dock, a list per kind and a form for the selected place. Click a place on the chart or in the list.
• New ... where I stand / Move here switches to placement: walk, drive or fly to the spot and face the way the seller (or the boat) should look. E places it, Backspace goes back to the panel.
• Zones: name, waters (freshwater / coast / deep sea), radius (the ring in the world follows the slider), fishing level, boat-only rule and the map circle.
• Docks: name, the boats it rents out, the seller, up to 8 boat spawns on the water and the return point. A new dock shows needs setup until it has a spawn and a return point.
• Markets: name and seller position. Players trade within Config.Market.radius metres.
• The markets / docks in config.lua and the zones in data/zones.lua stay the defaults. The tool can edit them, switch them off and restore them exactly as shipped. Places added in game are deleted for good.
• The eye button keeps the markers in the world after the panel is closed.
• Coordinates always come from your position on the server; the client only says what to place.
• Legendary fish are bound to zone ids (zones = { ... } in data/species.lua). The form warns when a zone has them; switching such a zone off makes those fish uncatchable until it is restored.
• Keep data/locations.json when you update ns-fishing: it holds everything placed in game. If the file cannot be read on start it is copied to data/locations.json.broken and the defaults are used.

Hooks for other resources

AddEventHandler('ns-fishing:hook:securityFlag', function(src, reason, detail) end) — every suspicious request (for example minigame_too_fast, cast_id_mismatch, invalid_boat_model).