Britannia_Hunting_Bundle setup guide

Overview

Britannia_Hunting_Bundle is everything a hunter needs, built into one script.

Skinning rewards for every animal and coat variant: meat, fat, claws, feathers, hearts and more.
Butchers and trappers with a black and gold window: your catch, animal parts in category tabs, and your hunter rank.
Sell from your horse: the pelts stacked on it and the carcasses across its back, in one go.
A hunting cart built in: stow carcasses and pelts in a hunting cart, check the load (with pictures), take something back out, and sell the whole load at the counter. The load shows on the cart.
Carried carcasses and pelts sell with their quality (one to three stars); a skinned carcass sells for less.
Hunter ranks with rewards (items, cash or gold) claimed at any butcher or trapper.
Its own pictures: 265 pictures for every animal, pelt and part, included.
Shopkeepers, map blips, legendary animals, gold prices, job locks, a Discord log. English, Spanish and French.

The Lua is encrypted by Cfx.re; the settings, data files, server settings and text stay editable.

Requirements

poggy_core (free), version 0.14.0 or newer.
oxmysql.
One of VORP, RSG Core or QBCore RedM (poggy_core connects the script to it).
A hunting cart from your wagon script, for the cart features (the default model is huntercart01; any model can be added).

Install

Download Britannia_Hunting from your Cfx.re account (portal.cfx.re → Assets → Granted Assets).
Put the Britannia_Hunting folder in your server's resources folder. Don't rename it.
Add ensure Britannia_Hunting to server.cfg, after ensure oxmysql and ensure poggy_core.
VORP: run SQL.sql once in your database. RSG Core / QBCore RedM: add the items in installation/items_rsg_qbcore.txt to your items list.
Stop any other hunting, butcher or hunting-cart script (two would pay twice).
Restart the server. Its database tables are created automatically.

Items

SQL.sql adds the 126 items the script uses (meats, claws, tails, horns, teeth, antlers, feathers, hearts, small game, scent glands, wings, eyes, beaks and fat). It uses INSERT IGNORE, so items your server already has stay as they are. The pictures for all of them are in the script's own html/img folder; you don't need to copy them anywhere.

Configuration

Settings are in shared/config.lua, and every option is commented. The data is in five files you can edit freely:

File	What it holds
`shared/skinning.lua`	What skinning each animal (and coat variant) gives
`shared/carcasses.lua`	Carcass and pelt prices, the pelt models, XP and pictures for each animal
`shared/parts.lua`	The parts the shops buy, their prices and XP, and the category tabs
`shared/shops.lua`	Where the butchers and trappers are, their shopkeepers, blips, price multipliers and job locks
`shared/ranks.lua`	The XP each hunter rank needs and its rewards

Main settings:

Setting	What it does	Default
`Config.Locale`	Language: `en`, `es` or `fr`	`'en'`
`Config.Key`	The key that opens a butcher's or trapper's window	`'G'`
`Config.Skinning`	`Enabled`, `XpPerSkin`, `MaxDistance`, `Cooldown`	on, 0 XP
`Config.Buys`	What each shop type buys: carcasses, pelts, horse pelts, part categories	butcher: meat; trapper: all parts
`Config.Quality`	The share of the price for poor, good and perfect, and for a skinned carcass	0.2 / 0.5 / 1.0, skinned 0.5
`Config.CheckPelts`	`true` = a pelt only sells for the player who skinned it	`false`
`Config.HorseDistance`	How close the horse must be to the counter	`15.0`
`Config.Cart`	The hunting cart: `Models`, `Capacity`, `Key`, `Command`, `SellDistance`, and `Display` (where the load shows on the cart)	`huntercart01`, 10, `J`, `/cart`, 25 m
`Config.Ranks`	Hunter ranks on or off, rank-up messages	on
`Config.ImageBase`, `Config.AnimalImageBase`	Where pictures come from for anything not in `html/img`	your inventory

server/sv_config.lua holds a Discord webhook for a log of large sales (SvConfig.Webhook, SvConfig.LogOver).

Commands and permissions

G at a butcher or trapper: open the window.
J at your hunting cart (or /cart): stow what you're carrying, or check your load.
/huntingxp <server id> <amount> (staff or the server console): add hunter XP (negative takes it away).

Staff are anyone with an ace in Config.AdminAces (e.g. add_ace group.admin britannia_hunting.admin allow), anyone in Config.AdminGroups, and poggy_core admins.

How it works

Skinning. When a player finishes skinning, the server checks the animal really is there and next to them, then gives that animal's items.

At the counter. The window shows what you're carrying, what's on your horse (pelts and carcasses) and what's in your hunting cart, each with its picture, quality and price. Sell them, then sell parts from the tabs (some, all of one, or everything at once). The server prices everything and checks every carcass is real before paying.

The hunting cart. Carry a carcass or pelt to your hunting cart and press J (or /cart) to stow it. With empty hands, J opens your cart: a card for each thing loaded, with its picture and stars, and Take out puts it back in your arms. Park the cart near a butcher or trapper and sell the whole load from the window. The load belongs to the player, so it follows them to any hunting cart.

Hunter ranks. Sales give XP. Each rank's rewards are claimed in the Hunter rank tab at any butcher or trapper.

Troubleshooting

Nothing happens at the cart

Stand right next to it (Config.Cart.Distance). The cart's model must be in Config.Cart.Models. If another wagon script shows its own prompts at the cart, use J or /cart: they work whatever prompt is showing.

The pelts on my horse don't show

The horse must be within Config.HorseDistance of the counter, and it must be your current or last horse.

Pictures show a gold star

That name has no picture in html/img or in your inventory. Add a picture named after it (for example provision_bear_claw.png) to html/img.

Version history

1.0.0: first release.

Still stuck?

Open a ticket on our Discord with your framework, your poggy_core version and what you see, and we'll help you get it running.

Get help on Discord