Requirements#
The server
| Framework | qbx_core (Qbox). ESX and plain QBCore are not supported. |
| Resources | ox_lib, oxmysql, ox_target, ox_inventory |
| OneSync | Required. The manifest depends on /onesync. |
| Database | MySQL or MariaDB through oxmysql. The four tables are created on first start. |
| Tested with | qbx_core 1.24.0, ox_inventory 2.48.0, ox_lib 3.40.0, ox_target 1.17.2 and oxmysql 2.14.2 |
Optional resources
Each one is checked at run time, and its feature is skipped when the resource is not running.
| glitch-uiElements | Key hints, the order task list and the job complete screen. Strongly recommended: without it players only get notifications. |
| glitch-minigames | The circle landing minigame. Without it the landing is an ox_lib skill check. |
| glitch-xpSystem | Fishing levels, the fishing perk tree and XP. Without it everyone counts as level 10 and has the perks in Config.PerksWithoutXpSystem. |
| sd-phone | Crew groups. Without it every order is a solo order. |
| rc-interactions | Fishmonger dialogue, from rc-interactions/glitch_fishmonger.json. Without it the fishmonger has plain ox_target options. |
| qbx_vehiclekeys | Keys for the company boat. |
| glitch-treasury | Books shop and licence spending as money leaving the economy. |
| glitch-admin | The job log (orders, sales, licences, testing mode), sent to the channel named in Config.Integrations.adminLogWebhook. |
| glitch-licensing | Licence suspensions, and selling or revoking fishing and boat licences from its own counter. |
| glitch-smallresources | A cast resets the AFK timer. |
| glitch-pauseMenu | Blip names in the map legend. |
| glitch-poolcleaning | Counts the net events players send to this resource, through server/guard.lua. |
Installation steps#
Copy the
glitch-fishingJobfolder into yourresourcesfolder. The folder name is case-sensitive: the item definitions callglitch-fishingJob.useRodandglitch-fishingJob.inspectFish, so a renamed folder breaks the rods and fish.Items. Paste the entries from
install/ox_inventory_items.luaintoox_inventory/data/items.lua. Paste the cooler frominstall/ox_inventory_containers.luaintoox_inventory/modules/items/containers.lua. Restart ox_inventory afterwards.Icons. Copy the PNGs from
images/intoox_inventory/web/images, or into the folder yourinventory:imagepathconvar points at. The resource reads that convar, so species and squid bait icons follow it.Database. The tables are created when the resource starts. If your database user cannot create tables, run
install/fishing.sqlonce by hand.Add the resource to
server.cfg, after its dependencies and after any optional resources you use:ensure ox_lib ensure oxmysql ensure qbx_core ensure ox_target ensure ox_inventory # optional, before the fishing job ensure glitch-uiElements ensure glitch-minigames ensure glitch-xpSystem ensure glitch-fishingJobPermissions.
/fishingadminis open togroup.adminthrough the ACEcommand.fishingadmin. To give it to another group:add_ace group.mod command.fishingadmin allowPlaces. The fishmonger, cleaning table, marina and waters in
config/locations.luaare set up at the La Puerta fish market. Keep them, edit the file, or walk to each spot with/fishingadmin.Optional: import
rc-interactions/glitch_fishmonger.jsoninto rc-interactions as a flow for the fishmonger dialogue.Start the server, buy a rod and some bait from the fishmonger, then use the rod while facing water.
Items#
| Item | What it is |
|---|---|
fishing_rod_basic |
Basic rod (rank 1): shore and lake. Loses condition with every cast. |
fishing_rod_carbon |
Carbon rod (rank 2): adds rivers and handles better. |
fishing_rod_deepsea |
Deep-sea rod (rank 3): every water, needed offshore. |
fishing_bait |
One per cast. metadata.type is worm or squid. |
fishing_lure |
Used instead of bait on lakes and rivers. Wears out after about 100 fish. |
fish_cooler |
ox_inventory container: 20 slots, 40 kg, fish and fillets only. |
fish_catch |
A caught fish. Species, weight and freshness are in its metadata. Using it shows its freshness. |
fish_fillet |
A 250 g fillet from the cleaning table. |
Updating#
Read CHANGELOG.md first. Replace everything except the files you changed: config/, locales/ and data/locations.json. The package ships data/locations.json empty ({}), so copying it over yours throws away every point you moved with /fishingadmin. Compare the new config/ files with yours and merge any new settings, then restart the resource. The tables are created with CREATE TABLE IF NOT EXISTS.