DUXPLIMA Documentation

Installation

Requirements, the three jars, optional plugins, the first start and the files that appear.

uxmBedrock is three jars with uxmLib inside them. This manual describes uxmBedrock 0.1.0.

Requirements

RequirementDetail
Java25 or newer on the Paper server; 21 or newer on the proxy and for Geyser Standalone
ServerPaper or Folia 26.2, 26.3 or 26.4, or a fork of Paper. Another version stops the plugin at start with a console line
FloodgateRequired on every Paper server: it tells which players are on Bedrock
GeyserOn the same server (Geyser-Spigot), on the Velocity proxy, or Geyser Standalone
DatabaseNone for one server: SQLite is built in. MySQL, MariaDB or PostgreSQL for a network

The database drivers are downloaded on the first start, so the first start needs internet access. The first pack build also fetches the Java client's font once from Mojang's download service and keeps it in cache/.

The jars

JarGoes inFor
uxmBedrock-<version>.jarevery Paper server's plugins/Everything in this manual
uxmBedrock-Geyser-<version>.jarGeyser's extensions/ folder, wherever Geyser runsServing the pack per player, registering items, blocks and heads
uxmBedrock-Velocity-<version>.jarthe proxy's plugins/Geyser on the proxy: one pack made from every server, and proxy command completion. See A network

Optional plugins

PluginAdds
PlaceholderAPIThe placeholders
Nexo, ItemsAdder, Oraxen, CraftEngineTheir built packs are found and converted
BetterHud, MythicHUD, HappyHUD, CustomNameplates, CustomFishing, LuxDialoguesTheir packs are converted and their HUD is drawn on Bedrock
uxmLangOne language choice for every UXM plugin

Installing

  1. Drop uxmBedrock-<version>.jar into plugins/ beside Floodgate.
  2. Put uxmBedrock-Geyser-<version>.jar into Geyser's extensions/ folder (plugins/Geyser-Spigot/extensions/ when Geyser runs on the server).
  3. Start the server. The plugin writes its folder and builds the first pack.
  4. Run /uxmbedrock status to see what runs where, and /uxmbedrock pack report to see what the build found.
  5. Restart Geyser once after the first build, so it loads the custom items, blocks and heads.

The files

plugins/uxmBedrock/
├── config.conf      language, server name, storage, network, modules, player choices, preview page
├── text.conf        exact colours and the glyph pages
├── menus.conf       which menus of other plugins open as forms
├── pack.conf        how the Bedrock pack is built
├── gui.conf         menu pictures and the changes to Bedrock's screens
├── items.conf       the vanilla item under an item model the packs do not say
├── commands.conf    the name, aliases and switch of every command
├── messages/        one file per language
├── backups/         the last five copies of config.conf, kept when a release adds keys
├── data/            bedrock.db, the SQLite database
├── cache/           the Java client's font, fetched skins and past builds
└── output/          the build Geyser serves: packs, mappings, choices, heads, report.txt
../uxmTheme/theme.conf   the colours every UXM plugin shares

Checking the install

CommandSays
/uxmbedrock statusFloodgate and Geyser versions, where the pack goes, the network, the pack's size and build time, every switch
/uxmbedrock doctorOne line per thing that can be wrong: Floodgate, the Bedrock players online, the pack
/uxmbedrock pack reportWhat the last build converted and what it left out