Getting Started
Explore the complete guide below for setting up and managing your RankForge server.
โ๏ธ RankForge
A modular, production-ready Minecraft rank management plugin.
Build the rank system your server deserves โ with flexible requirements, powerful rewards, animated GUIs, cosmetics, multi-language support, a REST API, and a full developer API.
๐ Installation ยท โจ๏ธ Commands ยท ๐ Requirements ยท ๐ Rewards ยท ๐งฉ API ยท ๐ฌ Support
๐ Table of Contents
Core Navigation
โจ Introduction
RankForge is a comprehensive, enterprise-grade rank plugin for Paper and Spigot servers. It replaces brittle, script-based rankup setups with a clean YAML-driven system that is beginner-friendly yet exposes a full Java API for developers.
RankForge handles the entire lifecycle of rank progression:
- Checking a player's requirements (money, XP, playtime, mob kills, block breaks, items, quests, worlds, custom logic)
- Executing rewards when a player ranks up (commands, permissions, cosmetic effects)
- Displaying progress through animated GUIs, PlaceholderAPI placeholders, and boss bars
- Persisting data safely to YAML or MySQL with automatic cache management
- Protecting against exploits with a built-in anti-abuse system
- Serving rank data over an optional embedded REST API
๐ฏ Features at a Glance
Click to expand core feature list
Core
- ๐
Unlimited ranks defined in a single
ranks.yml - ๐ Linked-list rank chain: each rank points to the next via
next-rank - ๐ก Slot-based GUI positioning โ each rank occupies a configurable inventory slot
- ๐พ Hot-reload without server restart (
/rank reload) - ๐ง In-game rank creation, editing, and deletion via chat prompts and GUI
Requirements
- ๐ฐ Money โ Vault economy balance
- โญ XP Level โ Vanilla Minecraft experience level
- โฑ Playtime โ Tracked via real wall-clock time (independent of server TPS)
- โ๏ธ Mob Kills โ Tracked via vanilla
MOB_KILLSstatistic - ๐ชจ Block Breaks โ Exact per-player counter via a dedicated event listener
๐ฅ Tablist & Chat Formatting
RankForge natively manages and applies custom rank prefix formats across player lists and chat conversations seamlessly.
Example showing rank prefix formatting inside the server tablist.
๐ Immersive Rank-Up Celebrations
Reward successful advancements with gorgeous custom titles, bossbar announcements, and broadcast messages.
In-game preview showcasing boss bar and title announcements when a player ranks up.
โ๏ธ Requirements
| Requirement | Minimum | Recommended |
|---|---|---|
| Server Software | Spigot 1.17 | Paper 1.21+ |
| Java Version | Java 21 | Java 21 |
| Minecraft Version | 1.17.x | 1.21.4 |
RankForge is compiled targeting Java 21 and Spigot API 1.21.4. Paper is strongly recommended over Spigot for best compatibility with async features and GUI handling.
Do not use the /reload command. Always use /rank reload instead to prevent database corruption.
๐ Installation
- Download
RankForge-3.8.jarfrom the Spigot page. - Drop the JAR into your
plugins/directory:
server/
โโโ plugins/
โโโ RankForge-3.8.jar
- (Optional) Install Vault, LuckPerms, and/or PlaceholderAPI for extra features.
- Start your server. RankForge auto-generates all configuration files.