Studios
Fishing Jobhouse-3.jpg

Configuration

SoonFishing JobQbox
PAGE 03 OF 06  ·  INSTALLATION → CONFIGURATION → EXAMPLESdocs.glitchstudios.dev
Browse docs

Everything is in config/, and the folder is open in the escrow.

File What it holds
config/main.lua Integration switches, pay, crew split, XP, crew size, deposits, licences, crew vehicles, rods, bait, lure, cooler, cast timings, the landing minigame, hotspots, freshness, the market, trophy quotas, pruning, filleting, offshore nets, blips, icons and junk catches.
config/species.lua Water types (level and rod needed) and the eighteen species with weights, tiers and reference prices.
config/contracts.lua The order templates on the tablet.
config/locations.lua The fish market points, the marina, the marked waters and the hobby water rules (Config.WildWater).
locales/en.json Player text. Add locales/<code>.json and set setr ox:locale "<code>" to switch language.
data/locations.json Points saved by /fishingadmin. They override config/locations.lua. Delete the file or set it to {} to go back to the config.

Settings most servers change#

  • Config.MarketName is the name on the tablet and in the task list. Config.MarinaName is how the mooring reads in a sentence, and Config.NotifyTitle is the title on every fishing notification. The map blip uses Config.Blip.label.
  • Config.QuotaDay sets when daily trophy quotas reset. By default that is midnight on the server machine's clock. Set serverClock = false and use utcOffset and dst (false, 'au', 'eu' or 'us') for another time zone.
  • Config.WildWater.enabled = false limits hobby fishing to the marked waters. Config.WildWater.types can drop single water types.
  • Config.PerksWithoutXpSystem sets the perks everyone has when glitch-xpSystem is not running.
  • Config.Junk lists items a hobby catch can bring up too. The default is cloth at 8 percent. Items your ox_inventory does not have are skipped. {} turns it off.
  • Config.Landing.game picks the landing minigame: 'auto', 'glitch-minigames' or 'ox_lib'.
  • Config.Landing.serverMiss gives each tier a hidden chance that the line snaps on the server after a reported win. It is 0 for every tier by default.
  • Config.Debug = true prints sales, fillet batches, settlements and trophy landings to the server console and shows target zone outlines.

Pay#

A contract's value is the crew's average hourly rate times its planned minutes. The rate runs from $2,255 an hour at fishing level 1 to $3,946 at level 20 (Config.Pay). Eighty percent of the cash is split equally between the workers who did enough (Config.Split.minCredits). The other twenty percent follows the work each one did: catching, packing, driving, delivering and hauling nets. Each extra eligible worker adds 5 percent to the pot, up to 15 percent. Supply orders give the crew 30 percent of the fish and less cash.

Hobby catches are sold at the market. Selling your own catch needs a fishing licence ($300). Each species loses 1 percent of its price for every 20 sales in the last hour, down to 30 percent off.

Integrations#

Config.Integrations = {
    pauseMenuLegend = 'auto',   -- glitch-pauseMenu: report blip names to the map legend
    netEventGuard   = 'auto',   -- glitch-poolcleaning: count the net events players send (server/guard.lua)
    adminLogWebhook = 'jobs',   -- glitch-admin: webhook channel name for the job log
}

'auto' turns a switch on only when that resource is installed, and false turns it off everywhere. server/guard.lua wraps RegisterNetEvent so it can count events for glitch-poolcleaning. It returns straight away when glitch-poolcleaning is not installed, never blocks an event and sends nothing off the server. If you never run glitch-poolcleaning you can delete server/guard.lua and its line in fxmanifest.lua.

config/main.lua reference#

