---

中文（简体） | English

Introduction

A modern, lightweight, and highly customizable gift code/redeem code plugin for Minecraft servers.

GiftCode allows server administrators to generate unique gift codes. Players can redeem these codes to receive items, in-game currency, or execute specific commands. The plugin fully supports MiniMessage formatting, enabling vibrant and stylish messages with colors and gradients!

Supported Versions

• 1.20.1+ (Paper, Folia)

✨ Key Features

• Rich Text Support: Fully utilizes modern MiniMessage syntax (supports <gradient>, <✨>, etc.).
• Flexible Reward System: Supports executing console commands, giving items, or granting temporary permissions.
• Comprehensive Restrictions: Set global usage limits, per-player usage limits, or expiration dates for each gift code.
• High Performance: Utilizes asynchronous tasks for data storage, ensuring no impact on the main server thread (TPS).
• Developer API: Provides a complete API for deep integration with other plugins.

📥 Installation Guide

1. Go to the Releases page and download the latest GiftCode-x.x.x.jar.
2. Place the downloaded .jar file into your server's plugins folder.
3. Restart the server to generate the default configuration files.
4. Modify config.yml as needed, then use /gc reload to reload the configuration.

🚀 Commands & Permissions

Command	Description	Permission Node
/gc <code>	Redeem a gift code	giftcode.use (Default)
/gc create <item/cmd> ...	Create a new gift code	giftcode.admin
/gc hand ...	Edit a specified gift code	giftcode.admin
/gc delete <code>	Delete a specified gift code	giftcode.admin
/gc clear	Clear expired and invalid codes	giftcode.admin
/gc list	List all gift codes	giftcode.admin
/gc reload	Reload the configuration file	giftcode.admin

🛠️ Building from Source

To compile this project locally, you will need JDK 17+ and Maven:

git clone https://github.com/wunanc/GiftCode.git
cd GiftCode
mvn clean package

📄 LICENSE

This project is under the MIT license - see the LICENSE document for details.

👥 AUTHOR

• wunanc | Hotguo - Main developer

🙏 THANKS

Thank you to all the developers and users who contributed to this project!

📞 Support and feedback

• 🐛 Report Bug
• 💡 Feature suggestions
• 🐧 QQ Group
• 📧 Contact authors: via GitHub Issues

---