DocsStart here

Installation

Requirements, install steps, files created and migrating from Lusik's RankedSMP.

Requirements

RequirementSupported
Minecraft serverPaper 1.21.1+ or a compatible Paper fork. Folia is supported.
Java21+

RankedSMPX uses Paper's plugin loader and downloads its runtime libraries from Maven Central at startup. Let the server reach Maven Central on the first start.

Some features need a newer Minecraft version:

FeatureMinimum
Dragon Egg locator (locator bar)1.21.6
Diamond Spear1.21.11

Install

  1. Stop the server.
  2. Download the latest jar from Modrinth.
  3. Put it in plugins/.
  4. Start the server and check the console for RankedSMPX errors.
  5. Run /rsmp start when players are ready.

Files created

Everything lives in plugins/RankedSMPX/.

FilePurpose
config.ymlSeason rules, display, health, inventory, sounds, integrations, database
ranks.ymlOne row per rank: perks and tab labels
items.ymlHierarchy Hammer, Diamond Spear, Dragon Egg locator
messages.ymlEvery in-game message
discord.ymlOptional Discord bot
custom.ymlExperimental rank-drop item (off by default)
rankedsmp.dbSQLite database (when database.type: sqlite)
backups/Copies made before a config migration

Optional integrations

PluginAdds
PlaceholderAPI%rankedsmp_*% placeholders
TABRGB and MiniMessage tab prefixes
LuckPermsrankedsmp:rank and rankedsmp:ranked contexts
Geyser + FloodgateBedrock player support

The Discord bot is built in. No separate Discord plugin is needed.

Moving from Lusik's RankedSMP

Use /rsmp migrate to import ranks and extra inventories. Full steps: Migrating from RankedSMP.

Updating

Back up plugins/RankedSMPX/, replace the jar and restart. Older layouts are migrated automatically and the old files go to backups/. New options are added to your files while your values and comments are kept. See Upgrading.

Report a docs problem Based on RankedSMPX 3.0.0