Features
- Game server joins/quits relayed to Discord.
- Discord death messages.
- 2 way chatting between game & Discord.
- PM logging.
- Mute logging.
- Clan chat logging.
- Various backend server logging.
- Moderator !mute and !unmute Discord commands.
- Discord !players command to show players in game.
- Moderator !kick, !ban & !unban Discord command for your lower staff.
- Full support for Discord to game console commands for admins.
- Initialized message lets players know when server is ready to rejoin (wipes/restarts).
- Admin channel with players' Name/IP/Steam ID.
- Fully customizable channel output types.
- In-game /report & /bug commands for reporting issues to admins on Discord.
- Single bot can handle multiple servers.
- Built-in chat filter.
Configuration
The settings and options can be configured in the Rustcord file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.The config below is a sample of setting up for a main channel that displays joins, quits, deaths, and chat; an admin channel that displays admin connect info; and a report channel.
Config Log true/false determines which channel flags are active. Example: If you have a channel using the msg_chat channel flag, it won't work unless "LogChat" is set to true in the config. If LogChat is set to false, Rustcord will not monitor the associated hook, and therefore wouldn't send anything to your msg_chat channel. You can find a full list of which flags go with with settings in the .
Note: Sample config may vary from settings in the public release. Do NOT copy paste this to your config, it is just a formatting example.
FAQ
Q: How do I get a channel ID for the config?A: Enable Developer Mode in Discord (User Settings > Appearance > Advanced). Then in Discord, right click your channel in the left hand side channel list and chose Copy ID (last option in drop down).
Q: Death OutputeType: DeathNotes - Death messages aren't in the lang file, how do I customize them?
A: The death messages are taken from your DeathNotes plugin config, and will mirror whatever is set there.
Q: The plugin failed to compile on server start/restart.
A: Check to make sure you're not running other Discord plugins. Rustcord will still work with them installed, but will need to be reloaded after server load (TimedExecute could do this). If you go that route, the initialized message wont work on restarts and wipes, as the plugin isn't loaded on startup.
Q: How does 2 way chat work?
A: Anything typed by anyone in a channel with the msg_chat flag will automatically be sent into the game chat with a [Discord] chat tag. It's automatic and doesn't require a command. We recommend servers with higher populations to restrict it to staff only able to type, but everyone able to view.
Q: How does custom logging work?
A: Custom logging logs any console lines that contain the items in your CustomFilter settings for that channel into said channel. For example, Rustcord doesn't have built in support for the Timed Execute plugin, but Timed Execute logs everything it does to the server console with the tag [Timed Execute], so you could put "[Timed Execute]" in your CustomFilter list to have Rustcord log the plugin to that channel.