An open API service indexing awesome lists of open source software.

https://github.com/pixelmindmc/pixelchatguardian

Enhance your Minecraft experience with our AI-powered chat moderation plugin, featuring advanced chat and link filtering, robust emoji support, and Minecraft chat codes.
https://github.com/pixelmindmc/pixelchatguardian

bukkit bukkit-plugin bukkit-plugins craftbukkit java minecraft minecraft-plugin minecraft-server modding paper paper-plugin papermc papermc-plugin plugin spigot spigot-plugin spigotmc spigotmc-plugin

Last synced: 6 months ago
JSON representation

Enhance your Minecraft experience with our AI-powered chat moderation plugin, featuring advanced chat and link filtering, robust emoji support, and Minecraft chat codes.

Awesome Lists containing this project

README

          

# PixelChat Guardian

Enhance your Minecraft experience with our **AI-Powered Chat Moderation Plugin**! This plugin offers advanced chat and
link filtering, robust emoji support, and Minecraft chat codes, ensuring a safe and enjoyable environment for all
players.

### Compatibility

**PixelChat Guardian** is compatible with Minecraft versions **1.17 to 1.21.5** on both **Spigot** and **Paper**.

## Features

- **AI Chat Moderation**: Leverage artificial intelligence to automatically detect and filter inappropriate chat
messages, creating a safer environment for players worldwide.
- **Advanced Link Filtering**: Prevent spam and harmful links from cluttering your chat.
- **Emoji Support**: Enable players to express themselves with a diverse range of emojis, enhancing fun and universal
communication.
- **Chat Codes Support**: Allow players to enhance their messages using Minecraft chat codes, including special
formatting and colors.
- **Customizable Settings**: Tailor the plugin's moderation and language-specific settings to meet your server's unique
needs.
- **Multilanguage Support**: Automatically detect and moderate chat messages in multiple languages to support global
player communities. The plugin interface itself is also fully localized, allowing server administrators to configure
and use it in their preferred language.
- **Compatibility with other Chat Plugins**: Designed to work seamlessly alongside other chat plugins, our solution
integrates effortlessly into your existing setup.

## Installation

1. **Download**: Get the latest version of the plugin from
the [Modrinth](https://modrinth.com/plugin/pixelchatguardian/) page.
2. **Install**: Place the downloaded `.jar` file into the `plugins` folder of your Minecraft server.
3. **Activate**: Restart your server to load and activate the plugin.
4. **Create an Account**: Sign up for a free **Groq** account and retrieve your API key.
5. **Configure**: Open the `config.yml` file located in the `plugins/PixelChatGuardian` directory.
- Add your API key under `api-key`.
- Optionally, specify a different API endpoint if needed. The plugin supports any OpenAI-API-compliant endpoint,
but you may need to adjust the AI model string in the `config.yml`.
6. **Reload Configurations**: Use the appropriate command to reload the plugin's configuration, apply your API key, and
enjoy PixelChatGuardian's features!

## Important Notes

- Always **create or update** your configuration files when updating the plugin to prevent any issues.
- By default, the plugin collects **anonymous statistics**. You can view these
on [bStats](https://bstats.org/plugin/bukkit/PixelChat%20Guardian/23371).

## Need Help or Have Suggestions?

For assistance, bug reports, or suggestions, please reach out through:

- [GitHub Issues](https://github.com/PixelMindMC/PixelChatGuardian/issues)
- [Our Discord Server](https://discord.gg/hyGpwCp3zq)
- [Modrinth Organization](https://modrinth.com/organization/pixelmindmc)

If you enjoy the plugin, consider leaving a review on Modrinth and giving us a star on GitHub. Your feedback helps us
improve!

## Important Links

- [Wiki](https://github.com/PixelMindMC/PixelChatGuardian/wiki)
- [Issues](https://github.com/PixelMindMC/PixelChatGuardian/issues)
- [Pull Requests](https://github.com/PixelMindMC/PixelChatGuardian/pulls)
- [Changelog](https://github.com/PixelMindMC/PixelChatGuardian/blob/master/CHANGELOG.md)
- [Modrinth Project](https://modrinth.com/plugin/pixelchatguardian/)
- [SpigotMC Resource](https://www.spigotmc.org/resources/pixelchat-guardian.120146/)
- [Paper Plugin Hangar](https://hangar.papermc.io/PixelMindMC/PixelChat_Guardian)
- [CurseForge](https://www.curseforge.com/minecraft/bukkit-plugins/pixelchat-guardian)
- [bStats Statistics](https://bstats.org/plugin/bukkit/PixelChat%20Guardian/23371)

## License

This Minecraft plugin project is open-source and licensed under
the [GNU General Public License v3.0](https://github.com/PixelMindMC/PixelChatGuardian/blob/master/LICENSE). This means
the plugin is freely available for anyone to use, modify, and distribute, provided all copies and derivative works
adhere to the same GPLv3 terms and give proper attribution to the original authors.