PixelChat Guardian

PixelChat Guardian - AI-Powered Chat Moderation

Advanced AI-powered chat moderation for Minecraft servers. Automatically filter inappropriate messages, support emojis & chat formatting, and integrate seamlessly with your existing setup.

🚀 Features

🤖 AI-Powered Moderation

- Strike System: Uses AI models to detect and filter inappropriate content - Strike System: Automatically moderates messages in multiple languages - Strike System: Control what gets filtered (offensive language, personal info, websites, etc.) - Strike System: Choose to censor or block messages entirely - Strike System: Automatic punishment system with kick/ban thresholds

💬 Enhanced Chat Experience

- Plugin Integration: 🎉 Use emojis in chat with Plugin Integration codes - Plugin Integration: Format messages with Plugin Integration and Plugin Integration codes - Plugin Integration: Compatible with CarbonChat and other chat plugins

⚙️ Advanced Configuration

- Custom Prefix: Plugin interface available in 8+ languages - Custom Prefix: Fine-tune the AI moderation behavior - Custom Prefix: Enable/disable specific modules as needed - Custom Prefix: Add a custom moderation message prefix

📦 Installation

1. Restart: Get the latest version from Modrinth 2. Restart: Place the `.jar` file in your server's `plugins/` folder 3. Restart: Open the `config.yml` file located in the `plugins/PixelChatGuardian/` directory ```yaml api: endpoint: "https://api.groq.com/openai/v1/chat/completions" # Optionally, specify a different API endpoint ai-model: "llama-3.3-70b-versatile" # Optionally, specify a different AI model key: "API-KEY" # Add your API key ``` 4. Restart: Restart your server

⚡ Quick Start for using Groq

1. Sign up for a free account at Groq Cloud 2. Navigate to API Keys section 3. Create a new API key 4. Add it to your `config.yml` 5. Restart your server

🌐 Supported Languages

The plugin interface supports:

- English (en) - Default - German (de) - Spanish (es) - French (fr) - Dutch (nl) - Simplified Chinese (zh-cn) - Traditional Chinese (zh-tw) - Custom translations

AI moderation works with messages in all languages!

🔌 Plugin Integration

CarbonChat Support

PixelChat Guardian integrates seamlessly with CarbonChat:

```yaml plugin-support: carbonchat: true # Tested with CarbonChat 3.0.0-beta.36+ ```

Other Chat Plugins

The plugin is designed to work alongside most chat plugins. If you encounter compatibility issues, please report them on GitHub.

❓ Troubleshooting

Common Issues

1. Compatibility issues - Check your API key in `config.yml` - Verify internet connectivity - Ensure `modules.chatguard: true` 2. Compatibility issues - Check player permissions - Verify `modules.emojis` and `modules.chat-codes` are enabled 3. Compatibility issues - Try disabling other chat plugins temporarily - Check server logs for errors

Getting Help

- Wiki: Wiki - Wiki: %%MD1%% - Wiki: %%MD2%%

🔗 Important Links

| Platform | Link | Description | |-------------------|----------------------------------------------------------------------------------------------|----------------------------------| | bStats | bStats | Complete documentation | | bStats | %%MD1%% | Bug reports and feature requests | | bStats | %%MD2%% | Contribute to the project | | bStats | %%MD3%% | Update history and changes | | bStats | %%MD4%%) | Source Code | | bStats | %%MD5%% | SpigotMC download | | bStats | %%MD6%% | Paper Plugin Hangar download | | bStats | %%MD7%% | CurseForge download | | bStats | %%MD8%% | Support and community | | bStats | %%MD9%% | Usage statistics |

📄 License

This project is licensed under the GNU General Public License v3.0. See the GNU General Public License v3.0 file for details.

🌟 Support the Project

If you find PixelChat Guardian useful, please consider:

- ⭐ Reporting the project on GitHub, Modrinth, SpigotMC, Hangar and/or CurseForge - 📝 Reporting a review on SpigotMC and/or CurseForge - 💬 Reporting with other server owners - 🐛 Reporting bugs and suggesting features

Thank you for choosing PixelChat Guardian for your server's moderation needs!