Britannia_Legendaries

Overview

Britannia_Legendaries brings the legendary animals to your server.

• The Legendary Hunter: walk up and press G. A black and gold window sells baits and the compendium, shows your hunt (time left, a route, call it off) and how many legendaries you have taken.
• The compendium: a leather-bound book that opens with a swing of its cover. The contents page lists all 42 legendaries, with search and filters (Runs, Fights, Not yet hunted). Each legendary has its own page: picture, region, description, the bait it takes, the hours it comes out, whether it runs or fights, the region map inked in gold, and a gold Taken seal once you have brought it down.
• Hunts: press Hunt it in the book. The legendary's area is marked on your map with a route. Lay the right bait there, at the right hour, and it comes.
• Baits without a hunt: lay a bait inside a legendary's area at its hours, and it may come (each area has its own chance).
• The animal: it appears out of sight and walks in to the bait. Grazers bolt when you come close or shoot; predators and bison come for you. If it gets far enough away, it is gone.
• A rest time after every encounter, a time limit on hunts, and an optional cash or gold reward for a hunt.
• Its own pictures (every legendary, the region maps, the baits and the compendium) and its own windows. English, Spanish and French.

Skinning rewards and selling the legendary pelts and parts are left to your hunting script (for example Britannia_Hunting_Bundle, which knows all 42).

The Lua is encrypted by Cfx.re; the settings, the legendary list, 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).

Install

1. Download Britannia_Legendaries from your Cfx.re account (portal.cfx.re → Assets → Granted Assets).
2. Put the Britannia_Legendaries folder in your server's resources folder. Don't rename it.
3. Add ensure Britannia_Legendaries to server.cfg, after ensure oxmysql and ensure poggy_core.
4. 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, and copy their pictures from html/img to your inventory's picture folder.
5. Stop any other legendary animal script (two would both answer the baits).
6. Restart the server. Its database tables are created automatically.

Items

All five are usable. SQL.sql uses INSERT IGNORE, so items your server already has stay as they are.

Configuration

Settings are in shared/config.lua, and every option is commented. The legendaries are in shared/legendaries.lua.

Each legendary in shared/legendaries.lua has: its coat (model and outfit), health, bait, whether it attacks, the hours it comes out (false = any time), its region, picture, map and description, and its areas (coords, radius, chance, delay before it shows up). Add, remove or move them freely; keep each id the same once players have hunted it.

server/sv_config.lua holds a Discord webhook for a log of legendaries brought down.

Commands and permissions

• G at the Legendary Hunter: open his window.
• /compendium: open the book (carrying the compendium, or at the hunter).
• /legendaryspawn <number> (staff): bring that legendary (its number in the list) to you, for testing.
• /legendaryreset <server id> (staff): clear a player's hunt and rest time.

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

How it works

Starting a hunt. Open the compendium, turn to a legendary and press Hunt it. One of its areas is marked on your map, with a route, and you are told which bait it takes and when it comes out.

Laying the bait. Get off your horse inside the area and use the bait. If it is the wrong bait or the wrong hour, you are told and keep the bait. Otherwise the legendary arrives after a short wait.

The hunt. Grazers walk in to the bait and bolt when you come close or shoot. Predators and bison charge. Bring it down before it gets away: the server checks the kill and counts it in your compendium. Then skin it as usual.

Rest time. After every encounter (taken, escaped, timed out or called off), a hunter rests for Config.Hunts.Cooldown minutes before the next legendary.

Troubleshooting

The hunter says I'm too far

Stand right by him (Config.OpenDistance). The script also accepts your own game's position if the server has lost track of you.

Nothing comes to the bait

Check the bait and the hours on the legendary's page, and that you are inside the marked area. Without a hunt, the area's chance decides.

It ran off before I got close

Grazers bolt at Config.Animal.FleeDistance; shoot from range, or raise the distance.

Version history

• 1.0.0: first release.