SyMessage

# SyMessage A system mailbox plugin for Minecraft Purpur/Paper 1.21+ **Author**: Shiyuan **Version**: 1.0.0 **Java Version**: 21 ## Features - 📬 **Player Mailbox GUI** - Type `/sym open` to open mailbox and view unread messages - 💰 **Reward Distribution** - Click messages to automatically claim attached currency rewards - 🔔 **Login Reminder** - Automatic reminder for unread messages after player login (configurable delay) - 👨‍💼 **Admin Panel** - `/sym op` to view message delivery status for all players - 📤 **Mass Messaging** - Send messages with rewards to all/online/specific players - 💎 **Vault Integration** - Currency rewards via Vault plugin - ⏰ **Auto Cleanup** - Automatically clean up expired messages (configurable retention days) ## Commands ### Player Commands | Command | Description | Permission | |---------|-------------|------------| | `/sym open` | Open system mailbox to view and claim unread messages | `symessage.use` | ### Admin Commands | Command | Description | Permission | |---------|-------------|------------| | `/sym send <target> <message> <coins>` | Send system message | `symessage.admin` | | `/sym op` | Open admin panel | `symessage.admin` | | `/sym reload` | Reload configuration file | `symessage.admin` | #### Target Types - `all` - All players (including offline) - `online` - Online players only - `player:username` - Specific player #### Usage Examples ``` /sym send all Server maintenance notice: Update at 22:00 tonight 50 /sym send online New event started! Come join! 100 /sym send player:Steve Your VIP renewal is successful 500 ``` ## Configuration (config.yml) ```yaml # Message retention time (days), messages older than this will be automatically cleaned up message-save-days: 30 # Cleanup task interval (hours), how often to check and clean expired messages cleanup-interval-hours: 24 # Unread message reminder delay (seconds), how long after login to remind about unread messages reminder-delay-seconds: 60 ``` ## Build & Installation ### Requirements - JDK 21+ - Maven 3.6+ ### Build ```bash mvn clean package ``` Build artifact located at `target/SyMessage-1.0.0.jar` ### Installation 1. Place `SyMessage-1.0.0.jar` into server's `plugins` directory 2. Install (https://github.com/MilkBowl/Vault) plugin and any economy plugin (e.g., EssentialsX, CMI, etc.) 3. Restart server or load plugin ## Dependencies - **Paper/Purpur 1.21+** - **Vault** (Optional, economy features unavailable without it) ## Permissions | Permission | Description | Default | |------------|-------------|---------| | `symessage.use` | Use basic commands | All players | | `symessage.admin` | Use admin commands | OP | ## File Structure ``` plugins/SyMessage/ ├── config.yml # Configuration file ├── messages.yml # Message data storage └── ... ``` ## License MIT License