add config to exclude specific servers, properly shutdown jda, remove deprecated discriminator placeholder, improve config comments

Author: fooooooooooooooo

README.md

@@ -26,7 +26,7 @@ Chat from all servers gets bridged with a discord channel
 7. Under `[discord]`, paste the channel id you want to use
    - To get a channel id, you have to enable developer mode in Discord
    - Open Discord settings, go to `Advanced`, then turn on `Developer Mode`
-   - Now right click the channel you want to use and click `Copy ID`
+   - Now right-click the channel you want to use and click `Copy ID`
 8. Set any additional config options you want
 9. Start the server and check if it works
 
@@ -36,7 +36,11 @@ Default config generated on startup:
 
 ```toml
 # Don't change this
-config_version = "1.7"
+config_version = "1.8"
+
+# Comma separated list of server names to exclude from the bridge (defined under [servers] inside your velocity.toml)
+# e.g., exclude_servers = ["lobby", "survival"]
+exclude_servers = []
 
 [discord]
 # Bot token from https://discordapp.com/developers/applications/
@@ -52,6 +56,7 @@ show_attachments_ingame = true
 # Show a text as playing activity of the bot
 show_activity = true
 # Activity text of the bot to show in Discord
+# Placeholders {amount} is available
 activity_text = "with {amount} players online"
 
 # Enable mentioning Discord users from Minecraft chat
@@ -79,25 +84,33 @@ webhook_username = "{username}"
 [discord.chat]
 # The format set in the following key "discord.chat.message" is ignored when a webhook is used
 # Placeholders {username}, {server}, and {message} are available
+# Can be disabled
 message = "{username}: {message}"
 # Placeholders {username} and {server} are available
+# Can be disabled
 join_message = "**{username} joined the game**"
 leave_message = "**{username} left the game**"
 # Possible different format for timeouts or other terminating connections
-# Only placeholder {username} is available
+# Placeholder {username} is available
+# Can be disabled
 disconnect_message = "**{username} disconnected**"
 # Placeholders {username}, {current}, and {previous} are available
+# Can be disabled
 server_switch_message = "**{username} moved to {current} from {previous}**"
 # Placeholders {username} and {death_message} are available
+# Can be disabled
 death_message = "**{username} {death_message}**"
 # Placeholders {username}, {advancement_title}, and {advancement_description} are available
+# Can be disabled
 advancement_message = "**{username} has made the advancement __{advancement_title}__**\n_{advancement_description}_"
 
 [discord.commands.list]
 enabled = true
 # Ephemeral messages are only visible to the user who sent the command
 ephemeral = true
+# Placeholders {server_name}, {online_players} and {max_players} are available
 server_format = "[{server_name} {online_players}/{max_players}]"
+# Placeholder {username} is available
 player_format = "- {username}"
 # Can be disabled
 no_players = "No players online"
@@ -108,9 +121,13 @@ codeblock_lang = "asciidoc"
 # Discord > Minecraft message formats
 # Uses XML-like formatting with https://docs.adventure.kyori.net/minimessage#format
 [minecraft]
+# Placeholder {discord} is available
 discord_chunk = "<dark_gray>[<{discord_color}>Discord<dark_gray>]<reset>"
-username_chunk = "<{role_color}><hover:show_text:{username}#{discriminator}>{nickname}</hover><reset>"
+# Placeholders {role_color}, {username} and {nickname} are available
+username_chunk = "<{role_color}><hover:show_text:{username}>{nickname}</hover><reset>"
+# Placeholders {discord_chunk}, {username_chunk}, {attachments} and {message} are available
 message = "{discord_chunk} {username_chunk}<dark_gray>: <reset>{message} {attachments}"
+# Placeholders {url} and {attachment_color} are available
 attachments = "<dark_gray><click:open_url:{url}>[<{attachment_color}>Attachment<dark_gray>]</click><reset>"
 # Colors for the <{discord_color}> and <{attachment_color}> tags
 discord_color = "#7289da"

src/main/java/ooo/foooooooooooo/velocitydiscord/VelocityDiscord.java

@@ -3,6 +3,7 @@
 import com.google.inject.Inject;
 import com.velocitypowered.api.event.Subscribe;
 import com.velocitypowered.api.event.proxy.ProxyInitializeEvent;
+import com.velocitypowered.api.event.proxy.ProxyShutdownEvent;
 import com.velocitypowered.api.plugin.Plugin;
 import com.velocitypowered.api.plugin.annotation.DataDirectory;
 import com.velocitypowered.api.proxy.ProxyServer;
@@ -26,7 +27,7 @@
 public class VelocityDiscord {
   public static final String PluginName = "Velocity Discord Bridge";
   public static final String PluginDescription = "Velocity Discord Chat Bridge";
-  public static final String PluginVersion = "1.7.0";
+  public static final String PluginVersion = "1.8.0";
   public static final String PluginUrl = "https://github.com/fooooooooooooooo/VelocityDiscord";
 
   public static final MinecraftChannelIdentifier YepIdentifier = MinecraftChannelIdentifier.create("velocity", "yep");
@@ -72,13 +73,21 @@ public void onProxyInitialization(ProxyInitializeEvent event) {
     if (discord != null) {
       register(discord);
     }
+
     if (yep != null) {
       register(yep);
     }
 
     this.server.getChannelRegistrar().register(YepIdentifier);
   }
 
+  @Subscribe
+  public void onProxyShutdown(ProxyShutdownEvent event) {
+    if (discord != null) {
+      discord.shutdown();
+    }
+  }
+
   private void register(Object x) {
     this.server.getEventManager().register(this, x);
   }

src/main/java/ooo/foooooooooooo/velocitydiscord/config/Config.java

@@ -8,12 +8,13 @@
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Objects;
 
 import static ooo.foooooooooooo.velocitydiscord.VelocityDiscord.PluginVersion;
-import static ooo.foooooooooooo.velocitydiscord.config.BaseConfig.get;
 
-public class Config {
+public class Config extends BaseConfig {
   private static final String[] splitVersion = PluginVersion.split("\\.");
   private static final String configVersion = splitVersion[0] + '.' + splitVersion[1];
   private static final String configMajorVersion = splitVersion[0];
@@ -28,12 +29,16 @@ public class Config {
 
   public ListCommandConfig listCommand;
 
+  public List<String> EXCLUDED_SERVERS = new ArrayList<>();
+
   @Inject
   public Config(@DataDirectory Path dataDir) {
     this.dataDir = dataDir;
 
     var config = loadFile();
 
+    loadConfig(config);
+
     bot = new BotConfig(config);
     discord = new DiscordMessageConfig(config);
     minecraft = new MinecraftMessageConfig(config);
@@ -85,4 +90,13 @@ private boolean versionCompatible(String newVersion) {
   public boolean isFirstRun() {
     return bot.isDefaultValues() || configCreatedThisRun;
   }
+
+  @Override
+  protected void loadConfig(com.electronwill.nightconfig.core.Config config) {
+    EXCLUDED_SERVERS = get(config, "exclude_servers", EXCLUDED_SERVERS);
+  }
+
+  public boolean serverDisabled(String name) {
+    return EXCLUDED_SERVERS.contains(name);
+  }
 }

src/main/java/ooo/foooooooooooo/velocitydiscord/discord/Discord.java

@@ -100,6 +100,10 @@ public void onReady(@Nonnull ReadyEvent event) {
     updateActivityPlayerAmount();
   }
 
+  public void shutdown() {
+    jda.shutdown();
+  }
+
   @Subscribe(order = PostOrder.FIRST)
   public void onPlayerChat(PlayerChatEvent event) {
     var currentServer = event.getPlayer().getCurrentServer();
@@ -108,8 +112,13 @@ public void onPlayerChat(PlayerChatEvent event) {
       return;
     }
 
-    var username = event.getPlayer().getUsername();
     var server = currentServer.get().getServerInfo().getName();
+
+    if (config.serverDisabled(server)) {
+      return;
+    }
+
+    var username = event.getPlayer().getUsername();
     var content = event.getMessage();
 
     if (config.bot.ENABLE_MENTIONS) {
@@ -151,15 +160,26 @@ public void onConnect(ServerConnectedEvent event) {
     var username = event.getPlayer().getUsername();
     var server = event.getServer().getServerInfo().getName();
 
+    if (config.serverDisabled(server)) {
+      updateActivityPlayerAmount();
+
+      return;
+    }
+
     var previousServer = event.getPreviousServer();
 
     StringTemplate message = null;
 
     if (previousServer.isPresent()) {
       if (config.discord.SERVER_SWITCH_MESSAGE_FORMAT.isPresent()) {
-
         var previous = previousServer.get().getServerInfo().getName();
 
+        if (config.serverDisabled(previous)) {
+          updateActivityPlayerAmount();
+
+          return;
+        }
+
         message = new StringTemplate(config.discord.SERVER_SWITCH_MESSAGE_FORMAT.get())
           .add("username", username)
           .add("current", server)
@@ -185,6 +205,12 @@ public void onDisconnect(DisconnectEvent event) {
     var username = event.getPlayer().getUsername();
     var server = currentServer.map(serverConnection -> serverConnection.getServerInfo().getName()).orElse("null");
 
+    if (config.serverDisabled(server)) {
+      updateActivityPlayerAmount();
+
+      return;
+    }
+
     String template = currentServer.isPresent() ? config.discord.LEAVE_MESSAGE_FORMAT.orElse(null) : config.discord.DISCONNECT_MESSAGE_FORMAT.orElse(null);
 
     if (template != null) {

src/main/java/ooo/foooooooooooo/velocitydiscord/discord/MessageListener.java

@@ -87,7 +87,6 @@ public void onMessageReceived(@Nonnull MessageReceivedEvent event) {
     var username_chunk = new StringTemplate(config.minecraft.USERNAME_CHUNK_FORMAT)
       .add("role_color", hex)
       .add("username", author.getName())
-      .add("discriminator", author.getDiscriminator())
       .add("nickname", member.getEffectiveName()).toString();
 
     var attachment_chunk = config.minecraft.ATTACHMENT_FORMAT;

src/main/resources/config.toml

@@ -1,5 +1,9 @@
 # Don't change this
-config_version = "1.7"
+config_version = "1.8"
+
+# Comma separated list of server names to exclude from the bridge (defined under [servers] inside your velocity.toml)
+# e.g., exclude_servers = ["lobby", "survival"]
+exclude_servers = []
 
 [discord]
 # Bot token from https://discordapp.com/developers/applications/
@@ -15,6 +19,7 @@ show_attachments_ingame = true
 # Show a text as playing activity of the bot
 show_activity = true
 # Activity text of the bot to show in Discord
+# Placeholders {amount} is available
 activity_text = "with {amount} players online"
 
 # Enable mentioning Discord users from Minecraft chat
@@ -42,25 +47,33 @@ webhook_username = "{username}"
 [discord.chat]
 # The format set in the following key "discord.chat.message" is ignored when a webhook is used
 # Placeholders {username}, {server}, and {message} are available
+# Can be disabled
 message = "{username}: {message}"
 # Placeholders {username} and {server} are available
+# Can be disabled
 join_message = "**{username} joined the game**"
 leave_message = "**{username} left the game**"
 # Possible different format for timeouts or other terminating connections
-# Only placeholder {username} is available
+# Placeholder {username} is available
+# Can be disabled
 disconnect_message = "**{username} disconnected**"
 # Placeholders {username}, {current}, and {previous} are available
+# Can be disabled
 server_switch_message = "**{username} moved to {current} from {previous}**"
 # Placeholders {username} and {death_message} are available
+# Can be disabled
 death_message = "**{username} {death_message}**"
 # Placeholders {username}, {advancement_title}, and {advancement_description} are available
+# Can be disabled
 advancement_message = "**{username} has made the advancement __{advancement_title}__**\n_{advancement_description}_"
 
 [discord.commands.list]
 enabled = true
 # Ephemeral messages are only visible to the user who sent the command
 ephemeral = true
+# Placeholders {server_name}, {online_players} and {max_players} are available
 server_format = "[{server_name} {online_players}/{max_players}]"
+# Placeholder {username} is available
 player_format = "- {username}"
 # Can be disabled
 no_players = "No players online"
@@ -71,9 +84,13 @@ codeblock_lang = "asciidoc"
 # Discord > Minecraft message formats
 # Uses XML-like formatting with https://docs.adventure.kyori.net/minimessage#format
 [minecraft]
+# Placeholder {discord} is available
 discord_chunk = "<dark_gray>[<{discord_color}>Discord<dark_gray>]<reset>"
-username_chunk = "<{role_color}><hover:show_text:{username}#{discriminator}>{nickname}</hover><reset>"
+# Placeholders {role_color}, {username} and {nickname} are available
+username_chunk = "<{role_color}><hover:show_text:{username}>{nickname}</hover><reset>"
+# Placeholders {discord_chunk}, {username_chunk}, {attachments} and {message} are available
 message = "{discord_chunk} {username_chunk}<dark_gray>: <reset>{message} {attachments}"
+# Placeholders {url} and {attachment_color} are available
 attachments = "<dark_gray><click:open_url:{url}>[<{attachment_color}>Attachment<dark_gray>]</click><reset>"
 # Colors for the <{discord_color}> and <{attachment_color}> tags
 discord_color = "#7289da"