In-game settings

/exylialib config opens every Exylia plugin's settings as screens, drawn from the same records the web editor edits. The plugin writes no menu code. Players only: the console is pointed at /exylialib editor.

Clicking needs exylialib.config (op by default).

The screens

1. Plugins: one book per plugin, marked Problems when its files hold any.
2. A plugin's files: one card per settings file and content file. Skipped with a single file.
3. A file's pages: one card per page, showing its first four values live. Skipped with a single page.
4. A page: one button per key; a nested section is a button opening its own page.

Without annotations a file is grouped the way it is written: root keys on a General card, each section on a card of its own, each map or list of entries on a card that opens the list.

Which files

Every settings file of an enabled Exylia plugin that is not a translation, is not covered by a web editor subject and was not excluded by the plugin. Messages and menus are not shown. Content catalogues a plugin registers with WebEditor.of(plugin).yaml(id, path) follow, each with its own checker that refuses only what the plugin would not load.

Your own settings screens

ConfigEdits (net.exylia.lib.config, since 1.555.0) is the plumbing; the plugin writes the screen (an ordinary admin menu) and decides what is on it. Each card is written by the plugin for what the value does; the library writes the rest in the server's language: the current value, its default and the click lines.

ConfigEdits fees = ConfigEdits.of(plugin, AuctionHouseDefaults::file);
 
// every editable key as a live value, such as %ah_settings_listing_fee_percent%
menus.open(admin, "menus/admin/settings_ah", fees.placeholders("ah_"));
 
// one action for every card
actions.registerSync("setting", "myplugin.admin.settings", (ctx, args) -> {
    fees.card(ctx.player(), args.string(1, ""), ctx.get(UiKeys.CLICK).orElse(null), () -> reopen(ctx.player()));
    return ActionResult.success();
});

Every change is checked against @Menu.Range, AtLeast and AtMost, written with ConfigFile.set (comments and order kept) and followed by the plugin's Reloads.

The record's annotations decide how a value reads (1.562.0):

• @Menu.Format(value = MONEY, currency = "currency") shows the amount in the currency the sibling key names.
• @Menu.Currency on a text key opens a pick from the server's currencies.
• @Menu.Material on a List<String> asks to add an item (the icon picker), remove one or edit as text.

What goes on a settings screen and what stays in the file:

• In game: what an admin changes while the server runs: fees, taxes, limits, prices, durations, switches, blocked items, currencies, module switches.
• In the file: database and network, intervals, sounds, debug, anti-abuse thresholds, layout numbers.
• Shape: an admin hub card opens a settings hub with one card per module, each opening a sub-page of hand-written cards. Module switches apply on the next restart, and the hub says how many changes wait (PluginModules.pendingRestart()).

The repository's tools/settings-cards/settings_cards.py turns a short spec (key, label, icon, two or three lines) into the English YAML of a hub and its pages, ready to translate.

The generic tree for developers

A plugin can add a Settings button to its own admin hub and keep BACK pointing at it:

ConfigMenus.of(plugin)
        .permission("myplugin.admin")   // may edit its files, besides exylialib.config
        .back(hub::open)
        .open(player);

Optional Menu annotations on the record give labels, ranges and formats. The list of every plugin always needs exylialib.config.

ConfigMenus.of(plugin).permission(p).back(b).file(name).open(viewer) opens one settings file straight away, by the name handed to Configs.define (such as modules/hotbar/config). That file is then the top screen: BACK runs back(...) and the button reads Previous screen. A name the plugin did not define, or one whose module is off, opens the plugin's settings as if no file had been asked for.