### Step 1: Install on Server
1. Copy the `aiguard-1.0.0.jar` file to the server's `plugins` folder.
2. Restart the server or use the `/reload` command.
3. The plugin will automatically create the `config.yml` file in the `plugins/AIGuard/` folder.
### Step 2: Initial Configuration
Edit the `plugins/AIGuard/config.yml` file:
# List of banned words
banned_words:
- "idiot"
- "dumb"
- "stupid"
- "noob"
# Enable BungeeCord (if you have a server network)
bungee:
enabled: false
channel: "aiguard:alerts"
```
## Usage
### Commands
- `/aiguard reload` - Reload configuration.
- `/ag reload` - Shortcut for the above command.
### Permissions
- `aiwatch.admin` - Access to management commands.
- `aiwatch.alert` - Receive alerts about suspicious messages.
- `aiwatch..*` - All permissions.
## BungeeCord Setup
### On BungeeCord Server
No special installation is needed on the BungeeCord server itself.
### On Each Server in the Group
1. Set `bungee.enabled: true` in the configuration.
2. Ensure all servers use the same `channel`.
3. Set a unique `server_name` for each server.
### Available Placeholders in Messages:
- `{player}` - Player name
- `{message}` - Original message
- `{banned_word}` - Detected banned word
- `{similarity}` - Similarity percentage
## Troubleshooting
### Plugin Does Not Load
- Check that Java version is 17 or higher.
- Ensure server version is 1.20 or higher.
- Check the log for errors.
### No Alerts
- Check that you have the `aiwatch.alert` permission.
- Ensure similarity threshold is not too high.
- Check that banned words are configured correctly.
### BungeeCord Issues
- Ensure all servers are connected to the same BungeeCord.
- Check that the channel is identical on all servers.
- Ensure players are connected (required for sending messages).