OZ DiscordConnect Plugin
This plugin connects your Rising World server with Discord.
It supports chat forwarding, event messages, status updates and more.
Requirements
- Rising World (Unity) Server
- OZTools Plugin (required for auto-reload and file watching and libraries)
- OZ DiscordConnect Plugin
Download both plugins:
DiscordConnect Download
OZTools Download
Installation
- Place both plugin ZIP files into your
plugins/ folder.
- Restart your server.
- The first startup creates a file named
settings.properties based on settings.default.properties.
- Edit
settings.properties to configure the plugin.
Automatic Reloading
Thanks to OZTools:
- The
settings.properties file is automatically reloaded when changed.
- When you replace a plugin JAR (for updates), OZTools detects it and reloads all plugins automatically. (can be disabled)
Configuration
Edit the generated settings.properties file.
These entries should be customized:
# ---------------------- Important plugin settings ---------------------
# You should set these settings according to your server setup
# Discord Bot - On small servers the bot can cause OutOfMemory crash, just stick to botEnable=false in that case!
# your Bot token found on https://discordapp.com/developers/applications/YOUR_APP_ID/bots
# If you want to use Webhooks you have to set this block
# These only apply if you use webhooks
statusUsername=My RW Server
# the channel name in discord from which the bot should pickup chat to display it ingame (usually the same channel where the chatWebHook is posting to)
# botChatChannelName=server-chat
# If you want the Bot to write messages instead of webhooks you can set channelIds here
# tracked events always go into server log but if you want to track them in discord set this to true
# Support messages /support [text] to discord
Display More
Direct or Webhook Mode
You can run the plugin in two ways:
- Direct Mode use *ChannelId properties
- Webhook Mode use webHook*Url properties
Features
- Two-way chat between server and Discord
- Event messages (join/leave/death)
- Status updates (server online/offline)
- Support channel forwarding
- Automatic configuration reload
- Almost all messages are translated in german, english or russian, more can be added easily on request
- Automatic plugin reload on update (via OZTools) [can be disabled in settings.properties of OZTools]
Updating
Simply overwrite the plugin files with the newest versions.
OZTools will detect the changes and reload all plugins automatically.
Support
If you need help or found a bug, feel free to reply in this thread.
