---

📢 EnderAnnounce2 - Wiki

A lightweight and powerful announcement plugin for Minecraft with full color support, automatic announcements, and customizable formats.

---

📋 Table of Contents

1. 🎯 Features
2. ⚡ Quick Installation
3. 🎮 Commands
4. 🔧 Configuration
5. 🎨 Color Formats
6. ⏰ Automatic Announcements
7. 🔒 Permissions
8. 📖 Practical Examples
9. ❓ FAQ
10. 🆘 Support

---

🎯 Features

✨ Advanced Color Formats

• Legacy Colors: &a, &b, &c, etc.
• Hex Colors: &#ff0000, #00ff00, etc.
• MiniMessage: <red>, <gradient:#ff0000:#00ff00>, <rainbow>, etc.

🚀 Predefined Announcement System

• Configurable announcements from the config file
• Unique and customizable formats for each announcement
• Dynamic placeholders ({player})

⏱️ Automatic Announcements

• Customizable timers per announcement
• Smart system (only sends if players are online)
• Full control from the config

🎵 Sound System

• Customizable sounds per announcement
• Adjustable volume and pitch
• Compatible with all Minecraft sounds

🔧 Flexible Configuration

• Intuitive config file
• Hot reload without server restart
• Fully customizable messages

---

⚡ Quick Installation

📥 Step 1: Download

1. Download the EnderAnnounce2.jar file
2. Make sure you have Java 8+ and Minecraft 1.16.5+

📁 Step 2: Install

1. Place the JAR file in your server's plugins/ folder
2. Restart or reload the server
3. The config.yml file will be generated automatically

⚙️ Step 3: Configure

1. Edit plugins/EnderAnnounce2/config.yml as needed
2. Run /announceconfig reload to apply changes

---

🎮 Commands

👥 For Players

/announce <name>

Sends a predefined announcement to all online players.

Examples:

/announce welcome    → Sends welcome announcement
/announce rules      → Sends rules announcement
/announce list       → Lists all available announcements

🔧 For Administrators

/announceconfig <option>

Manages plugin configuration.

Available options:

/announceconfig reload          → Reloads configuration
/announceconfig toggle          → Enables/disables the plugin
/announceconfig list            → Lists available announcements
/announceconfig auto status     → View status of automatic announcements
/announceconfig auto toggle     → Enable/disable automatic announcements

---

🔧 Configuration

📄 config.yml Structure

# General settings
settings:
  enabled: true                    # Enable/disable plugin
  play_sound: true                 # Global sounds
  
  # Automatic announcement system
  auto_announcements:
    enabled: true                  # Enable automatic announcements
    debug: false                   # Debug logs

# Predefined announcements
announcements:
  announcement_name:
    format: |                      # Announcement format (multiline)
      <gradient:#ff6b6b:#4ecdc4>Decorative text
      <white>{message}
    sound:                         # Sound configuration
      enabled: true
      type: "entity.experience_orb.pickup"
      volume: 1.0
      pitch: 1.0
    auto:                         # Automatic configuration
      enabled: true               # Auto send?
      interval: 300               # Interval in seconds

# System messages
messages:
  no_permission: "<red>No permission!"
  config_reloaded: "<green>Configuration reloaded!"
  # ... more messages

⏰ Automatic Announcements

🔄 Timer Configuration

Each announcement can be set to send automatically:

announcements:
  my_announcement:
    format: "My message"
    auto:
      enabled: true          # Enable auto send
      interval: 600          # Every 10 minutes (in seconds)

🎛️ Controlling Automatic Announcements

# Enable/disable entire system
/announceconfig auto toggle

# Reload config and timers
/announceconfig reload

---

🔒 Permissions

👥 Main Permissions

Permission	Description	Default
enderannounce.announce	Send announcements	OP
enderannounce.admin	Configure plugin	OP
enderannounce.*	All permissions	OP

❓ FAQ

🤔 How do I add a new announcement?

1. Open plugins/EnderAnnounce2/config.yml
2. Add a new section under announcements:
3. Run /announceconfig reload

Example:

announcements:
  my_new_announcement:
    format: "<green>My custom message"
    sound:
      enabled: true
      type: "entity.experience_orb.pickup"
      volume: 1.0
      pitch: 1.0
    auto:
      enabled: false

🤔 How do I disable a specific automatic announcement?

Set auto.enabled to false in the corresponding announcement:

announcements:
  my_announcement:
    auto:
      enabled: false  # ← Change this
      interval: 300

🤔 Do colors work on all versions?

Format	1.16.5+	1.20+	Limitations
Legacy (&a)	✅	✅	None
Hex (&#ff0000)	✅	✅	None
MiniMessage basic	✅	✅	None
MiniMessage adv.	⚠️	✅	Some features

🤔 How do I change the time interval?

The interval is set in seconds:

auto:
  interval: 1800  # 30 minutes
  # 60 = 1 minute
  # 300 = 5 minutes  
  # 600 = 10 minutes
  # 1800 = 30 minutes
  # 3600 = 1 hour

🤔 Can I use emojis in announcements?

Yes! Emojis work perfectly:

format: |
  🎉 Welcome! 🎉
  🎮 Enjoy the game! 🎮
  ⭐ You are awesome! ⭐

🆘 Support

📝 Before Reporting a Problem

1. Check your version:

   • Are you using Minecraft 1.16.5 - 1.21.x?
   • Do you have Java 8 or higher?

2. Review your configuration:

   • Is your YAML formatted correctly?
   • Did you reload after changes?

3. Check the logs:

   • Review logs/latest.log for errors
   • Enable debug: true for more info

🐛 Common Issues and Solutions

❌ "Plugin not working"

# Check if the plugin is loaded
/plugins

# If it appears in red, check the logs:
# logs/latest.log

❌ "Colors not showing"

# Make sure to use the correct format:
# ✅ Correct:
format: "<red>Red text"

# ❌ Incorrect:
format: "\<red\>Red text"

❌ "Automatic announcements not sending"

# Check your configuration:
settings:
  auto_announcements:
    enabled: true  # ← Should be true

announcements:
  my_announcement:
    auto:
      enabled: true  # ← Should be true
      interval: 300  # ← Greater than 0

📜 Additional Information

🔄 Updates

• ✅ Guaranteed compatibility 1.16.5 - 1.21.x
• ✅ Automatic config updates
• ✅ Backward compatibility maintained

📊 Performance

• ⚡ Ultra lightweight (<1MB RAM)
• ⚡ No server lag
• ⚡ Asynchronous config loading

🔐 Security

• 🛡️ Permission validation
• 🛡️ Spam prevention
• 🛡️ Secure default configuration

---

Thank you for using EnderAnnounce2! A plugin made with ❤️ for the Minecraft community.