Poggy Fishing

Overview#

Poggy Fishing gives your players a real fishing game. They equip a rod, cast into the water, tug the line until a fish takes the hook, then fight it with skillchecks. A landed fish can be kept or thrown back. Every kept fish also rolls for bonus loot, like pearls or gold.

Which fish bite depends on the water, the time of day, the bait and the season. The season changes at every restart, so the catch is never quite the same.

• 28 fish across 34 waters: lakes, rivers, the bayou, creeks, ponds and the sea.
• Four legendary fish, each in its own water and its own short time window.
• Six baits and lures that change what bites and how hard the fight is.
• Two rods: the normal rod with a tug game, and the Pro Rod with a mouse-driven pull fight.
• Random seasons: by default 80% of the fish are in season after each restart.
• A full HUD with sounds, four music tracks and two looks (brass or default).
• Every setting can be changed in game from the /poggy settings hub.
• The Fishing Journal: an illustrated book with a map of every water, fish lore, and each character's discoveries and best weights.

Requirements#

Works on VORP, RSG and QBR (QBCore RedM). RedM only.

The journal is optional. Poggy Fishing runs without it, but see Hide fish not yet caught under Configuration.

Installation#

1. Make sure poggy_core, poggy_skillcheck and oxmysql are installed and started.
2. Put the poggy_fishing folder in your resources folder. If you use the journal, put poggy_fishing_journal there too.
3. Add them to server.cfg, after their requirements, with the journal last:

   ensure oxmysql
   ensure poggy_core
   ensure poggy_skillcheck
   ensure poggy_fishing
   ensure poggy_fishing_journal

4. Copy the item pictures from each script's docs/item_images/ folder into your inventory's image folder. On VORP that is vorp_inventory/html/img/items/.
5. Restart the server.

On VORP there is nothing to import. Each script adds its items to the database by itself when it starts, and the journal also creates its own table. Items you already have are never changed.

The items to add on RSG:

• Rods: fishingrod, fishingrod_pro
• Baits and lures: bait_worm, bait_cricket, bait_bread, bait_crawdad, p_lgoc_spinner_v4, p_finishedragonflylegendary01x
• Every fish item from the fish list (the names starting a_c_fish)
• Loot: whitepearl, redpearl, bluepearl, goldpearl, blackpearl, golden_nugget, diamond_uncut
• The journal: fishing_journal_fn

Rods, baits and the journal must be usable items. Give players rods, bait and the journal your own way: a shop, a starter kit or an admin give.

Configuration#

Every setting can be changed in game: type /poggy, pick Poggy Fishing (or Poggy Fishing Journal), change what you need and save. Then restart the script. You can also edit each script's config.lua by hand.

The fishing hub has these tabs: General, Baits & fish, The bite & fight, Difficulty tiers, Pro Rod, Appearance and Advanced. It also has two guides: Tuning baits and what bites and Making fishing easier or harder. Some settings are only shown under Show advanced.

General

The bite and the fight

Fishing with no bait uses its own multipliers on these values (Config.Interest.NoBait, under Show advanced). By default interest rises much more slowly, and taps give extra interest while the line is between 20 and 85 tension: a risk and reward.

Difficulty tiers

A fish's price decides how hard it is:

The fish is landed when the progress bar reaches 100, so Progress per good hit sets how long a fight lasts: 12 means about nine hits. Zone difficulty 1 is a big target zone and 5 is a small one. Each tier also has Great part of the zone (how much of the zone counts as a great hit), its own tug game scaling, and the Pro Rod drain multiplier. Raising a fish's price in the fish list can move it to a harder tier.

Pro Rod

Each tier also makes the Pro Rod drain faster for bigger fish (Pro Rod drain × on the Difficulty tiers tab): easy 0.7, medium 1.0, hard 1.3, expert 1.7, legendary 2.2.

Baits and lures

On the Baits & fish tab. Each bait has a bonus, target fish, a lose chance and size weights.

• Bonus makes the skillcheck zone bigger by that many levels. A bonus of 0 counts like no bait: the zone is one level smaller. A bonus of 2 also slows the needle by one.
• Target fish are three times as likely to bite. On the normal rod, each tap also gains extra interest when a target fish lives in that water.
• Lose chance is the chance the bait is lost when a fish gets away. A snapped line always loses it. A caught fish never uses up bait.
• Size weights set how likely each fish size is to bite. A weight of 0 means that size never bites on this bait. A size left out counts as 1, not 0.

To add a bait: add the item to your framework first, then click Add bait in the hub, fill it in, save and restart. The new item becomes usable on its own.

Fish

Each fish has a name, item, price (which sets its tier), size, weight range and optional active hours. Many fish only bite at certain hours, for example bullhead at night (8 PM to 6 AM) and chain pickerel in the morning (5 AM to noon). The legendary fish have short windows:

Northern pike live in Owanjila, Lake Isabella, the Dakota River and the Upper and Lower Montana River. Longnose gar live in Elysian Pool, the Kamassa, Lannahechee and San Luis rivers, Bayou Nwa, Arroyo de la Vibora and Bahia de la Paz.

Which fish live in which water is built into the script and cannot be edited. A new fish, or a fish id you rename, will not appear in any water. You can change everything else about a fish.

Bonus loot

Every kept fish gives one bonus item, picked by weight (two with the Pro Rod). A weight is not a percentage: an item's odds are its weight divided by the total of all weights.

