Britannia_Lumber

Overview

Britannia_Lumber turns woodcutting into a full job.

• Trees that really fall: the script places its own trees. After a few chops a tree tips over for everyone nearby, leaves a stump, and grows back later. Trees and stumps survive restarts.
• Five ready-made forests (pine, oak, maple and cedar), each with a map blip. They plant themselves the first time a player rides near, on good ground. Add more anywhere with one command.
• Chopping: take an axe in hand, walk up to a tree, press G. Each chop is a short swing game: press Space or G when the gold marker is in the gold zone. Land every swing and the chop is done; a miss fails it.
• Logs of the tree's own wood, plus a chance of sap, resin, fibres or a bird nest.
• Three axes: Basic, Improved and Experienced, each faster, giving more wood and better bonus finds. Uses left show on the item; it breaks on its last use.
• 30 levels: chopping, felling and bench work give XP, and every level chops faster and gives more.
• /lumber: your level and XP, bonuses, axe, totals, the lumber yards with a route, and a Crafting tab: axes, tools and the bench, each with its cost (have / need) and the level it unlocks at, beside the levels table.
• The processing bench: craft it, then place it yourself (a see-through bench follows you; turn it with the arrow keys or mouse wheel, Enter sets it down). Not in towns, water or on steep ground. At the bench: logs → split logs → sawed planks → hardwood, with a sawing rhythm game (A and D on the beat), tools that wear out, and bonus sawdust. Pick it up again whenever you like.
• Lumber yards: a buyer at each yard lists everything he buys, lights up what you can sell, and pays for logs, split logs, planks, hardwood, sawdust, sap, resin, fibres and bird nests.
• Our own interface everywhere: key hints, progress bars and minigames, no default prompts. 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_Lumber folder in your server's resources folder.
2. Add this to server.cfg, after poggy_core and oxmysql: `` ensure Britannia_Lumber ``
3. Add the items (see Items).
4. Copy the pictures in images/ to your inventory's picture folder.
5. Restart the server. Its database tables are made for you, and the five forests plant themselves when players come near.

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.

New items: the three axes (axe_basic, axe_advanced, axe_experienced), the processing bench (lumber_bench), the woodsaw, wood planer and chisel (tool_woodsaw, tool_woodplaner, tool_chisel), and the wood items: logs, split logs, sawed planks and hardwood for pine, oak, maple and cedar, plus sawdust. Sap, resin, fibres and bird nests are common items most servers have; the files add them if yours doesn't.

To use axes your server already has, rename the keys in Config.Axes.

Configuration

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

Commands and permissions

Staff are poggy_core admins, or anyone with add_ace group.admin britannia_lumber.admin allow (or your own ace in Config.AdminAces).

How it works

Everything is checked and timed by the server: the axe, the distance to the tree, the tree's state, the chop time, the bench's tools and ingredients, and every sale. Trees sit on the ground by themselves: each one measures where its trunk really starts and settles onto the ground when a player comes near.

Troubleshooting

A forest doesn't appear

It plants itself when a player comes within about 150 m. If it still doesn't, the forest's height in Config.Forests may be far off the ground there; move its centre or lower its number of trees.

No "Chop tree" hint

Take the axe in hand first (use it from your inventory), then stand right next to one of the script's trees.

Items have no pictures

Copy the pictures in 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.