Rank Shop v1.0

# RankShop Plugin
A feature-rich rank purchasing plugin for Paper 1.21.x with full LuckPerms and CoinsEngine integration, a beautiful in-game GUI, and a fully configurable rank system.
---
## Features

• Beautiful in-game GUI with rank icons, descriptions, and purchase buttons
• Each rank shows exactly what it unlocks (fully configurable in config.yml)
• LuckPerms integration — automatically assigns the correct group on purchase
• CoinsEngine integration — uses CoinsEngine currencies for prices
• Rank upgrade system — require players to own a lower rank before buying a higher one
• Confirm purchase screen to prevent accidental buys
• Three economy backends: CoinsEngine, Vault, or built-in YAML storage
• Fully configurable: ranks, prices, GUI layout, sounds, messages
• Admin reload command (/rankreload) — reloads config AND economy backend, no restart needed
• Title popup shown on successful purchase
• Console commands run on purchase (for custom rewards)

---



## Commands
| Command | Permission | Description |
|---------|-----------|-------------|
| /rank | rankshop.use | Opens the rank shop GUI |
| /rankshop | rankshop.use | Alias for /rank |
| /rankreload | rankshop.admin | Reloads config + economy backend |
---
## Permissions
| Permission | Default | Description |
|-----------|---------|-------------|
| rankshop.use | Everyone | Open the rank shop |
| rankshop.admin | OP | Use admin commands |
| rankshop.bypass | OP | Bypass rank requirements |
---
## Economy Setup
### CoinsEngine (Recommended)
Set in config.yml:
1. Install CoinsEngine on your server.
2. Create a currency in CoinsEngine (e.g. id: coins).
3. Set currency-id in RankShop config to match the CoinsEngine currency ID.
4. Run /ce currencies in-game to list all available currency IDs.
5. Run /rankreload to apply.
CoinsEngine will handle all balance display/formatting automatically using its own currency settings.
### Built-in Economy (No extra plugins)
Balances are saved in plugins/RankShop/balances.yml. Give coins by editing that file directly (UUID as key, balance as value).
### Vault Economy
Requires Vault + any Vault-compatible economy plugin (EssentialsX, CMI, etc.).
---
## Adding a Rank
In config.yml under ranks::
Command placeholders: {player} = player name, {rank} = rank ID
---
## Rank Upgrade Chain
---
## GUI Slot Layout (6 rows = 54 slots)
Slot 4 = title beacon (reserved). Border slots are decorative.
Best rank slots: 10, 12, 14, 16, 22, 28, 30, 32, 34, 40
---
## LuckPerms Setup
The plugin automatically adds players to the correct group when they buy a rank.
---
## Sounds Reference
Common Paper sound names:

• UI_BUTTON_CLICK — click
• ENTITY_PLAYER_LEVELUP — level up
• ENTITY_VILLAGER_NO — error
• BLOCK_NOTE_BLOCK_PLING — pling

---
## 1.21.x Compatibility
The api-version: '1.21' in plugin.yml covers all 1.21.x Paper versions (1.21, 1.21.1, 1.21.3, 1.21.4, and future releases). The plugin avoids any APIs that were removed or changed between minor 1.21.x versions.