# TitleBroadcast **Advanced scheduled broadcasting plugin for Paper servers with extensive customization options** ## 🌟 Features ### 📋 **Scheduled Broadcasting System** - **Automatic broadcasts** with fully customizable intervals - **Random or sequential** broadcast ordering - **Player-based conditions** - only broadcast when players are online - **Minimum player requirements** for broadcasts ### 🎨 **Multiple Display Types** - **📺 Titles & Subtitles** with custom fade timings - **📊 Action Bars** with duration control - **💬 Chat Messages** with custom prefixes - **🔗 Combination Support** - use multiple types simultaneously ### 🔊 **Enhanced User Experience** - **🎵 Sound Effects** - fully customizable per broadcast - **✨ Particle Effects** - with count, offset, and speed controls - **🎭 Rich Text Formatting** via Adventure API & MiniMessage - **🌈 Gradients & Colors** - modern text styling support ### 🔐 **Permission-Based Broadcasting** - **Fine-grained permissions** for different broadcast types - **Per-broadcast permission** requirements - **Receive permissions** for announcements, alerts, events, tips - **Admin permissions** for management commands ### 🌍 **World Management** - **World-specific broadcasts** - different messages for different worlds - **Disabled worlds** - exclude certain worlds from broadcasts - **Per-world broadcast lists** - complete customization ### ⚡ **Performance & Compatibility** - **🔥 Folia Support** - full compatibility with Folia servers - **📦 Permission Caching** - optimized performance for large servers - **🧵 Threaded Scheduler** - uses region scheduler when available - **🔌 PlaceholderAPI Integration** - dynamic content support ## 🎮 Commands | Command | Description | Permission | |---------|-------------|------------| | `/titlebroadcast` | Main command with help | `titlebroadcast.command` | | `/titlebroadcast reload` | Reload configuration | `titlebroadcast.reload` | | `/titlebroadcast list` | List all broadcasts | `titlebroadcast.list` | | `/titlebroadcast send ` | Send specific broadcast | `titlebroadcast.send` | | `/titlebroadcast toggle` | View broadcast status | `titlebroadcast.toggle` | | `/titlebroadcast info` | Plugin information | `titlebroadcast.command` | | `/titlebroadcast next` | Show next scheduled broadcast | `titlebroadcast.list` | **Aliases:** `tb`, `broadcast`, `titlebc` ## 🔑 Permissions ### **Admin Permissions** - `titlebroadcast.command` - Use the main command - `titlebroadcast.reload` - Reload configuration - `titlebroadcast.list` - List broadcasts - `titlebroadcast.send` - Send manual broadcasts - `titlebroadcast.toggle` - Toggle broadcasts ### **Receive Permissions** *(Default: true)* - `titlebroadcast.receive.announcements` - Receive announcements - `titlebroadcast.receive.alerts` - Receive alerts - `titlebroadcast.receive.events` - Receive events - `titlebroadcast.receive.tips` - Receive tips ## ⚙️ Configuration ### **📝 camelCase Configuration** The plugin uses modern camelCase configuration throughout: ```yaml # Broadcast settings broadcastSettings: enabled: true intervalSeconds: 300 randomOrder: true onlyWhenPlayersOnline: true minimumPlayersRequired: 1 # Default display settings defaultDisplaySettings: title: enabled: true fadeInTicks: 10 stayTicks: 70 fadeOutTicks: 20 sound: enabled: true soundType: "ENTITY_EXPERIENCE_ORB_PICKUP" volume: 1.0 pitch: 1.0 ``` ### **🎨 Rich Broadcast Examples** ```yaml broadcasts: welcome: enabled: true permission: "titlebroadcast.receive.announcements" displaySettings: title: enabled: true text: "Welcome!" fadeInTicks: 20 stayTicks: 60 fadeOutTicks: 20 subtitle: enabled: true text: "Enjoy your stay!" sound: enabled: true soundType: "BLOCK_NOTE_BLOCK_CHIME" volume: 0.8 pitch: 1.2 particles: enabled: true particleType: "HEART" count: 5 ``` ## 🎯 MiniMessage Support Full support for Adventure API's powerful MiniMessage formatting: - **Gradients:** `Text` - **Colors:** `Yellow text` - **Decorations:** `Bold`, `Italic` - **Hover & Click Events:** Interactive text elements - **And much more!** ## 🔗 PlaceholderAPI Integration ### **Built-in Placeholders** - `{player}` - Player name - `{displayname}` - Player display name - `{world}` - Current world name - `{online}` - Online player count - `{tps}` - Server TPS - `{health}`, `{level}`, `{exp}` - Player stats ### **PlaceholderAPI Support** All PlaceholderAPI placeholders are supported when the plugin is installed! ## 🚀 Installation 1. **Download** the latest release 2. **Drop** the JAR file into your `plugins/` folder 3. **Restart** your server 4. **Configure** broadcasts in `config.yml` 5. **Enjoy** automated broadcasting! ## 📋 Requirements - **Paper 1.21.3+** (or compatible fork) - **Java 21+** - **PlaceholderAPI** *(optional but recommended)* ## 🛠️ Building from Source This is a private project. Source code is not available. The compiled plugin is available as `TitleBroadcast-1.0.0.jar` ## 🎪 Example Broadcasts Included The plugin comes with pre-configured broadcast examples: - **🎉 Welcome Messages** - Greet new players - **💡 Server Tips** - Helpful gameplay hints - **📜 Rules Reminders** - Keep rules visible - **🗳️ Vote Reminders** - Encourage server voting - **🎊 Event Announcements** - Promote special events ## 📞 Support Need help? Join our Discord server: - **Discord:** [https://discord.gg/yUghaxRSZs](https://discord.gg/yUghaxRSZs) --- *Made with ❤️ for the Minecraft community*