Installation

This manual describes uxmEnchants after 0.1.0: German, Spanish, French, Portuguese and Russian arrive with the next release, and 0.1.0 itself reads English and Turkish.

Requirements

uxmLib is shaded into the jar, so the plugin needs nothing else on the server.

Optional plugins

The full list is on Integrations.

Installing

1. Drop uxmEnchants-<version>.jar into plugins/ and remove any older jar.
2. Start the server. The plugin writes its folder on the first boot, including twelve example enchantments.
3. Edit or add files under enchantments/, then run /uxmenchants reload.

When any content file is wrong, the reload is refused as a whole: the message names the file, the key and the line, and the server keeps the content it had. At start a broken set is reported in the console and the server starts with no enchantments.

The files

plugins/uxmEnchants/
├── config.conf            language, storage, item data, limit, routes, anvil, books, display, charges, claims, editor
├── commands.conf          the name, aliases and switch of both commands and each subcommand
├── rarities.conf          common, rare, legendary: the chance on each route and the table level
├── types.conf             normal and curse: the format, the per item limit, the grindstone rule
├── targets.conf           the item lists, the named item sets, the slots
├── vanilla.conf           how vanilla enchantments are drawn beside ours
├── enchantments/          one file per enchantment; the file name is the id
├── menus/                 wiki.conf, grouped.conf, info.conf, editor.conf, editor-list.conf, editor-enchant.conf
├── messages/              messages_<language>.conf: en, tr, de, es, fr, pt, ru
├── languages.conf         the language each player chose, when uxmLang is not installed
├── data/data.db           the SQLite file
└── backups/               the last five copies of config.conf when a release added keys
plugins/uxmTheme/
└── theme.conf             the colours and glyphs every UXM plugin reads

The template the in-game editor starts a new enchantment from, editor/new-enchantment.conf, lives in the jar and is never written into the folder.

Updating

Stop the server, replace the jar and start it. A release that adds a key writes it into your config.conf with its comment and never changes a value you wrote; your file as it was is kept in backups/. The other files are written only when they are missing, so a shipped enchantment you deleted comes back on the next start: switch it off by closing its routes instead, or keep the file and change it.

Checking the install

/uxmenchants doctor (permission uxmenchants.admin.doctor):

Troubleshooting

• A reload is refused. The message and the console name the file, the key and the line; the old content stays loaded.
• An enchantment is struck through on an item. The player lacks its node, so it does not fire for them.
• The table never offers an enchantment. The player lacks its .table node (see Acquisition), its rarity's table-chance is 0, the table level is below the rarity's minimum-level, the item is not in its table-items, or its obtaining.table is off.
• Too many enchantments come out of one table roll. Lower acquisition.table.cap or raise its reduction.
• "The item is full". /enchants limit prints the whole calculation.

Metrics

The plugin sends anonymous usage counts to bStats (plugin id 34242). Turn it off for every plugin in plugins/bStats/config.yml.

Related: Concepts, Configuration