Britannia_Mining

Overview

Britannia_Mining is a full mining job, from the rock to the buyer.

• Three pickaxes: Basic (5 uses, normal stone), Advanced (10 uses, twice the stone, level 10) and Experienced (15 uses, three times the stone, level 20). Better pickaxes swing faster and can turn up a gold nugget or gem. Use one from the inventory to take it in hand; the uses left show on the item and it breaks on its last use.
• Mining: in the mines (Annesburg, Tumbleweed and Blackwater out of the box, each with a map blip), walk up to a rock and press G. Each swing is a swing game: press Space or G when the gold marker is in the gold zone. Land every hit for 1–3 stone, sometimes coal or clay. A mined rock rests for a minute.
• Washing (the precious finds): stand in shallow water anywhere and use the stone. Three stones go into the pan, then you pick the finds off a sifting table by hand before daylight runs out: gold nuggets, quartz, silver ore and uncut opals, sapphires, emeralds, rubies and diamonds. Only what you pick is kept.
• The ore works (the bulk): at the Annesburg ore works, choose how many stones to break down and strike the cracks: click each glowing crack on the stone before it fades; three hits split a stone. You get iron, copper, zinc and lead ore, coal, clay, sulfur, nitrite, salt and rock.
• The smelter: turn ore into iron, copper, zinc, lead, silver, gold and steel bars, and clay into bricks. Each bar burns one coal. Keep the heat: hold Space to pump the bellows and keep the needle in the gold band. Some bars unlock at higher levels.
• Ore buyers at Annesburg and Valentine list everything they buy, light up what you have, and sell a basic pickaxe so a new miner can start.
• 30 levels: every swing, stone and bar gives XP; each level mines faster and gives more stone.
• /mining: your level and XP, bonuses, pickaxe, totals, every mine, works, smelter and buyer with a GPS route, a Crafting tab for the pickaxes, and the levels table.
• Our own interface everywhere: key hints, progress bars, minigames and notifications in black and gold, no default prompts. Every minigame can be switched off for a plain gold timer. English, Spanish and French.

The Lua is encrypted by Cfx.re; the 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 it from portal.cfx.re (Assets, Granted Assets) and put the Britannia_Mining folder in your server's resources folder.
2. Add this to server.cfg, after poggy_core and oxmysql: `` ensure Britannia_Mining ``
3. Add the items (see Items).
4. Copy the pictures in installation/images to your inventory's picture folder.
5. Restart the server (VORP reads new items when it starts). Its database table is made for you.

Items

• VORP: run SQL.sql once. It only adds items your server doesn't have yet.
• RSG Core / QBCore RedM: add the items in installation/items_rsg_qbcore.txt to your items list.

Items: the three pickaxes (pickaxe_basic, pickaxe_advanced, pickaxe_experienced), stone (usable: washes it in water), what stone turns into (rock, clay, coal, iron, copper, zinc, lead and silver ore, iron extract, nitrite, sulfur, salt rock, quartz, gold nuggets and five uncut gems), and the smelter's iron, copper, zinc, lead, silver, gold and steel bars and bricks. Most servers already have many of these; the files only add the missing ones.

To use pickaxes your server already has, rename the keys in Config.Pickaxes.

Configuration

Everything is in shared/config.lua, and every option is commented:

Commands and permissions

There are no staff commands; everything is set in the config.

How it works

Everything is checked and timed by the server: the pickaxe in hand, the distance to the rock, bench, smelter or buyer, the rock's rest, the time each job takes, the stones, ore and coal, and every sale. Nothing is taken until the work is done, and the rewards are rolled on the server.

Troubleshooting

No "Mine rock" hint

Take a pickaxe in hand first (use it from your inventory), then stand right at a rock in one of the mines. Without a pickaxe, a red hint reminds you.

"Stand in shallow water to wash stone"

Stand in a river or lake up to about your knees, not swimming.

New items can't be given or picked up

Restart the server after adding the items: VORP only reads its item list when it starts.

Items have no pictures

Copy the pictures in installation/images to your inventory's picture folder.

Version history

• 1.1.0: works with the free Land Office (/britannia): staff change every setting in game. New Config.Notify setting: messages go through Britannia Notifications when it runs, poggy_core's notifications, or your own notification script (Config.CustomNotify).
• 1.0.0: first release.