💬 AuryxChat - Advanced Chat Management System

AuryxChat is a powerful, feature-rich chat management plugin designed as a modern alternative to EssentialsX Chat. Built for Paper, Folia, and other modern Minecraft platforms with advanced formatting, moderation, and cross-version compatibility.

---

✨ Key Features

💬 Advanced Chat System

• Local & Global Chat - Radius-based local chat with global override
• Chat Mode Toggle - Easy switching between local/global modes
• Visual Indicators - [L] and [G] prefixes show current chat mode
• Force Global - Use ! prefix to send global messages from local mode

🎨 Rich Formatting

• Custom Chat Formats - Per-group chat formatting (Admin, VIP, Default)
• Color Support - Full legacy color code support (&c, &a, etc.)
• Placeholder Integration - PlaceholderAPI and AuryxCore placeholders
• Hover Text - Rich hover information with player stats

🛡️ Chat Moderation

• Word Filter - Configurable word/phrase blocking with regex support
• Anti-Spam - Intelligent spam detection and prevention
• Mute Integration - Full integration with AuryxCore mute system
• Action Logging - Comprehensive moderation logging

🔔 Player Mentions

• @Player Mentions - Highlight and notify players when mentioned
• Sound Notifications - Configurable mention sounds
• Visual Highlighting - Mentioned players see highlighted messages

---

🎮 Commands Overview

Command	Description	Permission
/auryxchat	Main plugin command	auryxchat.admin
/auryxchat reload	Reload configuration	auryxchat.reload
/auryxchat about	Plugin information	auryxchat.use
/auryxchat announce <msg>	Server announcement	auryxchat.announce
/chat toggle	Toggle chat mode	auryxchat.toggle
/chat local	Switch to local chat	auryxchat.local
/chat global	Switch to global chat	auryxchat.global
/chat status	Check current mode	auryxchat.use

---

🎯 Chat Modes Explained

🏠 Local Chat

• Radius-based - Only players within configured range can see messages
• Prefix: [L] (Green, Bold)
• Default Range: 100 blocks (configurable)
• Perfect for: Roleplay servers, survival gameplay

🌍 Global Chat

• Server-wide - All online players receive messages
• Prefix: [G] (Red, Bold)
• Always Available - Use ! prefix to force global from local mode
• Perfect for: Announcements, general discussion

⚡ Quick Global Override

# In local mode:
Hello nearby players          → [L] Player: Hello nearby players
! Hello everyone on server    → [G] Player: Hello everyone on server

---

🎨 Chat Format Examples

Default Player

[L] [Member] Sqrilizz: Hello world!

VIP Player

[G] [VIP] ProPlayer: Check out my base!

Admin

[G] [Admin] ServerOwner: Welcome to the server!

---

🛡️ Moderation Features

Word Filter

• Regex Support - Advanced pattern matching
• Custom Actions - Block, replace, or warn
• Bypass Permission - auryxchat.filter.bypass
• Real-time Updates - No restart required for filter changes

Anti-Spam Protection

• Message Similarity - Detects repeated messages
• Rate Limiting - Configurable cooldown periods
• Smart Detection - Ignores case and spacing variations
• Automatic Warnings - Progressive punishment system

Mute Integration

• AuryxCore Sync - Seamless integration with AuryxCore mutes
• Command Blocking - Prevents muted players from using chat commands
• Bypass Permissions - Staff can always communicate

---

🔧 Installation & Setup

Requirements

• AuryxCore - Required for full functionality
• Java 21+ - Recommended version
• Paper 1.8.8+ - Or compatible server platform

Installation Steps

1. Install AuryxCore first (dependency)
2. Download AuryxChat from Modrinth
3. Place JAR in your plugins/ folder
4. Restart server to generate configuration
5. Configure settings in plugins/AuryxChat/

Optional Dependencies

• PlaceholderAPI - Enhanced placeholder support
• VaultUnlocked - Permission group prefixes
• LuckPerms - Advanced permission integration

---

⚙️ Configuration Highlights

Chat Formats (config.yml)

chat:
  formats:
    default: "&7[{chat_prefix}] &7[&f%luckperms_prefix%&7] &f<player>: &f<message>"
    admin: "&7[{chat_prefix}] &c[Admin]&r <player>: &e<message>"
    vip: "&7[{chat_prefix}] &a[VIP]&r <player>: &b<message>"
  
  prefixes:
    local: "&a&lL&r"    # Green [L]
    global: "&c&lG&r"   # Red [G]

Local Chat Settings

local:
  enabled: true
  radius: 100.0
  default-mode: "local"

Filter Configuration (filters.yml)

filters:
  enabled: true
  action: "block"  # block, replace, warn
  words:
    - "badword"
    - "spam.*pattern"
  replacement: "***"

---

🌐 Platform Compatibility

Platform	Status	Features
Paper	✅ Full Support	All features available
Folia	✅ Full Support	Thread-safe implementation
Spigot	✅ Compatible	Core features work
Bukkit	✅ Compatible	Basic functionality
Purpur	✅ Enhanced	Additional optimizations

---

🔗 Integration & API

AuryxCore Integration

• Player Data - Balance, language, mute status
• Economy Placeholders - %auryxcore_balance%
• Permission Sync - Seamless permission handling

PlaceholderAPI Support

• Built-in Placeholders - %auryxchat_mode%, %auryxchat_local_players%
• External Placeholders - Full PAPI placeholder support
• Custom Formats - Use any PAPI placeholder in chat formats

Developer API

// Get AuryxChat API
AuryxChatAPI api = AuryxChat.getAPI();

// Chat mode management
api.setPlayerChatMode(player, ChatMode.LOCAL);
ChatMode mode = api.getPlayerChatMode(player);

// Send formatted messages
api.sendLocalMessage(player, "Hello local players!");
api.broadcastAnnouncement("Server announcement!");

---

📊 Performance & Optimization

• ⚡ Async Processing - Non-blocking chat operations
• 🧵 Folia Compatible - Thread-safe for modern servers
• 💾 Smart Caching - Efficient format and data caching
• 🔄 Hot Reload - Configuration changes without restart
• 📱 Cross-Version - Single JAR for all supported versions

---