Discord Admin Plugin for Rising World

Configuration

The main configuration file is config.properties located in your plugin's directory. Below are the available settings, organized by category.

Discord Bot Configuration

Setting	Description	Default Value
`discord.token`	Your Discord bot token (required)	Empty
`discord.admin.channel`	Discord channel ID for admin communications (required)	Empty
`discord.bot.activity`	Bot activity status shown in Discord	`Watching Rising World`
`discord.startup.notification`	Send notification when plugin starts (true/false)	`true`
`discord.error.notification.enabled`	Send notifications about errors (true/false)	`true`

Chat Relay Settings

Setting	Description	Default Value
`chat.relay.game_to_discord`	Enable chat relay from game to Discord	`true`
`chat.relay.discord_to_game`	Enable chat relay from Discord to game	`true`
`chat.format.discord_to_game`	Format for messages sent from Discord to game. Placeholders: %author%, %message%	`[Discord] %author%: %message%`
`chat.format.game_to_discord`	Format for messages sent from game to Discord. Placeholders: %player%, %message%	`[Game] %player%: %message%`

Chat Filter Settings

Setting	Description	Default Value
`chat.filter.enabled`	Enable the chat filter (true/false)	`false`
`chat.filter.words`	Comma-separated list of words to filter from chat	`badword1,badword2`

Server Status Display Settings

Setting	Description	Default Value
`status.updates.enabled`	Enable automatic status updates	`true`
`status.updates.interval`	Status update interval in minutes	`10`
`status.embed.online.color`	Color for online status in hex format	`#00FF00`
`status.embed.offline.color`	Color for offline status in hex format	`#FF0000`
`status.embed.restart.color`	Color for restart status in hex format	`#FFA500`
`status.embed.max_players`	Maximum number of players to display in status message	`15`
`status.embed.show_admin`	Show admin status in player list (true/false)	`false`
`status.embed.show_player_time`	Show player connection time in player list (true/false)	`false`
`status.embed.recreate_on_startup`	Always recreate status message on startup instead of reusing existing one (true/false)	`false`

Automatic Restart Configuration

Setting	Description	Default Value
`restart.daily.enabled`	Enable daily automatic restarts (true/false)	`true`
`restart.daily.time`	Daily restart time in 24-hour format (HH:MM)	`04:00`
`restart.timezone`	Timezone for restart scheduling (e.g. UTC, America/New_York)	System default
`restart.countdown.minutes`	Warning countdown in minutes before restart	`30`
`restart.warning.times`	Warning times in minutes (comma-separated)	`20,15,10,5,3,1`
`restart.broadcast.prefix`	Prefix for restart warning messages	`⚠️ SERVER RESTART`
`restart.pre_shutdown.backup`	Create backup before restart (true/false)	`true`
`restart.immediate_action`	Action to take when immediate restart is triggered: "lock" or "kick"	`lock`
`restart.command`	Server restart command (OS specific)	OS specific default

Note: The restart.command setting is crucial for proper restart functionality. For Linux servers, a bash script is typically used. For Windows, a batch file might be needed.

Example restart commands:

Linux:

restart.command=bash -c "./rwserver restart > /Home/RWserver/log/command_output.log 2>&1 &"

Windows:

restart.command=start cmd /c start_server.bat

Discord Message Management

Setting	Description	Default Value
`discord.message.delete.delay`	Delay (in seconds) before deleting messages	`300`
`discord.message.delete.mode`	Message deletion mode: "always", "on_restart", or "never"	`always`

Player Management