Setting Default
Config.Debug false
Config.MarketName 'La Puerta Fish Market'
Config.MarinaName 'the Marina'
Config.NotifyTitle 'Fishing'
Config.QuotaDay { serverClock = true, utcOffset = 0, dst = false }
Config.XPCategory 'fishing' (glitch-xpSystem category and skill tree id)
Config.Pay hourlyLevel1 = 2255, hourlyLevel20 = 3946, perkCap = 0.15
Config.Split equalShare = 0.80, minCredits = 3
Config.XP perHour = 330, hobbyPerCatch = 3, perFillet = 1, levelWithoutXpSystem = 10; per-action values in per
Config.PerksWithoutXpSystem fishing_rare = 1, fishing_legendary = 1, fishing_hotspot = 1
Config.Crew maxSize = 4, bonusPerMember = 0.05, bonusMax = 0.15, requireGroup = false, readyRadius = 25.0, readyTimeout = 30, reconnectGrace = 300
Config.Deposits vehicle = 500 (company boat), rod = 100 (per loaned basic rod)
Config.Licences fishing $300, boat $1,500
Config.Vehicles.van Crew's own car: trunk capacity = 40, returnRadius = 60.0, pickRadius = 6.0
Config.Vehicles.boat model = 'dinghy', platePrefix = 'FBOAT', capacity = 60, returnRadius = 60.0
Config.Rods Basic $150, carbon $1,500, deep-sea $4,000, with rank, wear per cast and line tension
Config.SnapWear / Config.WornRod / Config.WornTensionPenalty 1 / 25 / 4
Config.Bait item = 'fishing_bait'; worms $1 (shore, lake, river), squid $3 (shore, offshore)
Config.Lure item = 'fishing_lure', price = 120, lake and river, biteBonus = 0.10
Config.Cooler item = 'fish_cooler', price = 400, label = 'Fish Cooler' (must match the item label), prefix = 'fcool'
Config.Cast biteMin = 8000, biteMax = 18000, reactWindow = 2500, tolerance = 600, maxMove = 3.0, maxMoveBoat = 25.0, spacing = 1.5, creel = 8
Config.Landing game = 'auto', one profile per tier, tensionPerRank = 4, keys = { 'E' }, suspectStreak = 60, serverMiss all 0
Config.Hotspot rotateMin = 20, radius = 12.0, biteBonus = 0.15
Config.Fresh lossPer30 = 10, coolerRate = 0.25, floor = 0.40, spoilMin = 360, coldPerRank = 0.15
Config.Market saturationStep = 20, saturationCap = 0.30, maxSellBatch = 50
Config.Legendary perCharacter = 3, serverDaily = 15
Config.Prune paidDays = 30, expiredDays = 7, quotaDays = 7, contractDays = 30, metDays = 180
Config.Frenzy seconds = 300, oldSaltTrophies = 2
Config.Tiers common = 80, uncommon = 17, rare = 3, legendary = 0.5
Config.Process filletItem = 'fish_fillet', filletGrams = 250, perKg = 3, minFresh = 50, maxKg = 10
Config.Nets perCrew = 1, extra = 1, fishPerNet = 3, durationMs = 10000, sealegsBonus = 0.25
Config.ClaimDays 7
Config.Interactions useRcInteractions = true, projectId = 'glitch_fishmonger', keepTargetOptions = false, resyncOnStart = false
Config.Blip / Config.WaterBlip Sprite 68; market label 'Fishing Market'
Config.InventoryImageBase Your inventory:imagepath convar, or nui://ox_inventory/web/images/
Config.SpeciesIcons true
Config.MigrateLegacyImages false
Config.Junk { { item = 'cloth', chance = 8 } }

Water types and species#

config/species.lua sets what each water needs:

Water Level Rod
shore 1 Basic
lake 1 Basic
river 5 Carbon
offshore 10 Deep-sea

Each species has a water, a tier, a weight range in kg and a reference price (ref) for a fish of average weight. Rare fish need the fishing_rare perk. Trophy fish need fishing_legendary and room in today's quota.

Water Common Uncommon Rare Trophy
Shore Mackerel, sea bass Snapper Yellowtail Giant sea bass
Lake Perch, catfish Largemouth bass Sturgeon Golden carp
River Trout Salmon Steelhead King salmon
Offshore Halibut Tuna Swordfish Blue marlin

Order templates#

Id Water Mode Vehicle Planned minutes Min level
shore_basket Shore Company, 75 percent freshness Crew car 6 1
shore_haul Shore Company Crew car 6 1
shore_supply Shore Supply, crew keeps 30 percent Crew car 6 1
river_order River Company, 70 percent freshness Crew car 12 5
offshore_trip Offshore Company, with nets Company boat 12 10

The Alamo Sea is hobby water only, so no order goes there. Each template takes waters, species (a list, or '*' for any non-trophy species of the water), mode, vehicle, minFresh, unitsPerWorker, plannedMinutes, minLevel, loanRods and nets.

Locations#

Config.Locations holds the fishmonger (market), its ped model (marketPed), the cleaning table, the boat spawn and the mooring (boatReturn), plus the marked waters. Each water has an id, label, type, center, radius, capacity and an optional public flag and spots list. The defaults are Del Perro Pier, Raton Canyon Creek, Zancudo River, Del Perro Banks and Paleto Deep.

Config.WildWater controls hobby fishing outside the marked waters:

Setting Default
enabled true
types { shore = true, offshore = true, lake = true, river = true }
seaZ 2.5
seaMaxHeight 25.0
boatRadius 8.0
lakes The Alamo Sea, radius = 1150.0