🌌 UniRedeem

The Ultimate Universal Redeem Code Plugin for Minecraft networks.
Developed with ❤️ by the Univolve team.

UniRedeem is a modern, high-performance, multi-platform redeem code solution. It is built from the ground up to support Spigot/Paper, BungeeCord, and Velocity networks concurrently using a single Universal Jar.

---

✨ Features

• ⚡ Multi-Platform (Universal Jar): Single .jar file that runs seamlessly on Spigot, Paper, Purpur, BungeeCord, and Velocity.
• 💾 Dual-Storage Engine: SQLite (local zero-setup) and MySQL/MariaDB (network synchronization) powered by high-performance HikariCP connection pooling.
• 🔑 Limitation & Expiry System:
  • Max Global Uses: Limit how many times a code can be claimed globally.
  • Max Uses Per Player: Restrict claims per user (e.g. one-time use codes).
  • Expiration (Time-Limits): Expiry dates or countdown durations from code generation.
  • Permission Node Requirement: Require players to hold specific permissions to claim a code.
• ⚙️ Multicontext Command Rewards:
  • [CONSOLE] - Executed by console on the local server.
  • [PLAYER] - Executed by the player redeeming the code.
  • [PROXY] - Forwarded via Plugin Messaging and executed on the Proxy console (BungeeCord/Velocity).
• 🌐 Embedded HTTP REST API Server: Connect your website, Discord bot, or store portal using a secure Bearer token JSON API.
• 🧩 Extensive Placeholders: Supports local placeholders and registers natively with PlaceholderAPI (on Bukkit/Paper).

---

🛠️ Commands & Permissions

| Command | Description | Permission | Platform |
| :--- | :--- | :--- | :--- |
| /redeem <code> | Redeem a code and claim rewards. | None (default) | Bukkit, Bungee, Velocity |
| /uniredeemadmin generate <args> | Generate a custom redeem code. | uniredeem.admin | Bukkit, Bungee, Velocity |
| /uniredeemadmin revoke <code> | Deletes/revokes a redeem code. | uniredeem.admin | Bukkit, Bungee, Velocity |
| /uniredeemadmin reload | Reloads plugin configs and database. | uniredeem.admin | Bukkit, Bungee, Velocity |

Generation Example:

/uniredeemadmin generate VIP 50 1 86400 VIP_PERMISSION [CONSOLE] lp user %player_name% parent add vip; [CONSOLE] msg %player_name% Enjoy VIP!

(Generates code VIP with 50 global uses, max 1 use per player, 24-hour expiry, requiring permission VIP_PERMISSION, executing console commands separated by ;)

---

🌐 Embedded REST API

Boots an embedded JSON web server on the port defined in config.yml. Secured using Bearer Token authorization header: Authorization: Bearer <secret-token>

Endpoints

• POST /api/generate - Generate code.

  {
    "code": "SUMMER2026",
    "maxGlobalUses": 100,
    "maxUsesPerPlayer": 1,
    "durationSeconds": 604800,
    "permission": "uniredeem.claim",
    "commands": ["[CONSOLE] give %player_name% gold_ingot 10"]
  }
  

• GET /api/status/{code} - Retrieve code validity, remaining uses, and expiry details.
• DELETE /api/revoke/{code} - Manually revoke a code.

---

🧩 Placeholders

Use these variables in commands, messages, or through PlaceholderAPI integration:

• Player Related: %player_name%, %player_uuid%, %player_ip%, %player_ping%
• Code Related: %redeem_code%, %code_remaining_uses%, %code_max_uses%, %code_expiry_date%
• Server Related: %server_time%, %server_date%, %server_name%

---

🌟 Support & Dev Credits

UniRedeem is maintained and developed by the Univolve team. Please check our channels for updates, contributions, and bug reports.