MCDiscordRegions

This bukkit plugin allows you to connect your minecraft server to Discord. By entering a WorldGuard region in your Minecraft world, this bot will place you in the appropriate Discord channel.

Installation

1. Download MCDiscordRegions-x.x.jar (WorldEdit and WorldGuard are also required).
2. Place the downloaded jar files in the plugins/ directory of your server.
3. Reload the server. (This will create the config.yml of this plugin)
4. Register a discord bot for your minecraft server at https://discord.com/developers/applications, and copy the TOKEN.
5. Generate a bot invite link, using the bot's CLIENT ID on https://discordapi.com/permissions.html, the bot must at least have the following permissions: View Channel, Move Members, Read Messages, Send Messages, Add Reactions, Manage Channels, Manage Server, Manage Messages (= permission number 16788592), then invite the bot to your Discord server using the generated url.
6. Edit the plugins/MCDiscordRegions/config.yml file and provide it with your bot's TOKEN. You may also want to change the entry channel name and the category name.
7. Reload the server.

Usage

1. Join the entry Discord channel.
2. Send a private message to the Discord bot (created in the Installation phase) with your minecraft in-game name. (should react with a green tick)
3. Join the Minecraft server.
4. (Admin only) Create some WorldGuard regions. Tutorial
5. (Admin only) Set the discord-channel region flag to a Discord channel name, the channel will be created automatically when someone enters that region: /region flag your_region discord-channel your_channel_name

Command

/dregion [info | whitelist [on|off] | entry <channelName...> | category <categoryName...> | kickOnDiscordLeave [on|off] [kickMessage...] | deletecategory [confirm] | save | limit <maxUsers> <channelName...>] or /drg ...

• info: display various information about the plugin.
• whitelist [on|off]: when on, players who enter the entry Discord channel will be added to the whitelist, and removed when they disconnect.
• entry <channelName...>: set/create the Discord entry channel, this is the channel every user must join to enter the server. When joined, the user must send his minecraft in-game name to the Discord bot in private.
• category <categoryName...>: this is to create/set the Discord category the bot will create channels in.
• kickOnDiscordLeave: when on, kicks the player when he/she leaves the Minecraft regions Discord category. (with the specified message)
• deletecategory: delete the configured Discord category and all the channels in it.
• limit <maxUsers> <channelName...>: set the user limit on a Discord channel, if more than maxUsers players are in the Discord channel, no more players will be allowed in the Minecraft region.
• save: save the current settings to the config file. (not needed if auto-save is enabled in the config = default)

Discord channel permissions

When the plugin creates a channel, certain permissions will be set automatically:

• The entry channel will be visible to anyone, but no-one will be able to speak or stream. Only joining.
• All the other created channels are invisible to non-administrators, but they are able to speak in them (not stream) when the bot moves them there.

(currently, these permissions are not configurable)

Building

Use maven to build this project:

mvn clean compile assembly:single