Setting	Description	Default Value
`player.connection.log.enabled`	Enable logging of player connections (true/false)	`true`
`player.connection.log.directory`	Directory for player connection logs	`player_connections`
`player.rejoin.time.track`	Track time between player rejoins (true/false)	`true`
`player.history.enabled`	Enable player history tracking (true/false)	`true`
`player.history.max_notes`	Maximum number of notes per player	`50`
`player.welcome.message.enabled`	Enable welcome message for new players (true/false)	`true`
`player.welcome.message`	Welcome message text (placeholder: %player%	`Welcome to the server, %player%!`

Message Format Settings

Setting	Description	Default Value
`message.join.format`	Player join message format (placeholder: %player%,%playercount%,%totalplayers%)	`🟢 %player% joined the server`
`message.leave.format`	Player leave message format (placeholder: %player%,%playercount%, %totalplayers%)	`🔴 %player% left the server`

Discord Invite Management

Setting	Description	Default Value
`invite.enabled`	Master switch to enable/disable Discord invites completely	`true`
`invite.auto_assign_role`	Automatically assign roles based on invite used	`true`
`invite.tracking_window`	Tracking window (in seconds) for invite usage detection	`15`
`invite.auto_send_on_join`	Enable automatic Discord invite on player join (true/false)	`true`
`invite.welcome_message`	Discord welcome message for new members (placeholder: %user%)	`Welcome, %user%! Join our game server with /link`
`invite.use_dynamic`	Use dynamic invites with expiry (true) or permanent invites (false)	`false`
`invite.dynamic.max_uses`	Default maximum uses for dynamic invites (0 for unlimited)	`1`
`invite.dynamic.expiration_hours`	Default expiration hours for dynamic invites (0 for never)	`24`
`invite.dynamic.role_id`	Role ID to assign for dynamic invites (required when dynamic invites enabled)	Empty

Note: The dynamic invite system is a new feature in version 3.7. It allows for creating temporary invites that expire after a certain time or number of uses, with automatic role assignment.

Backup Configuration

Setting	Description	Default Value
`backup.directory`	Directory for backups	`backups`
`backup.max_count`	Maximum number of backups to keep	`10`

Plugin Logging

Setting	Description	Default Value
`logs.max_files`	Maximum number of log files to keep	`30`
`logs.directory`	Directory for log files	`logs`
`logs.level`	Log level (DEBUG, INFO, WARNING, SEVERE, CRITICAL)	`INFO`
`logs.console.debug`	Enable console output for debug logs (true/false)	`false`

Discord Commands

The plugin adds numerous slash commands to Discord. Below is a complete reference.

Server Information Commands

/players

Lists all online players on the server.

Permissions: Available to everyone by default

/refresh_status

Refreshes the server status message.

Permissions: ADMINISTRATOR, MANAGE_SERVER

Moderation Commands

/kick

Kicks a player from the server.

Parameters:

player - Player name (required)
reason - Reason for kick (optional)

Permissions: KICK_MEMBERS, ADMINISTRATOR

/ban

Bans a player from the server.

Parameters:

player - Player name (required)
reason - Reason for ban (optional)
time - Ban duration in minutes (-1 for permanent) (optional)

Permissions: BAN_MEMBERS, ADMINISTRATOR

/unban

Unbans a player from the server.

Parameters:

player - Player name (required)

Permissions: BAN_MEMBERS, ADMINISTRATOR

/teleport

Teleports a player to coordinates or another player.

Parameters:

player - Player name (required)
x - X coordinate (optional)
y - Y coordinate (optional)
z - Z coordinate (optional)
target - Target player name (optional)

Permissions: ADMINISTRATOR

Note: You must provide either coordinates (x, y, z) or a target player.

/broadcast

Broadcasts a message to all players on the server.

Parameters:

message - Message to broadcast (required)

Permissions: MANAGE_SERVER, ADMINISTRATOR

Server Management Commands

/restart

Initiates a server restart with the configured countdown.

Permissions: MANAGE_SERVER, ADMINISTRATOR

/restart_enable

Enables or disables automatic server restarts.

Parameters:

enabled - Whether restarts should be enabled (true/false) (required)

Permissions: ADMINISTRATOR

/restart_time

Sets the daily restart time.

Parameters:

time - Time in HH:MM format (24-hour) (required)

Permissions: ADMINISTRATOR

/restart_timezone

Sets the timezone for restarts.

Parameters:

timezone - Timezone ID (e.g., UTC, America/New_York) (required)

Permissions: ADMINISTRATOR

/list_timezones

Lists available timezones for restart configuration.

Parameters:

common_only - Show only common timezones (optional)

Permissions: ADMINISTRATOR

/reload_config

Reloads the plugin's configuration files.

Permissions: ADMINISTRATOR

Player Account Management

/link

Links your Discord account to your game account.

Parameters:

username - Your in-game username (required)

Permissions: Available to everyone by default

/promote

Promotes a player to admin status.

Parameters:

player - Player name (required)

Permissions: ADMINISTRATOR

/demote

Demotes a player from admin status.

Parameters:

player - Player name (required)

Permissions: ADMINISTRATOR

Player History Commands

/warn

Adds a warning to a player's history.

Parameters:

player - Player name (required)
reason - Warning reason (required)

Permissions: KICK_MEMBERS, ADMINISTRATOR

/note

Adds a note to a player's history.

Parameters:

player - Player name (required)
note - Note text (required)

Permissions: KICK_MEMBERS, ADMINISTRATOR

/history

View a player's history (warnings, notes, moderation actions).

Parameters:

player - Player name (required)

Permissions: KICK_MEMBERS, ADMINISTRATOR

/delete_note

Delete a note from a player's history.

Parameters:

player - Player name (required)
note_id - Note ID to delete (required)

Permissions: ADMINISTRATOR

Discord Invite Management

/reset_discord_connection

Resets Discord connection status for a player.

Parameters:

player - Player name (required)

Permissions: ADMINISTRATOR

/send_discord_invite

Sends a Discord invite to a specific player.

Parameters:

player - Player name (required)
invite_code - Discord invite code (without discord.gg/) (optional)
dynamic - Create a dynamic invite (optional)
role - Role ID to assign for dynamic invite (optional)
max_uses - Maximum uses for dynamic invite (optional)
expiration_hours - Hours until expiration for dynamic invite (optional)

Permissions: ADMINISTRATOR

/toggle_discord_invites

Enable or disable Discord invites completely.

Parameters:

enabled - Whether Discord invites should be enabled (true/false) (required)

Permissions: ADMINISTRATOR

/create_invite

Creates an invite link that assigns a role.

Parameters:

channel - Channel ID to create invite for (required)
role - Role ID to assign (required)
max_uses - Maximum number of uses (0 for unlimited) (optional)
expiration_hours - Hours until expiration (0 for never) (optional)

Permissions: CREATE_INSTANT_INVITE, ADMINISTRATOR

/create_dynamic_invite

Creates a dynamic invite with expiry.

Parameters:

channel - Channel ID to create invite for (required)
role - Role ID to assign (required)
max_uses - Maximum number of uses (0 for unlimited) (optional)
expiration_hours - Hours until expiration (0 for never) (optional)

Permissions: CREATE_INSTANT_INVITE, ADMINISTRATOR

/link_invite

Links an existing invite with a role.

Parameters:

channel - Channel ID where the invite exists (required)
code - Invite code to link (required)
role - Role ID to assign (required)

Permissions: MANAGE_CHANNEL, ADMINISTRATOR

/delete_invite

Deletes a role invite.

Parameters:

code - Invite code to delete (required)

Permissions: MANAGE_CHANNEL, ADMINISTRATOR

/list_invites

Lists all role invites.

Permissions: MANAGE_CHANNEL, ADMINISTRATOR

/set_default_invite

Sets the default Discord invite for automatic player invites.

Parameters:

invite_code - Discord invite code (without discord.gg/) (required)

Permissions: ADMINISTRATOR

/set_invite_type

Sets whether to use dynamic or permanent invites.

Parameters:

type - Invite type: "dynamic" or "permanent" (required)

Permissions: ADMINISTRATOR

Feature Guides

Setting Up Discord Invites and Role Management

The Discord Admin Plugin offers powerful tools for managing Discord invites and automatically assigning roles to players who join your Discord server. Here's a comprehensive guide to setting this up.

Prerequisites

A Discord server with proper permissions
Discord Bot set up with appropriate permissions (MANAGE_ROLES, CREATE_INSTANT_INVITE)
At least one role created in your Discord server for players

Basic Setup

Enable invites in configuration:

Make sure the following settings are enabled in your config.properties:
```
invite.enabled=true
invite.auto_assign_role=true
invite.auto_send_on_join=true
```
Create a role for players:

In your Discord server, create a role for players (e.g., "Rising World Player").

Right-click on the role and select "Copy ID" (make sure Developer Mode is enabled in Discord).
Create an invite with role assignment:

Use the command /create_invite in Discord:
```
/create_invite channel:YOUR_CHANNEL_ID role:YOUR_ROLE_ID
```
Replace YOUR_CHANNEL_ID with the ID of the channel you want the invite to direct to (right-click channel, "Copy ID").

Replace YOUR_ROLE_ID with the ID of the role you copied earlier.
Set as default invite:

Once the invite is created, you'll get a response with the invite code. Use this to set it as the default:
```
/set_default_invite invite_code:YOUR_INVITE_CODE
```
This invite will now be automatically sent to players when they join your server.

Using Dynamic Invites (New in v3.7)

Dynamic invites are temporary invites that expire after a set time or number of uses. This can provide better security and tracking.

Enable dynamic invites in configuration:

Update your config.properties with:
```
invite.use_dynamic=true
invite.dynamic.max_uses=1
invite.dynamic.expiration_hours=24
invite.dynamic.role_id=YOUR_ROLE_ID
```
Replace YOUR_ROLE_ID with the Discord role ID for players.
Switch to dynamic invites in Discord:
```
/set_invite_type type:dynamic
```
Test the system:

You can manually send a dynamic invite to a player with:
```
/send_discord_invite player:PlayerName dynamic:true role:YOUR_ROLE_ID
```

Advanced Role Management

You can create multiple invites with different roles for different player types:

Create different roles in Discord:

Examples: "RW-VIP", "RW-Donor", "RW-Regular", etc.

Create multiple invites with different roles:

/create_invite channel:CHANNEL_ID role:VIP_ROLE_ID
/create_invite channel:CHANNEL_ID role:DONOR_ROLE_ID
/create_invite channel:CHANNEL_ID role:REGULAR_ROLE_ID

Send specific invites to specific players:

/send_discord_invite player:VIPPlayerName invite_code:VIP_INVITE_CODE

Managing Invites

List all active role invites: /list_invites
Delete an invite: /delete_invite code:INVITE_CODE
Reset a player's Discord connection (to resend an invite): /reset_discord_connection player:PlayerName

Security Tip: Consider using dynamic invites with a single-use limit for better security. This prevents invite links from being shared and ensures each player gets a unique invite.

Configuring the Chat Filter

The Discord Admin Plugin includes a chat filter system that can automatically censor inappropriate words in both in-game and Discord chat. Here's how to set it up.

Basic Setup

Enable the chat filter:

In your config.properties file, set:
```
chat.filter.enabled=true
```
Define filtered words:

Add a comma-separated list of words to filter:
```
chat.filter.words=badword1,badword2,badword3
```
The filter is case-insensitive, so you don't need to include variations.
Save and restart:

Save your configuration file and restart the server to apply the changes.

How the Filter Works

The chat filter has several advanced features:

Smart detection: The filter can detect common letter substitutions (e.g., "a" replaced with "@" or "4").
Space handling: Adding spaces between letters won't bypass the filter.
Replacement: Filtered words are replaced with asterisks (*) matching the length of the filtered word.
Two-way filtering: The filter works for both in-game to Discord and Discord to in-game communication.

Testing and Maintenance

To effectively maintain your chat filter:

Test the filter regularly to ensure it's catching problematic terms.
Update your filter list as needed if you discover new terms being used to bypass the filter.
Consider the language and culture of your player base when defining filtered words.
Be careful not to over-filter, as this could lead to legitimate words being censored (the "Scunthorpe problem").

Note: The chat filter will only affect new messages; it won't retroactively filter existing messages in Discord.

Using Player History and Notes

The player history system allows server administrators to keep track of player behavior, warnings, and notes. This is especially useful for moderation and tracking problematic players.

Setting Up Player History

Enable player history:

In your config.properties, ensure these settings are enabled:
```
player.history.enabled=true
player.history.max_notes=50
```
Restart your server:

This will create the necessary directories and files for the history system.

Adding Player Notes

There are two main types of entries you can add to a player's history:

Warnings:

Warnings are formal notifications to players about rule violations. To add a warning:
```
/warn player:PlayerName reason:Reason for warning
```
When you add a warning, the player will be notified in-game with a message.
Notes:

Notes are staff-only comments about a player. To add a note:
```
/note player:PlayerName note:This is a staff note about the player
```
Notes are not visible to the player.

Viewing Player History

To view a player's complete history:

/history player:PlayerName

This will show:

Total number of entries
Count of warnings, notes, and moderation actions
A chronological list of the 10 most recent entries

Managing Player Notes

To delete a note from a player's history:

First view the player's history to get the note ID: /history player:PlayerName
Delete the specific note: /delete_note player:PlayerName note_id:NOTE_ID

Player Warning Notification

When a player connects to the server, if they have any warnings, they will be informed of the number of warnings on their record.

Tip: Player history is stored in JSON files in the player_history directory inside your plugin folder. These can be backed up if needed.

Setting Up Automated Restarts

Automated server restarts can help maintain server performance and stability. The Discord Admin Plugin provides a robust system for scheduled restarts with appropriate warnings and notifications.

Basic Restart Configuration

Enable automated restarts:

In your config.properties, set:
```
restart.daily.enabled=true
restart.daily.time=04:00
restart.timezone=UTC
```
This would schedule a daily restart at 4:00 AM UTC.
Configure warning times:
```
restart.countdown.minutes=30
restart.warning.times=20,15,10,5,3,1
```
This sets a 30-minute countdown with warnings at 20, 15, 10, 5, 3, and 1 minutes before restart.

Set message format:

restart.broadcast.prefix=⚠️ **SERVER RESTART**

Setting Up the Restart Command

The most important part of the restart system is the restart command, which is OS-specific:

Linux Example:

restart.command=bash -c "./rwserver restart > /Home/RWserver/log/command_output.log 2>&1 &"

This assumes you have a script called rwserver in the current directory with a restart command.

Windows Example:

restart.command=start cmd /c start_server.bat

This assumes you have a batch file called start_server.bat that handles restarting the server.

Important: The restart command must be properly configured for your specific server environment. Testing is highly recommended to ensure it works correctly.

Timezone Configuration

To list available timezones and set your server's timezone:

Use the command /list_timezones to see available timezone IDs
Set your timezone with /restart_timezone timezone:America/New_York (example)

Manual Restart

To manually trigger a restart with the configured countdown:

/restart

Pre-Restart Actions

Configure what happens right before restart:

restart.pre_shutdown.backup=true - Create a backup before restart
restart.immediate_action=lock - Action to take at 2 minutes before restart ("lock" or "kick")

Disabling and Re-enabling Restarts

You can temporarily disable and re-enable scheduled restarts:

Disable: /restart_enable enabled:false
Enable: /restart_enable enabled:true

Changing Restart Time

You can change the daily restart time without editing the config file:

/restart_time time:03:30

This would change the restart time to 3:30 AM in your configured timezone.

Best Practice: Schedule restarts during low-activity hours to minimize disruption to players.

Troubleshooting

Common Issues and Solutions

Discord Bot Not Connecting

Problem: The Discord bot fails to connect to Discord.
Solutions:
- Verify that your discord.token is correct and properly formatted
- Check that you've enabled the required intents in the Discord Developer Portal (PRESENCE, SERVER MEMBERS, and MESSAGE CONTENT)
- Ensure your bot has not been rate-limited by Discord
- Check server logs for detailed error messages

Slash Commands Not Appearing

Problem: Slash commands are not showing up in Discord.
Solutions:
- Verify that your bot has the applications.commands scope enabled in the invite URL
- It may take up to an hour for commands to propagate across Discord's systems
- Try using the /reload_config command if it's available
- Restart your Rising World server to trigger a re-registration of commands

Permission Issues

Problem: Commands are showing up but return "You are not authorized to use this command."
Solutions:
- Edit the admins.properties file to add your Discord user ID
- Make sure your Discord account has appropriate permissions in the server (ADMINISTRATOR or MANAGE_SERVER)
- Check that your in-game account is linked to your Discord account and has admin permissions

Chat Relay Not Working

Problem: Messages aren't being relayed between Discord and the game.
Solutions:
- Verify that chat.relay.game_to_discord and chat.relay.discord_to_game are set to true
- Check that your bot has permission to read and send messages in the admin channel
- Ensure that the admin channel ID is correctly set in discord.admin.channel

Server Not Restarting Properly

Problem: The server shutdown occurs but doesn't restart.
Solutions:
- Verify that the restart.command is correctly configured for your OS
- Test your restart script manually to ensure it works
- Check server logs for errors related to the restart process
- Ensure that the user running the server has permissions to execute the restart command

Discord Invites Not Being Sent

Problem: Players are not receiving Discord invites when they join.
Solutions:
- Check that invite.enabled and invite.auto_send_on_join are set to true
- Verify that you have created and set a default invite with /set_default_invite
- Make sure your bot has the CREATE_INSTANT_INVITE permission
- If using dynamic invites, ensure that invite.dynamic.role_id is set correctly

Plugin Not Loading at Server Start

Problem: The plugin fails to load when the server starts.
Solutions:
- Check server logs for detailed error messages
- Verify that you have the correct version of the plugin for your Rising World server version
- Ensure that the plugin JAR file is directly in the plugins directory
- Check if the plugin has dependencies that need to be installed separately

Logs and Debugging

To get more detailed information for troubleshooting:

Enable detailed logging:

In your config.properties, set:
```
logs.level=DEBUG
logs.console.debug=true
```
Check log files:

Log files are stored in the logs directory within your plugin folder.

Getting Help

If you're still experiencing issues:

Check the plugin's documentation and release notes for known issues
Check the Rising World forums for community support
Provide detailed information when seeking help, including log files and your configuration (with sensitive information like tokens removed)

Discord Admin Plugin for Rising World

Table of Contents

Introduction

Key Features

Installation

Discord Bot Setup

Creating a Discord Bot

Inviting the Bot to Your Server

Setting Up Admin Channel

Configuration

Discord Bot Configuration

Chat Relay Settings

Chat Filter Settings

Server Status Display Settings

Automatic Restart Configuration

Example restart commands:

Discord Message Management

Player Management

Message Format Settings

Discord Invite Management

Backup Configuration

Plugin Logging

Discord Commands

Server Information Commands

/players

/refresh_status

Moderation Commands

/kick

/ban

/unban

/teleport

/broadcast

Server Management Commands

/restart

/restart_enable

/restart_time

/restart_timezone

/list_timezones

/reload_config

Player Account Management

/link

/promote

/demote

Player History Commands

/warn

/note

/history

/delete_note

Discord Invite Management

/reset_discord_connection

/send_discord_invite

/toggle_discord_invites

/create_invite

/create_dynamic_invite

/link_invite

/delete_invite

/list_invites

/set_default_invite

/set_invite_type

Feature Guides

Setting Up Discord Invites and Role Management

Prerequisites

Basic Setup

Using Dynamic Invites (New in v3.7)

Advanced Role Management

Managing Invites

Configuring the Chat Filter

Basic Setup

How the Filter Works

Testing and Maintenance

Using Player History and Notes

Setting Up Player History

Adding Player Notes

Viewing Player History

Managing Player Notes

Player Warning Notification

Setting Up Automated Restarts

Basic Restart Configuration

Setting Up the Restart Command

Linux Example: