SyRedEnvelope

# SyExtract A red envelope plugin for Minecraft Paper/Purpur 1.21 with Vault economy support. ## Features - Create red envelopes (set name, amount, quantity) - **Each red envelope has a unique numeric ID starting from 1 (e.g., 1, 2, 3)** - GUI interface for viewing and claiming red envelopes - **New "Create Red Envelope" button in GUI — click it and type name, amount, and count in chat** - **BossBar progress bar displayed at the top of the screen after creating a red envelope, showing remaining count in real time** - **Automatic notification to the sender when someone claims their red envelope (includes claimer name, envelope name, amount, and currency name)** - **Configurable tax-free threshold: red envelopes with total amount less than 10000 are tax-free; 2% tax for amounts of 10000 or more** - **If a red envelope is not fully claimed 1 minute after creation, a clickable reminder is sent to online players who haven't claimed it** - **Claim buttons in broadcast and reminder messages are now truly clickable** - Multi-language support (简体中文/English) - Vault economy system support - Configurable fee system - Player ban system (restrict sending/claiming red envelopes) - Red envelope expiration settings - **Unclaimed amounts are automatically refunded when red envelopes expire** - **Red envelope data is fully preserved after server restart (including amount distribution and claim records)** - Highly configurable ## Requirements - Minecraft Server: Paper/Purpur 1.21 - Java: 17 or higher - Dependencies: Vault + any economy plugin (e.g., EssentialsX) ## Commands | Command | Permission | Description | | ------------------------------------- | ------------------- | --------------------------------------- | | `/sye create <name> <amount> <count>` | syextract.create | Create a red envelope | | `/sye open` | syextract.open | Open the red envelope GUI | | `/sye broadcast <id>` | syextract.broadcast | Broadcast a red envelope to all players | | `/sye claim <id>` | syextract.claim | Claim a specific red envelope by ID | | `/sye ban <player> <time>` | syextract.ban | Ban a player | | `/sye unban <player>` | syextract.unban | Unban a player | | `/sye reload` | syextract.reload | Reload configuration | ### Command Aliases - `create` → `c` - `open` → `o` - `broadcast` → `br` - `claim` → `cl` - `ban` → `b` - `unban` → `u` - `reload` → `r` ### Time Format Ban duration supports the following formats: - `1h` - 1 hour - `1d` - 1 day - `1w` - 1 week - `30d` - 30 days ## Permissions | Permission | Default | Description | | ------------------- | ------- | --------------------------------- | | syextract.use | true | Basic usage permission | | syextract.create | true | Create red envelope permission | | syextract.open | true | Open GUI permission | | syextract.claim | true | Claim red envelope permission | | syextract.broadcast | true | Broadcast red envelope permission | | syextract.ban | op | Ban player permission | | syextract.unban | op | Unban player permission | | syextract.reload | op | Reload configuration permission | | syextract.admin | op | All admin permissions | ## Configuration ### config.yml ```yaml # Language Settings # Available values: zh (简体中文), en (English) language: zh # Red envelope settings red-envelope: # Default claim duration (hours) default-expire-hours: 24 # Minimum red envelope amount min-amount: 1.0 # Minimum red envelope count min-count: 1 # Maximum red envelope count max-count: 100 # Fee settings (charged when creating) fee: enabled: true percentage: 0.05 min-fee: 1.0 # Tax settings (charged when claiming) tax: # Tax-free threshold: red envelopes with total amount below this are tax-free threshold: 10000 # Tax rate: applied when total amount is at or above the threshold percentage: 0.02 # Economy settings economy: # Currency name (used when Vault does not provide one) currency-name: "Coins" # Reminder settings reminder: # Seconds after creation to send unclaimed reminder (default: 60) delay-seconds: 60 # GUI settings gui: item-material: "SUNFLOWER" # Broadcast message settings broadcast: envelope-completed: "&6&l🎉 Red envelope &e{name} &7has been fully claimed..." ``` ### Language Files The plugin supports multi-language through language files located in `plugins/SyExtract/lang/`: - `zh.yml` - 简体中文 (default) - `en.yml` - English You can customize all messages in these files. To switch language, change the `language` option in `config.yml`. ## Data Storage The p