Land Office

Overview

The Land Office is a free settings editor for Britannia scripts. Staff type /britannia and get one window with every Britannia script on the server, instead of opening config files.

• A card for each script: its name, whether it's running, how many settings it has and how many are changed. Filter by category or state, and search scripts and settings together.
• Every setting with its help: a script's page shows its settings in the sections of its config file, with the file's own comments as help, the file value, and what it's set to now.
• An editor for each kind of value: on/off switches, numbers, text, long text boxes, coordinates (with a Here button for where you stand), lists, tables of rows (loot lists, recipes, tools...), named values such as prices, and lists of lists as tabs (recipe lists).
• Recipes and data tables too: the Craftsbook's and Crafting Tables' recipes, Hunting's animals, parts, shops and ranks, the Legendaries list and the Guidebook's book can be edited the same way.
• Records: some scripts show their own records here (for example every player storage and job storage in Storage).
• Safe: changes are kept by the Land Office and reach the script at once. Your config files are never changed. Reset puts a setting back to its file, and every change is in the History (who, when, from and to).
• Links to other settings menus (such as the Poggy Hub for poggy_core) as cards on the home page.
• English, Spanish and French.

Requirements

• poggy_core 0.14.0 or newer (free; works on VORP, RSG Core and QBCore RedM).
• oxmysql.
• Britannia scripts that carry the Land Office connector (shared/landoffice.lua). Scripts show up by themselves once they have it; versions without it simply don't appear.

Install

1. Download Britannia_Land_Office.zip from the store and unzip it.
2. Put the Britannia_Land_Office folder in your server's resources folder.
3. Add ensure Britannia_Land_Office to server.cfg, after poggy_core and oxmysql. It can go before or after your Britannia scripts.
4. Restart the server. Its tables (britannia_landoffice and britannia_landoffice_history) are made for you.
5. Optional, for the Restart script button: add add_ace resource.Britannia_Land_Office command.ensure allow to server.cfg.

Items

None.

Configuration

shared/config.lua (every option is commented):

server/sv_config.lua: SvConfig.Webhook, a Discord webhook that gets a message for every change ('' = none).

Commands and permissions

• /britannia: opens the Land Office. Only staff: poggy_core admins, anyone in Config.AdminGroups, or anyone with the ace britannia.landoffice (add_ace group.admin britannia.landoffice allow).

How it works

Changing a setting. Open a script, pick a section on the left, change the value and press Save. Most changes apply at once, on the server and for every player. Things a script sets up when it starts (map blips, people standing at a spot, usable items) need the script restarted: press Restart script on its page.

Putting it back. Reset on a setting returns it to the value in the config file. Without the Land Office running, every script simply uses its config file again.

Adding a new crafting book (Craftsbook).

1. Open Craftsbook → Recipes, type the name of a new list (for example saloon) and press Add a list. Add its recipes with Add a row (item, amount, description, level, XP, time and ingredients) and save.
2. Open Books and Add a row: give it an id, the item that opens it, a title, set recipes to the list name from step 1 (saloon), and pick a ladder and an xpKey (books with the same xpKey share a level). Save.
3. The book's item must exist in your items table (your framework's items, as for any new item). Give it to yourself to try.
4. Press Restart script, so the new item becomes usable.

Adding a new crafting table (Crafting Tables).

1. Make its recipe list under Recipes, as above.
2. Open Tables and Add a row: a unique id, a label, its coords (stand at the spot and press Here), a prop model or off for an existing table on the map, recipes (the list name), ladder, xpKey, jobs (or off for everyone) and a blip if you want one. Save.
3. Press Restart script, so the table and its prop appear.

History. Every change is written to the History page (and the server console, and your webhook if you set one), with who made it and the value before and after.

For script makers. The zip has developers/landoffice.lua. Copy it into your own script as shared/landoffice.lua, load it last among its shared scripts, and your script's Config appears in the Land Office. A script can define function LandOfficeChanged() ... end to react when its settings change.

Troubleshooting

A script doesn't show

Only scripts that carry the Land Office connector appear. Update the script to its latest version from the store.

A change didn't do anything

It's probably something the script sets up when it starts. Press Restart script (it needs the command.ensure ace above), or restart the script from your console.

"Only staff can open the Land Office"

Give your staff group the ace: add_ace group.admin britannia.landoffice allow, or add the group to Config.AdminGroups.

I made a mess of a setting

Press Reset on it: it goes back to the value in the config file.

Version history

• 1.1.1: Britannia_Markets' item lists (the catalog) can be edited too.
• 1.1.0: a gold BRITANNIA banner in the server console after start-up, listing every Britannia script with its version and whether it is running.
• 1.0.0: first release.