What is YKRanks?

YKRanks is a lightweight yet powerful rank progression plugin inspired by Rankup3. It gives your server a complete rank ladder system where players progress through ranks by completing configurable requirements — such as earning money, mining resources, gaining XP levels, or holding specific items. Each rank can grant rewards like commands, items, permissions, and special effects.

Beyond simple ranking, YKRanks includes a prestige system that lets players reset their rank back to the start in exchange for a permanent prestige level with its own bonuses. An auto rank-up feature checks players periodically and advances them instantly when they qualify, while a clickable chat prompt nudges them with RANKUP and DECLINE buttons on join and at configurable intervals.

Fully editable rank lists and confirmation dialogs with per-item click actions, placeholders, and permission-based view requirements. Messages ship in 4 languages out of the box and any new language is just a copied file away. Progress bars, PlaceholderAPI placeholders, Vault economy and permission integration, HikariCP-backed SQLite storage, and a rich reward system make YKRanks a complete, production-ready solution for rank progression on any modern Minecraft server.

---

Features

Feature	Description
Rank Progression	Unlimited ranks with custom requirements (money, XP, items, levels, permissions, placeholders) and rewards
Prestige System	Reset to rank 1 with a permanent prestige level, custom requirements and rewards per tier
Auto Rank-Up	Automatically rank up players when requirements are met, with configurable check interval
Clickable Chat Prompt	Shows a [RANKUP] / [DECLINE] clickable message on join and at intervals
DeluxeMenus-Style GUI	Fully configurable rank list and confirmation menus via YAML
Multi-Language	Ships with English, Spanish, French and German — add any language by copying a file
Progress Bars	Configurable ■■■■■□□□□□ bars for GUIs, chat, and scoreboards
PlaceholderAPI	10+ placeholders for ranks, prestige, progress and eligibility
Rewards & Effects	Commands, messages, items, permissions, sounds, titles, firework, and broadcasts
SQLite + HikariCP	Fast async database with WAL mode

---

Requirements

Dependency	Status
Spigot / Paper 1.21+	Required
Vault	Required (economy)
PlaceholderAPI	Optional

---

Installation

1. Drop YKRanks-1.0.0.jar into your server's plugins/ folder
2. Install Vault and an economy plugin (e.g. EssentialsX)
3. Start the server — YKRanks generates all config files automatically
4. Edit rankups.yml to define your ranks and requirements
5. Run /ykranks reload and you're ready to go

---

Configuration Files

File	Purpose
config.yml	Main settings — cooldown, auto rank-up, progress bar, prompt intervals
rankups.yml	Rank definitions, requirements and rewards
prestiges.yml	Prestige ladder and rewards
menus/rankups.yml	Rank list GUI — DeluxeMenus-style with click actions
menus/confirmation.yml	Rank-up confirmation GUI
messages/	Per-language message files (en, es, fr, de)

---

Commands

Command	Description	Permission
/rankup	Rank up to the next rank	ykranks.use
/rankups	Open the rank list GUI	ykranks.use
/prestige	Prestige — reset rank, gain prestige level	ykranks.prestige
/ykranks reload	Reload all configuration files	ykranks.reload
/ykranks admin set <player> <rank>	Set a player's rank	ykranks.admin
/ykranks admin give <player> <amount>	Give money to a player	ykranks.admin
/ykranks admin reset <player>	Reset a player to the first rank	ykranks.admin

---

PlaceholderAPI Placeholders

Placeholder	Description
%ykranks_rank%	Current rank display name
%ykranks_rank_id%	Current rank ID
%ykranks_rank_number%	Current rank number (1-indexed)
%ykranks_prestige%	Current prestige level
%ykranks_next_rank%	Next rank display name
%ykranks_can_rankup%	true if eligible to rank up
%ykranks_max_rank%	true if at the highest rank
%ykranks_rankup_requirements%	Formatted requirement list for next rank
%ykranks_progress%	Requirement completion percentage (0-100)
%ykranks_progress_bar%	Visual progress bar

---

Example Rank Setup

rankups:
  starter:
    name: "&aStarter"
    material: "WOODEN_SWORD"
    permission: "group.starter"
    requirements:
      - "money:500"
      - "level:5"
    rewards:
      - "command:give %player% bread 16"
      - "message:&6Welcome to the server!"

  miner:
    name: "&eMiner"
    material: "IRON_PICKAXE"
    permission: "group.miner"
    requirements:
      - "money:2000"
      - "xp_level:10"
      - "item:DIAMOND:16"
    rewards:
      - "command:give %player% iron_ingot 32"
      - "sound:ENTITY_PLAYER_LEVELUP"
      - "title:&6&lMiner&7&l!&r&7You are now a Miner"

---