ShinobuRankup

--- ## 📋 Overview **ShinobuRankup** is a premium, high-performance rankup plugin built with **Kotlin** for modern Paper servers. It provides an elegant and smooth ranking experience with stunning animated GUIs, async database operations, and complete customization. Whether you're running a survival server, prison, skyblock, or any economy-based gamemode, ShinobuRankup delivers everything you need for an engaging progression system. **Warning: FREE VERSION LIMIT 15 RANKS, NO /RANKUPMAX COMMAND. Buy Premium version (Unlock ALL) [URL] COMING SOON** --- ## ✨ Features

### 🎮 Core Features - ✅ Unlimited custom ranks - ✅ Beautiful animated GUIs - ✅ Prestige system - ✅ Leaderboard with pagination - ✅ RankupMax command - ✅ Confirmation GUI	### ⚡ Performance - ✅ Kotlin coroutines (non-blocking) - ✅ HikariCP connection pooling - ✅ Smart caching system - ✅ Async database operations - ✅ Optimized queries
### 🎨 Customization - ✅ 100% configurable messages - ✅ Custom GUI layouts - ✅ Particles & sound effects - ✅ Titles & action bars - ✅ Broadcast messages - ✅ Multi-language support	### 💾 Storage - ✅ SQLite (zero config) - ✅ MySQL/MariaDB support - ✅ BungeeCord/Velocity ready - ✅ Auto-migration

--- ## 📥 Installation 1. Download the latest release from [Releases](../../releases) 2. Place `ShinobuRankup.jar` in your `plugins/` folder 3. Install required dependencies: - [Vault](https://www.spigotmc.org/resources/vault.34315/) - Any economy plugin (EssentialsX, CMI, etc.) 4. Restart your server 5. Configure in `plugins/ShinobuRankup/` ### Requirements | Requirement | Version | |-------------|---------| | Server | Paper, Purpur, or Folia | | Minecraft | 1.20 - 1.21.x | | Java | 17 or higher | | Vault | Latest | ### Optional Dependencies - **PlaceholderAPI** - For placeholders support - **LuckPerms** - For permission rewards --- ## 📝 Commands ### Player Commands > No permissions required - Available to all players! | Command | Aliases | Description | |---------|---------|-------------| | `/rankup` | `/ru`, `/upgrade` | Rank up to the next level | | `/rankupmax` | `/rumax`, `/maxrankup` | Rank up as many times as you can afford | | `/ranks` | `/rank`, `/progression` | Open the ranks GUI | | `/rankuptop` | `/ranktop`, `/leaderboard` | View the top players leaderboard | ### Admin Commands > Requires `shinoburankup.admin` permission (OP by default) | Command | Description | |---------|-------------| | `/shinobu reload` | Reload all configurations | | `/shinobu setrank ` | Set a player's rank | | `/shinobu reset ` | Reset a player's progression | | `/shinobu info ` | View player information | | `/shinobu give [amount]` | Give free rankups | --- ## 🔐 Permissions ### Player Permissions All enabled by default for every player: | Permission | Description | Default | |------------|-------------|---------| | `shinoburankup.rankup` | Use /rankup | `true` | | `shinoburankup.rankupmax` | Use /rankupmax | `true` | | `shinoburankup.rank` | Use /ranks GUI | `true` | | `shinoburankup.top` | View leaderboard | `true` | ### Admin Permissions | Permission | Description | Default | |------------|-------------|---------| | `shinoburankup.admin` | All admin commands | `op` | | `shinoburankup.admin.reload` | Reload config | `op` | | `shinoburankup.admin.setrank` | Set player ranks | `op` | | `shinoburankup.admin.reset` | Reset players | `op` | | `shinoburankup.admin.give` | Give free rankups | `op` | ### Bypass Permissions | Permission | Description | |------------|-------------| | `shinoburankup.bypass.cooldown` | Bypass rankup cooldown | | `shinoburankup.bypass.cost` | Free rankups | | `shinoburankup.bypass.requirements` | Skip requirements | --- ## ⚙️ Configuration ``` plugins/ShinobuRankup/ ├── config.yml # Main settings ├── ranks.yml # Rank definitions ├── messages.yml # Broadcast & effects ├── gui.yml # GUI customization ├── data.db # SQLite database └── lang/ ├── en.yml # English └── es.yml # Spanish ``` ### Example Rank Configuration ```yaml ranks: A: display-name: "Rank A" cost: 1000 order: 1 material: COAL lore: - "&7The beginning of your journey" - "&7Cost: &a$1,000" commands: - "lp user %player% parent set rankA" broadcast: true B: display-name: "Rank B" cost: 5000 order: 2 material: IRON_INGOT lore: - "&7Moving up!" - "&7Cost: &a$5,000" commands: - "lp user %player% parent set rankB" ``` --- ## 🔗 PlaceholderAPI Integrate with any plugin using these placeholders: | Placeholder | Description | |-------------|-------------| | `%shinobu_rank%` | Current rank display name | | `%shinobu_rank_id%` | Current rank ID | | `%shinobu_rank_order%` | Current rank position | | `%shinobu_next_rank%` | Next rank display name | | `%shinobu_next_rank_cost%` | Cost to next rank | | `%shinobu_progress%` | Progress percentage | | `%shinobu_progress_bar%` | Visual progress bar | | `%shinobu_total_ranks%` | Total number of ranks | | `%shinobu_is_max_rank%` | true/false if max rank | | `%shinobu_rankups_count%` | Total rankups completed | | `%shinobu_total_spent%` | Total money spent | | `%shinobu_leaderboard_pos%` | Leaderboard position | --- ## 🖼️ Screenshots --- ## 🛠️ Building from Source ```bash NO OPEN SOURCE ``` --- ## 📞 Support Need help? Found a bug? Have a suggestion? - 🐛 [Issue Tracker](../../issues) - 💬 [Discord Server](https://discord.com/invite/4crMdptpP6) --- ## 📄 License This project is proprietary software. See [LICENSE](LICENSE) for details. - ❌ Do not redistribute or resell - ❌ Do not decompile or modify - ❌ Do not claim as your own ---