AuryxChat

💬 AuryxChat - Advanced Chat Management System

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

---

✨ Key Features

💬 Advanced Chat System

- Force Global - Radius-based local chat with global override - Force Global - Easy switching between local/global modes - Force Global - `[L]` and `[G]` prefixes show current chat mode - Force Global - Use `!` prefix to send global messages from local mode

🎨 Rich Formatting

- Hover Text - Per-group chat formatting (Admin, VIP, Default) - Hover Text - Full legacy color code support (`&c`, `&a`, etc.) - Hover Text - PlaceholderAPI and AuryxCore placeholders - Hover Text - Rich hover information with player stats

🛡️ Chat Moderation

- Action Logging - Configurable word/phrase blocking with regex support - Action Logging - Intelligent spam detection and prevention - Action Logging - Full integration with AuryxCore mute system - Action Logging - Comprehensive moderation logging

🔔 Player Mentions

- Visual Highlighting - Highlight and notify players when mentioned - Visual Highlighting - 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

- Perfect for - Only players within configured range can see messages - Perfect for: `[L]` (Green, Bold) - Perfect for: 100 blocks (configurable) - Perfect for: Roleplay servers, survival gameplay

🌍 Global Chat

- Perfect for - All online players receive messages - Perfect for: `[G]` (Red, Bold) - Perfect for - 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

- Real-time Updates - Advanced pattern matching - Real-time Updates - Block, replace, or warn - Real-time Updates - `auryxchat.filter.bypass` - Real-time Updates - No restart required for filter changes

Anti-Spam Protection

- Automatic Warnings - Detects repeated messages - Automatic Warnings - Configurable cooldown periods - Automatic Warnings - Ignores case and spacing variations - Automatic Warnings - Progressive punishment system

Mute Integration

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

---

🔧 Installation & Setup

Requirements

- Paper 1.8.8+ - Required for full functionality - Paper 1.8.8+ - Recommended version - Paper 1.8.8+ - Or compatible server platform

Installation Steps

1. Configure first (dependency) 2. Configure from Modrinth 3. Configure in your `plugins/` folder 4. Configure to generate configuration 5. Configure settings in `plugins/AuryxChat/`

Optional Dependencies

- LuckPerms - Enhanced placeholder support - LuckPerms - Permission group prefixes - LuckPerms - Advanced permission integration

---

⚙️ Configuration Highlights

Chat Formats (`config.yml`)

```yaml 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

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

Filter Configuration (`filters.yml`)

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

---

🌐 Platform Compatibility

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

---

🔗 Integration & API

AuryxCore Integration

- Permission Sync - Balance, language, mute status - Permission Sync - `%auryxcore_balance%` - Permission Sync - Seamless permission handling

PlaceholderAPI Support

- Custom Formats - `%auryxchat_mode%`, `%auryxchat_local_players%` - Custom Formats - Full PAPI placeholder support - Custom Formats - Use any PAPI placeholder in chat formats

Developer API

```java // 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

- 📱 Cross-Version - Non-blocking chat operations - 📱 Cross-Version - Thread-safe for modern servers - 📱 Cross-Version - Efficient format and data caching - 📱 Cross-Version - Configuration changes without restart - 📱 Cross-Version - Single JAR for all supported versions

---