Getting Started

Explore the complete guide below for setting up and managing your RankForge server.

โš’๏ธ RankForge

A modular, production-ready Minecraft rank management plugin.

Minecraft Java Version License Issues

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


โœจ 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_KILLS statistic
  • ๐Ÿชจ 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.

Tablist and Chat Formatting

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.

Rank Up Celebration Banner and Titles

In-game preview showcasing boss bar and title announcements when a player ranks up.


โš™๏ธ Requirements

RequirementMinimumRecommended
Server SoftwareSpigot 1.17Paper 1.21+
Java VersionJava 21Java 21
Minecraft Version1.17.x1.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

  1. Download RankForge-3.8.jar from the Spigot page.
  2. Drop the JAR into your plugins/ directory:
server/
โ””โ”€โ”€ plugins/
    โ””โ”€โ”€ RankForge-3.8.jar
  1. (Optional) Install Vault, LuckPerms, and/or PlaceholderAPI for extra features.
  2. Start your server. RankForge auto-generates all configuration files.