Britannia_Radial_Menu

Overview

Britannia_Radial_Menu gives every player a wheel of the things they do most. Press F3 (or type /menu) and the wheel opens. Every option has a large icon and its name, and the middle of the wheel says what the option under the pointer does. It is built on poggy_core, based on Poggy's poggy_menu and sold with Poggy's permission.

• A radial wheel with submenus, and a More page when there are too many options for one ring.
• A Police submenu that only law jobs see, and a Staff submenu for admins.
• Options show only while the script they use is running, so players only see what your server has.
• 162 built-in line icons, coloured by what they are about, with no image files and nothing loaded from the internet.
• Built-in actions: reload your character's looks, stop a stuck animation, holster your weapon, show your server ID.
• Edit the menu in config.lua, or in game on a picture of the wheel (poggy_core 0.26.0 or newer).
• Other scripts can open their own wheel with the same look, or add options to yours.

Requirements

• poggy_core (free), version 0.13.0 or newer. Use 0.23.0 or newer for the Poggy theme (older versions show the default black and gold), and 0.26.0 or newer to edit the menu on the wheel in /poggy (older versions show it as a table).
• One of VORP, RSG Core or QBCore RedM (poggy_core connects the script to it).
• No database: the menu keeps nothing between sessions.

Install

1. Download Britannia_Radial_Menu from portal.cfx.re → Assets → Granted Assets.
2. Put the Britannia_Radial_Menu folder in your server's resources folder.
3. Add ensure Britannia_Radial_Menu to server.cfg, after ensure poggy_core.
4. Restart the server and press F3.

Don't run it alongside poggy_menu: both use F3 and /menu.

Configuration

The script is encrypted with Cfx.re asset escrow. config.lua and translations.lua stay editable. Most settings can also be changed in game under /poggy → Britannia Menu. Colours come from the Poggy theme (/poggy → Poggy Core → Theme).

The menu. Config.Menu is a list of options. An option with items is a submenu. Any other option does one thing: runs a command, triggers an event or serverEvent, calls an export, or runs a builtin. You choose who sees each option (jobs, minGrade, onDuty, admin, ace, resource, when), and how it behaves (confirm, cooldown, keepOpen, tone, effect). The full field list is at the top of Config.Menu. A short example:

{
    id = "call_doctor",
    label = "Call a Doctor",
    description = "Sends for a doctor to come to where you are.",
    icon = "medical",
    command = "calldoctor",
    when = "any",
    confirm = "Send for a doctor?",
    cooldown = 60,
},

The default menu points at commands from common RedM scripts, and each of those options shows only while its script runs. Point them at your own scripts' commands. To see every icon name, open ui/icons.html in a browser and click an icon to copy its name.

Commands and permissions

Give the staff ace in server.cfg:

add_ace group.moderator britannia_radial_menu.admin allow

Hiding an option is not security. Whatever it runs must check its own permissions.

How it works

Using the wheel.

Greyed-out options say why in the middle: staff only, go on duty first, ready again in 0:42 and so on.

The Police menu. Only law jobs see it. Its jobs list holds common law job names: change it to your server's. Capitals don't matter. A submenu with nothing left in it is dropped, and a submenu with only one option left becomes that option.

The Staff menu. The last option on the wheel, for framework admins and players with britannia_radial_menu.admin. It holds the admin commands of the scripts you run.

Built-in actions.

• reloadSkin: puts the saved clothes and looks back on. VORP only; on RSG Core or QBCore RedM, use your character script's reload command instead.
• stopTasks: stops an animation or action the player is stuck in. Refused while down, tied, cuffed, lassoed, falling or riding.
• holster: puts away the weapon in the player's hands.
• showId: tells the player their server ID.

Icon colours. Each icon is coloured from the theme by what it is about: law in blue, medical and alerts in red, money in gold, travel in green, social in the theme's accent, and the rest plain. Set tone on an option (or a submenu) to choose its colour.

For script authors. Other scripts can open their own wheel with the same look, or add options to the F3 menu, with the client exports exports.Britannia_Radial_Menu:Open, Update, Close, IsOpen, OpenMain, AddMainItem and RemoveMainItem. Options added with AddMainItem are removed by themselves when that script stops. The help page Using the wheel from another script (in /poggy, and in docs/help/using-from-another-script.md) has a full example.

Troubleshooting

F3 does nothing

If a player has used the menu before, F3 is a key binding they may have changed: check Settings → Key Bindings → RedM. Changing Config.Keys.OpenKey only changes the key for players new to the server. Also check that poggy_menu isn't running: both use F3.

"You cannot open the menu right now."

The menu won't open while falling or knocked over (unless Config.Open.WhenRagdoll is true), or while down if Config.Open.WhenDead is false. It also stays shut while another screen, such as chat, a shop or an inventory, has the mouse.

An option is missing

Options that need a script only show while that script is running (resource = "..."). Options can also be limited to jobs, ranks, on-duty players, admins or an ace. Add showLocked = true to show it greyed out with the reason instead.

Staff can't see the Staff menu

Give them the ace britannia_radial_menu.admin, or make them a framework admin.

"Reloading the character is not available on this server."

reloadSkin works on VORP only. On RSG Core or QBCore RedM, point that option at your character script's reload command.

The menu shows a table instead of the wheel in /poggy, or no theme colours

Editing on the wheel needs poggy_core 0.26.0 or newer, and the Poggy theme needs 0.23.0 or newer. Update poggy_core.

"That did not work." or "That is not available on this server right now."

The export behind that option failed, or its script isn't started. Check the option in Config.Menu, and that the script it uses is running.

Version history

• 1.2.0: current release. The resource, its exports, its aces and its key binding are all named Britannia_Radial_Menu (britannia_radial_menu for the aces and key binding).