The crawdad bait entry is labelled "Cricket Bait" in the default list, so the loot message says Cricket Bait while the item given is crawdad bait. Change its label in the list if that bothers you.

Appearance

To make your own skin, copy ui/skin-brass.css as ui/skin-<name>.css, change the image names in it, and set the skin to <name>. Images are optional: a missing one leaves that piece in plain colour. The image sizes are listed at the top of skin-brass.css.

Advanced

Commands#

The journal has no commands. Players open it by using the journal item.

Controls while fishing

Permissions#

Fishing itself needs no permission: anyone with a rod can fish. The only restricted action is /rerollseasons. To let a group use it, add this to server.cfg:

add_ace group.admin command.rerollseasons allow

Who may change settings in /poggy is set in poggy_core. See Poggy Core.

Using it in game#

How a catch works

1. Equip. Use the fishing rod or the Pro Rod from the inventory. The HUD opens and shows the fish of the water you are at.
2. Bait (optional). Press G and pick a bait you carry, or use a bait item from the inventory.
3. Cast. Stand close to the water and press Left mouse. Nearby players see the splash.
4. Hook the fish.
   • Normal rod: after a few seconds the tug game starts. Tap E to raise interest (blue bar). Each tap also adds tension (red bar). Interest at 100 hooks the fish. Tension at 100 snaps the line. Stop tapping too long and the fish gets bored and leaves.
   • Pro Rod: there is no tug game. A fish bites after a short random wait.
5. Fight. Hit the skillchecks to fill the progress bar. The fish is landed at 100. Misses take progress away, and at 0 the fish escapes. Misses in a row make the needle faster.
   • Normal rod: 4 misses snap the line.
   • Pro Rod: the fish also pulls left, right or forward. Move the mouse to counter it. Countering well slows the drain and eases tension. Tension at 100 snaps the line.
6. Keep or throw back. Press E to keep the fish or Backspace to throw it back. A kept fish goes into the inventory with a bonus loot roll. The catch screen shows its weight.

Normal rod and Pro Rod

Why nothing bites

A fish can only bite when it lives in that water, is in season, and is inside its active hours. The bait's size weights must also allow its size. If none of the fish in a water qualifies, the player sees "Nothing seems to be biting here...". Try another bait, another time of day, or another water.

Fishing Journal#

The Fishing Journal (poggy_fishing_journal) is an inventory item that opens an illustrated book. It needs Poggy Fishing and must start after it.

What players see

• A map of every water, with a pin for each. Click a pin to see the fish that live there and which are in season now.
• The time of day each fish bites.
• A lore page for every species: history, habitat, behaviour and where to find it.
• Their own records: fish discovered, catch counts and best weights, across the Journal, Discoveries, Records and PBs tabs.

Using the item plays a notebook animation, then the book opens. Esc closes it.

A fish caught in a water for the first time shows a discovery message. Beating a personal best weight shows a gold "Personal record" message.

The journal also feeds Poggy Fishing's Hide fish not yet caught setting: the fish a character has discovered in a water are the ones shown on the fishing HUD there.

Journal settings

In /poggy → Poggy Fishing Journal, or in its config.lua. Restart the journal after a change.

The water pins, water descriptions and species lore are built in and cannot be edited.

Keeping the journal in step with Poggy Fishing

The journal keeps its own copy of the fish list. Poggy Fishing decides what is caught; the journal only shows and records it. When you change a fish in Poggy Fishing, change it in the journal too:

Price shown, size group, species and the weight range are for display only. The prices in the journal's default list are not the same as Poggy Fishing's, and northern pike and longnose gar are grouped as Extra Large there; edit them if you want the two to agree.

For developers#

Poggy Fishing has two server exports, used by the journal:

The items the scripts register as usable: the two rods, every bait in the bait list, and the journal item. Fish and loot items are plain items, so any shop or butcher script can buy them.

Troubleshooting#

Nothing happens when a player uses the rod.

Check that poggy_core and poggy_skillcheck are started before poggy_fishing. If poggy_core is not ready within 30 seconds of the start, the console says the usable items were not registered; restart the script once poggy_core is running.

"Get closer to the water." or "No fish in this water."

The player must stand close to the water to cast, and the water must be one of the 34 built-in waters.

"Nothing seems to be biting here..."

No fish in this water can bite right now: wrong hour, out of season, or the bait's size weights are 0 for every fish here. Try another bait or another time. An admin can run /rerollseasons.

The HUD shows no fish pictures.

Copy docs/item_images/ into your inventory's image folder. With Hide fish not yet caught on, a fish only shows after the character has caught it in that water while carrying the journal. If you do not run the journal, turn that setting off.

A yellow line at start names missing items.

Add those items to your framework's item list (on RSG, rsg-core/shared/items.lua). Until then nobody can be given them.

"Your inventory is full!"

The player has no room for the fish, so it is not given. Loot is only rolled for a fish that lands in the inventory.

Journal catches are not recorded.

The player must carry the journal item, and the fish's id must be in the journal's fish list.

The journal shows no seasons or no fish per water.

poggy_fishing must be running. The journal reads both from it, and prints a warning in the server console when it cannot.

Updating#

Both scripts update through poggy_core's updater. Your config.lua values are kept and new settings arrive with their defaults. See Poggy Core: updates.

Item rows already in your database are never changed by an update, so your own labels and limits stay. On RSG, check the console after an update for a yellow line naming any new item to add by hand.