Update Matchbot to JDA (#2)

* Update pom.xml

* Update to work with JDA Update

* upgrades

* cleaned up config
* update jda
* use maven properties to fill in plugin details
* fix match durations
* show server name

* Code Cleanup

* Embed, README, and bot status fixes

---------

Co-authored-by: Pear <20259871+TheRealPear@users.noreply.github.com>

Author: Fishywishi

README.md

@@ -7,7 +7,7 @@ This project's structure is a modified version of [Bolty](https://github.com/app
 
 MatchBot will listen to [`MatchStartEvent`](https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/api/match/event/MatchStartEvent.java) and [`MatchFinishEvent`](https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/api/match/event/MatchFinishEvent.java) to populate a Discord [embed](https://javacord.org/wiki/basic-tutorials/embeds.html#creating-an-embed) with information about a started or finished match.
 
-MatchBot is built with [Javacord](https://javacord.org/), an awesome Java library for Discord bots.
+MatchBot is built with [JDA](https://jda.wiki/), an awesome Java library for Discord bots.
 
 This bot runs on a single Minecraft server, and is not designed with proxies, networks, or multiple servers in mind.
 
@@ -49,12 +49,18 @@ You can also find out how to get server, role or channel IDs [here](https://supp
 ## Config
 
 ```yaml
-# Discord Stuff
-enabled: true # Enable discord bot?
+# MatchBot configuration file
+# Discord settings
+enabled: true # Enable Discord bot?
 token: "" # Discord bot token
-server: "" # ID of discord server
+server: "" # ID of Discord server
+match-channel: "" # ID of channel where match embeds will be sent
 
-# ID of channel where match embeds will be sent
-match-channel: ""
+# Minecraft settings
+server-name: "" # Name of the server (useful for networks)
+
+# Image URL to display in the embed's thumbnail if a map image is not found
+# Example: https://raw.githubusercontent.com/TBG1000/MapImages/main/map_image_not_found.png
+map-image-not-found: ""
 ```
 

pom.xml

@@ -6,7 +6,7 @@
     <artifactId>MatchBot</artifactId>
     <version>1.0.0-SNAPSHOT</version>
     <name>MatchBot</name>
-    <description>A minecraft to discord java plugin</description>
+    <description>A Minecraft-to-Discord bot to display PGM match information in a channel.</description>
 
     <!-- Repository Locations -->
     <repositories>
@@ -43,12 +43,18 @@
         <dependency>
             <groupId>net.dv8tion</groupId>
             <artifactId>JDA</artifactId>
-            <version>5.0.0-beta.24</version>
+            <version>6.2.0</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>club.minnced</groupId>
+                    <artifactId>opus-java</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
     </dependencies>
     <build>
         <resources>
-            <!-- Include the required plugin.yml and config.yml for Bukkit -->
+            <!-- Include the required files for Bukkit -->
             <resource>
                 <directory>${basedir}/src/main/resources</directory>
                 <filtering>true</filtering>
@@ -71,7 +77,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
-                <version>3.2.3</version>
+                <version>3.6.1</version>
                 <configuration>
                     <createDependencyReducedPom>false</createDependencyReducedPom>
                     <minimizeJar>true</minimizeJar>
@@ -123,7 +129,7 @@
             <plugin>
                 <groupId>com.diffplug.spotless</groupId>
                 <artifactId>spotless-maven-plugin</artifactId>
-                <version>2.43.0</version>
+                <version>3.1.0</version>
                 <configuration>
                     <ratchetFrom>origin/dev</ratchetFrom>
                     <java>

src/main/java/me/tbg/match/bot/BotConfig.java

@@ -9,7 +9,7 @@ public class BotConfig {
     private String token;
     private String serverId;
     private String matchChannel;
-    private String fallbackMapImages;
+    private String serverName;
     private String mapImageNotFound;
 
     public BotConfig(Configuration config) {
@@ -21,7 +21,7 @@ public void reload(Configuration config) {
         this.token = config.getString("token");
         this.serverId = config.getString("server");
         this.matchChannel = config.getString("match-channel");
-        this.fallbackMapImages = config.getString("fallback-map-images");
+        this.serverName = config.getString("server-name");
         this.mapImageNotFound = config.getString("map-image-not-found");
     }
 
@@ -41,9 +41,7 @@ public String getMatchChannel() {
         return matchChannel;
     }
 
-    public String getFallbackMapImages() {
-        return fallbackMapImages;
-    }
+    public String getServerName() { return serverName; }
 
     public String getMapImageNotFound() {
         return mapImageNotFound;

src/main/java/me/tbg/match/bot/DiscordBot.java

@@ -14,10 +14,15 @@
 import net.dv8tion.jda.api.JDABuilder;
 import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.entities.Activity;
-import net.dv8tion.jda.api.entities.TextChannel;
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.Message;
+import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
 import net.dv8tion.jda.api.requests.GatewayIntent;
+import net.dv8tion.jda.api.requests.restaction.MessageCreateAction;
+import net.dv8tion.jda.api.utils.AttachedFile;
+import net.dv8tion.jda.api.utils.FileUpload;
+import net.dv8tion.jda.api.utils.messages.MessageCreateBuilder;
+import net.dv8tion.jda.api.utils.messages.MessageCreateData;
 import tc.oc.pgm.api.PGM;
 import tc.oc.pgm.api.Permissions;
 import tc.oc.pgm.api.map.Contributor;
@@ -79,12 +84,18 @@ public void disable() {
 
     public void sendMatchEmbed(EmbedBuilder embed, Match match) {
         if (api != null) {
-            api.getPresence().setActivity(Activity.playing(match.getMap().getName()));
+            api.getPresence().setActivity(Activity.playing("Playing " + match.getMap().getName() + " on " + config.getServerName()));
+            if (config.getServerName().isEmpty()) {
+                api.getPresence().setActivity(Activity.playing("Playing " + match.getMap().getName()));
+            }
             Guild guild = api.getGuildById(config.getServerId());
             if (guild != null) {
                 TextChannel textChannel = guild.getTextChannelById(config.getMatchChannel());
                 if (textChannel != null) {
-                    textChannel.sendMessageEmbeds(embed.build()).queue(message -> {
+                    File imgFile = new File(match.getMap().getSource().getAbsoluteDir().toFile(), "map.png");
+                    MessageCreateAction messageAction = (imgFile.exists()) ? textChannel.sendFiles(FileUpload.fromData(imgFile, "map.png")).setEmbeds(embed.build())
+                            : textChannel.sendMessageEmbeds(embed.build());
+                    messageAction.queue(message -> {
                         matchMessageMap.put(Long.valueOf(match.getId()), message.getIdLong());
                     });
                 }
@@ -108,26 +119,22 @@ public void editMatchEmbed(long matchId, EmbedBuilder newEmbed) {
     }
 
     public EmbedBuilder setEmbedThumbnail(MapInfo map, EmbedBuilder embed, DiscordBot bot) {
-        try {
-            embed.setThumbnail(bot.getMapImage(map));
-            return embed;
-        } catch (IOException e) {
-            if (!bot.getConfig().getFallbackMapImages().isEmpty()) {
-                String mapName = map.getName().replace(" ", "%20");
-                embed.setThumbnail(bot.getConfig().getFallbackMapImages() + mapName + "/map.png");
-                return embed;
-            } else if (!bot.getConfig().getMapImageNotFound().isEmpty()) {
+        File imgFile = new File(map.getSource().getAbsoluteDir().toFile(), "map.png");
+        if (!imgFile.exists()) {
+            if (!bot.getConfig().getMapImageNotFound().isEmpty()) {
                 embed.setThumbnail(bot.getConfig().getMapImageNotFound());
                 return embed;
             }
+            return embed;
         }
+        embed.setThumbnail("attachment://map.png");
         return embed;
     }
 
     public String parseDuration(Duration duration) {
         long hours = duration.toHours();
-        long minutes = duration.toMinutes();
-        long seconds = duration.getSeconds();
+        long minutes = duration.toMinutes() % 60;
+        long seconds = duration.getSeconds() % 60;
 
         StringBuilder result = new StringBuilder();
 
@@ -176,12 +183,6 @@ public String getMatchDescription(Match match) {
                 + (playerCount == 1 ? " player" : " players") + "** online.";
     }
 
-    public BufferedImage getMapImage(MapInfo map) throws IOException {
-        Path sourceDir = map.getSource().getAbsoluteDir();
-        File pngFile = new File(sourceDir.toFile(), "map.png");
-        return ImageIO.read(pngFile);
-    }
-
     public long getOnlineStaffCount(Match match) {
         // Adapted from
         // https://github.com/PGMDev/PGM/blob/dev/core/src/main/java/tc/oc/pgm/command/MapCommand.java

src/main/java/me/tbg/match/bot/MatchFinishListener.java

@@ -25,6 +25,7 @@ public MatchFinishListener(DiscordBot bot) {
 
     @EventHandler
     public void onMatchFinish(MatchFinishEvent event) {
+        BotConfig config = bot.getConfig();
         Match match = event.getMatch();
         MapInfo map = match.getMap();
         ScoreMatchModule scoreModule = match.getModule(ScoreMatchModule.class);
@@ -34,7 +35,7 @@ public void onMatchFinish(MatchFinishEvent event) {
         Color winnerColor = getWinnerColor(event);
 
         EmbedBuilder matchFinishEmbed =
-                createMatchFinishEmbed(match, map, winner, winnerColor, scoreModule, teamModule);
+                createMatchFinishEmbed(config, match, map, winner, winnerColor, scoreModule, teamModule);
 
         bot.editMatchEmbed(Long.parseLong(match.getId()), matchFinishEmbed);
     }
@@ -58,6 +59,7 @@ private Color getWinnerColor(MatchFinishEvent event) {
     }
 
     private EmbedBuilder createMatchFinishEmbed(
+            BotConfig config,
             Match match,
             MapInfo map,
             String winner,
@@ -98,7 +100,7 @@ private EmbedBuilder createMatchFinishEmbed(
                 .addField("Participants", String.valueOf(match.getParticipants().size()), true)
                 .addField("Observers", String.valueOf(match.getDefaultParty().getPlayers().size()), true)
                 .addField("Staff", String.valueOf(bot.getOnlineStaffCount(match)), true)
-                .setFooter("Map tags: " + map.getTags().toString());
+                .setFooter((!config.getServerName().isEmpty() ? "Server: " + config.getServerName() + " • " : "") + "Map tags: " + map.getTags().toString());
 
         bot.setEmbedThumbnail(map, embed, bot);
 

src/main/java/me/tbg/match/bot/MatchStartListener.java

@@ -23,7 +23,7 @@ public MatchStartListener(DiscordBot bot) {
     public void onMatchStart(MatchStartEvent event) {
         Match match = event.getMatch();
         MapInfo map = match.getMap();
-        EmbedBuilder matchStartEmbed = createMatchStartEmbed(match, map);
+        EmbedBuilder matchStartEmbed = createMatchStartEmbed(match, map, bot.getConfig());
 
         bot.setEmbedThumbnail(map, matchStartEmbed, bot);
         bot.sendMatchEmbed(matchStartEmbed, match);
@@ -33,7 +33,7 @@ public void onMatchStart(MatchStartEvent event) {
                 match.getPlayers().size());
     }
 
-    private EmbedBuilder createMatchStartEmbed(Match match, MapInfo map) {
+    private EmbedBuilder createMatchStartEmbed(Match match, MapInfo map, BotConfig config) {
         return new EmbedBuilder()
                 .setColor(Color.WHITE.getRGB())
                 .setTitle("Match #" + match.getId() + " has started!")
@@ -45,6 +45,8 @@ private EmbedBuilder createMatchStartEmbed(Match match, MapInfo map) {
                 .addField("Pools", bot.getMapPools(match), true)
                 .addField("Objective", map.getDescription(), false)
                 .addField("Participants", String.valueOf(match.getParticipants().size()), true)
-                .addField("Observers", String.valueOf(match.getDefaultParty().getPlayers().size()), true);
+                .addField("Observers", String.valueOf(match.getDefaultParty().getPlayers().size()), true)
+                .setFooter((!config.getServerName().isEmpty() ? "Server: " + config.getServerName() + " • " : "") + "Map tags: " + map.getTags().toString());
+
     }
 }

src/main/resources/config.yml

@@ -1,16 +1,13 @@
-# Discord Stuff
-enabled: true # Enable discord bot?
+# MatchBot configuration file
+# Discord settings
+enabled: true # Enable Discord bot?
 token: "" # Discord bot token
-server: "" # ID of discord server
+server: "" # ID of Discord server
+match-channel: "" # ID of channel where match embeds will be sent
 
-# ID of channel where match embeds will be sent
-match-channel: ""
+# Minecraft settings
+server-name: "" # Name of the server (useful for networks)
 
-# Fallback URL for map.png images
-# This will be used in case no map.png is found the map's directory
-# Example: https://raw.githubusercontent.com/TBG1000/MapImages/main/Maps/
-fallback-map-images: ""
-
-# Image URL to display in the embed's thumbnail if no image is found
+# Image URL to display in the embed's thumbnail if a map image is not found
 # Example: https://raw.githubusercontent.com/TBG1000/MapImages/main/map_image_not_found.png
 map-image-not-found: ""

src/main/resources/paper-plugin.yml

@@ -0,0 +1,14 @@
+name: ${project.name}
+description: ${project.description}
+version: '${project.version}'
+api-version: '1.21.10'
+main: me.tbg.match.bot.MatchBot
+author: TBG1000
+website: https://github.com/TBG1000/MatchBot
+
+dependencies:
+  server:
+    PGM:
+      load: BEFORE
+      required: true
+      join-classpath: true

src/main/resources/plugin.yml

@@ -1,6 +1,7 @@
-name: MatchBot
-main: me.tbg.match.bot.MatchBot
-description: A Minecraft to Discord bot. Display PGM match information in Discord.
+name: ${project.name}
+description: ${project.description}
 version: ${project.version}
+main: me.tbg.match.bot.MatchBot
 author: TBG1000
+website: https://github.com/TBG1000/MatchBot
 depend: [PGM]