use fixed MiniMessage build

- always downsample colors on old version servers which don't support sending rgb colors.

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/minimotd.yml

@@ -0,0 +1,27 @@
+name: MiniMOTD
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - run: sed "s/{BUILDID}/$GITHUB_RUN_NUMBER/g" pom.xml > _pom.xml; rm pom.xml; mv _pom.xml pom.xml
+    - name: Set up JDK 1.8
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: Build with Maven
+      run: mvn clean package
+    - run: mkdir staging && cp target/MiniMOTD*.jar staging
+    - uses: actions/upload-artifact@v1
+      with:
+        name: Package
+        path: staging

pom.xml

@@ -6,12 +6,12 @@
 
     <groupId>xyz.jpenilla</groupId>
     <artifactId>MiniMOTD</artifactId>
-    <version>1.1.2</version>
+    <version>1.2.0</version>
     <packaging>jar</packaging>
 
     <name>MiniMOTD</name>
 
-    <description>Set the server MOTD using MiniMessage!</description>
+    <description>Set the server list MOTD using MiniMessage!</description>
     <properties>
         <java.version>1.8</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -32,7 +32,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
-                <version>3.2.2</version>
+                <version>3.2.4</version>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -83,8 +83,8 @@
 
     <repositories>
         <repository>
-            <id>spigotmc-repo</id>
-            <url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
+            <id>papermc</id>
+            <url>https://papermc.io/repo/repository/maven-public/</url>
         </repository>
         <repository>
             <id>bungeecord-repo</id>
@@ -106,15 +106,15 @@
 
     <dependencies>
         <dependency>
-            <groupId>org.spigotmc</groupId>
-            <artifactId>spigot-api</artifactId>
-            <version>1.12-R0.1-SNAPSHOT</version>
+            <groupId>com.destroystokyo.paper</groupId>
+            <artifactId>paper-api</artifactId>
+            <version>1.16.1-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>net.md-5</groupId>
             <artifactId>bungeecord-api</artifactId>
-            <version>1.16-R0.1</version>
+            <version>1.16-R0.2</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
@@ -133,9 +133,9 @@
             <version>4.0.0-SNAPSHOT</version>
         </dependency>
         <dependency>
-            <groupId>net.kyori</groupId>
+            <groupId>com.github.jmanpenilla</groupId>
             <artifactId>adventure-text-minimessage</artifactId>
-            <version>3.0.0-SNAPSHOT</version>
+            <version>2cb5077c9d</version>
         </dependency>
         <dependency>
             <groupId>com.github.DiamondDagger590</groupId>

src/main/java/xyz/jpenilla/minimotd/bungee/BungeeConfig.java

@@ -1,30 +1,42 @@
 package xyz.jpenilla.minimotd.bungee;
 
+import net.md_5.bungee.api.Favicon;
 import net.md_5.bungee.config.Configuration;
 import net.md_5.bungee.config.ConfigurationProvider;
 import net.md_5.bungee.config.YamlConfiguration;
 import xyz.jpenilla.minimotd.common.MiniMOTDConfig;
 
+import javax.imageio.ImageIO;
+import java.awt.image.BufferedImage;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Files;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.ThreadLocalRandom;
 
 public class BungeeConfig extends MiniMOTDConfig {
     private final MiniMOTD miniMOTD;
+    private final List<Favicon> icons = new ArrayList<>();
 
     public BungeeConfig(MiniMOTD miniMOTD) {
         this.miniMOTD = miniMOTD;
         reload();
     }
 
+    public Favicon getRandomIcon() {
+        if (icons.isEmpty()) {
+            return null;
+        }
+        return icons.get(ThreadLocalRandom.current().nextInt(icons.size()));
+    }
+
     public void reload() {
         final Configuration config = loadFromDisk();
 
         getMotds().clear();
-        for (String motd : config.getStringList(MOTDS)) {
-            getMotds().add(motd.replace("{br}", "\n"));
-        }
+        getMotds().addAll(config.getStringList(MOTDS));
         setMotdEnabled(config.getBoolean(MOTD_ENABLED));
         setMaxPlayersEnabled(config.getBoolean(MAX_PLAYERS_ENABLED));
         setJustXMoreEnabled(config.getBoolean(JUST_X_MORE_ENABLED));
@@ -32,6 +44,28 @@ public class BungeeConfig extends MiniMOTDConfig {
         setXValue(config.getInt(X_VALUE));
         setFakePlayersEnabled(config.getBoolean(FAKE_PLAYERS_ENABLED));
         setFakePlayers(config.getString(FAKE_PLAYERS));
+
+        final File iconFolder = new File(miniMOTD.getDataFolder() + File.separator + "icons");
+        if (!iconFolder.exists()) {
+            iconFolder.mkdir();
+        }
+        this.icons.clear();
+        final File[] icons = iconFolder.listFiles(i -> i.getName().endsWith(".png"));
+        if (icons != null) {
+            for (File icon : icons) {
+                try {
+                    BufferedImage bufferedImage = ImageIO.read(icon);
+                    if (bufferedImage.getHeight() == 64 && bufferedImage.getWidth() == 64) {
+                        this.icons.add(Favicon.create(bufferedImage));
+                    } else {
+                        miniMOTD.getLogger().info("Could not load " + icon.getName() + ": image must be 64x64px");
+                    }
+                } catch (Exception e) {
+                    miniMOTD.getLogger().info("Could not load " + icon.getName() + ": invalid image file");
+                    e.printStackTrace();
+                }
+            }
+        }
     }
 
     private Configuration loadFromDisk() {

src/main/java/xyz/jpenilla/minimotd/bungee/PingListener.java

@@ -3,8 +3,9 @@ package xyz.jpenilla.minimotd.bungee;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import net.kyori.adventure.text.serializer.gson.GsonComponentSerializer;
+import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
+import net.md_5.bungee.api.Favicon;
 import net.md_5.bungee.api.ServerPing;
-import net.md_5.bungee.api.chat.BaseComponent;
 import net.md_5.bungee.api.event.ProxyPingEvent;
 import net.md_5.bungee.api.plugin.Listener;
 import net.md_5.bungee.chat.ComponentSerializer;
@@ -15,6 +16,9 @@ import java.util.concurrent.ThreadLocalRandom;
 
 public class PingListener implements Listener {
     private final BungeeConfig cfg;
+    private final MiniMessage miniMessage = MiniMessage.get();
+    private final LegacyComponentSerializer legacySerializer = LegacyComponentSerializer.builder().build();
+    private final GsonComponentSerializer gsonSerializer = GsonComponentSerializer.builder().build();
 
     public PingListener(MiniMOTD miniMOTD) {
         this.cfg = miniMOTD.getCfg();
@@ -51,13 +55,20 @@ public class PingListener implements Listener {
             players.setMax(maxPlayers);
 
             if (cfg.isMotdEnabled()) {
-                Component motd = MiniMessage.get().parse(cfg.getMOTD(onlinePlayers, maxPlayers));
-                BaseComponent component = ComponentSerializer.parse(GsonComponentSerializer.builder().build().serialize(motd))[0];
-                response.setDescriptionComponent(component);
+                Component motd = miniMessage.parse(cfg.getMOTD(onlinePlayers, maxPlayers));
+                if (e.getConnection().getVersion() < 735) {
+                    motd = legacySerializer.deserialize(legacySerializer.serialize(motd));
+                }
+
+                response.setDescriptionComponent(ComponentSerializer.parse(gsonSerializer.serialize(motd))[0]);
                 //response.setDescriptionComponent(BungeeCordComponentSerializer.get().serialize(motd)[0]);
             }
 
             response.setPlayers(players);
+            final Favicon favicon = cfg.getRandomIcon();
+            if (favicon != null) {
+                response.setFavicon(favicon);
+            }
             e.setResponse(response);
         }
     }

src/main/java/xyz/jpenilla/minimotd/common/MiniMOTDConfig.java

@@ -29,13 +29,16 @@ public abstract class MiniMOTDConfig {
     public abstract void reload();
 
     public String getMOTD(int onlinePlayers, int maxPlayers) {
+        String motd;
         if (motds.size() == 1) {
-            return motds.get(0);
+            motd = motds.get(0);
         } else {
-            return motds.get(new Random().nextInt(motds.size()))
-                    .replace("{onlinePlayers}", String.valueOf(onlinePlayers))
-                    .replace("{maxPlayers}", String.valueOf(maxPlayers));
+            motd = motds.get(new Random().nextInt(motds.size()));
         }
+        return motd
+                .replace("{onlinePlayers}", String.valueOf(onlinePlayers))
+                .replace("{maxPlayers}", String.valueOf(maxPlayers))
+                .replace("{br}", "\n");
     }
 
     public int getAdjustedMaxPlayers(int onlinePlayers, int actualMaxPlayers) {

src/main/java/xyz/jpenilla/minimotd/spigot/MiniMOTD.java

@@ -3,22 +3,50 @@ package xyz.jpenilla.minimotd.spigot;
 import lombok.Getter;
 import org.bstats.bukkit.Metrics;
 import org.bukkit.Bukkit;
+import org.bukkit.command.PluginCommand;
 import org.bukkit.plugin.java.JavaPlugin;
 
 public final class MiniMOTD extends JavaPlugin {
+    @Getter private static MiniMOTD instance;
     @Getter private SpigotConfig cfg;
     @Getter private PrismaHook prisma;
-    @Getter private static MiniMOTD instance;
+    @Getter private boolean isPaperServer;
+    @Getter private String serverPackageName;
+    @Getter private String serverApiVersion;
+    @Getter private int majorMinecraftVersion;
 
     @Override
     public void onEnable() {
+        serverPackageName = this.getServer().getClass().getPackage().getName();
+        serverApiVersion = serverPackageName.substring(serverPackageName.lastIndexOf('.') + 1);
+        majorMinecraftVersion = Integer.parseInt(serverApiVersion.split("_")[1]);
+
+        try {
+            Class.forName("com.destroystokyo.paper.event.server.PaperServerListPingEvent");
+            isPaperServer = true;
+        } catch (ClassNotFoundException e) {
+            isPaperServer = false;
+        }
         instance = this;
         if (Bukkit.getPluginManager().isPluginEnabled("Prisma")) {
             prisma = new PrismaHook();
         }
         this.cfg = new SpigotConfig(this);
-        getServer().getPluginManager().registerEvents(new PingListener(this), this);
-        getCommand("minimotd").setExecutor(new SpigotCommand(this));
+        if (isPaperServer) {
+            getServer().getPluginManager().registerEvents(new PaperPingListener(this), this);
+        } else {
+            getServer().getPluginManager().registerEvents(new PingListener(this), this);
+            if (majorMinecraftVersion > 11) {
+                getLogger().info("This server is not using Paper, and therefore some features may be limited or disabled.");
+                getLogger().info("Get Paper from https://papermc.io/downloads");
+            }
+        }
+        final PluginCommand command = getCommand("minimotd");
+        if (command != null) {
+            command.setExecutor(new SpigotCommand(this));
+            command.setTabCompleter(new SpigotCommand(this));
+        }
+
         Metrics metrics = new Metrics(this, 8132);
     }
 }

src/main/java/xyz/jpenilla/minimotd/spigot/PaperPingListener.java

@@ -0,0 +1,64 @@
+package xyz.jpenilla.minimotd.spigot;
+
+import com.destroystokyo.paper.event.server.PaperServerListPingEvent;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.minimessage.MiniMessage;
+import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+import org.bukkit.util.CachedServerIcon;
+
+import java.util.concurrent.ThreadLocalRandom;
+
+public class PaperPingListener implements Listener {
+    private final SpigotConfig cfg;
+    private final MiniMOTD miniMOTD;
+    private final LegacyComponentSerializer serializer = LegacyComponentSerializer.builder().hexColors().useUnusualXRepeatedCharacterHexFormat().build();
+    private final MiniMessage miniMessage = MiniMessage.get();
+    private final LegacyComponentSerializer legacySerializer = LegacyComponentSerializer.builder().build();
+
+    public PaperPingListener(MiniMOTD miniMOTD) {
+        this.cfg = miniMOTD.getCfg();
+        this.miniMOTD = miniMOTD;
+    }
+
+    @EventHandler
+    public void onPing(PaperServerListPingEvent e) {
+        int onlinePlayers = e.getNumPlayers();
+        if (cfg.isFakePlayersEnabled()) {
+            try {
+                if (cfg.getFakePlayers().contains(":")) {
+                    final String[] fakePlayers = cfg.getFakePlayers().split(":");
+                    final int start = Integer.parseInt(fakePlayers[0]);
+                    final int end = Integer.parseInt(fakePlayers[1]);
+                    onlinePlayers = onlinePlayers + ThreadLocalRandom.current().nextInt(start, end);
+                } else if (cfg.getFakePlayers().contains("%")) {
+                    final double factor = 1 + (Double.parseDouble(cfg.getFakePlayers().replace("%", "")) / 100);
+                    onlinePlayers = (int) Math.ceil(factor * onlinePlayers);
+                } else {
+                    final int addedPlayers = Integer.parseInt(cfg.getFakePlayers());
+                    onlinePlayers = onlinePlayers + addedPlayers;
+                }
+            } catch (NumberFormatException ex) {
+                System.out.println("[MiniMOTD] fakePlayers config incorrect");
+            }
+        }
+        e.setNumPlayers(onlinePlayers);
+
+        int maxPlayers = cfg.getAdjustedMaxPlayers(onlinePlayers, e.getMaxPlayers());
+        e.setMaxPlayers(maxPlayers);
+
+        if (cfg.isMotdEnabled()) {
+            final Component motd = miniMessage.parse(cfg.getMOTD(onlinePlayers, maxPlayers));
+            if (e.getClient().getProtocolVersion() < 735 || miniMOTD.getMajorMinecraftVersion() < 16) {
+                e.setMotd(legacySerializer.serialize(motd));
+            } else {
+                e.setMotd(serializer.serialize(motd));
+            }
+        }
+        final CachedServerIcon favicon = cfg.getRandomIcon();
+        if (favicon != null) {
+            e.setServerIcon(favicon);
+        }
+    }
+}

src/main/java/xyz/jpenilla/minimotd/spigot/PingListener.java

@@ -1,14 +1,22 @@
 package xyz.jpenilla.minimotd.spigot;
 
+import net.kyori.adventure.text.minimessage.MiniMessage;
+import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
 import org.bukkit.event.server.ServerListPingEvent;
+import org.bukkit.util.CachedServerIcon;
 
 public class PingListener implements Listener {
     private final SpigotConfig cfg;
+    private final MiniMOTD miniMOTD;
+    private final LegacyComponentSerializer serializer = LegacyComponentSerializer.builder().hexColors().useUnusualXRepeatedCharacterHexFormat().build();
+    private final LegacyComponentSerializer legacySerializer = LegacyComponentSerializer.builder().build();
+    private final MiniMessage miniMessage = MiniMessage.get();
 
     public PingListener(MiniMOTD miniMOTD) {
         this.cfg = miniMOTD.getCfg();
+        this.miniMOTD = miniMOTD;
     }
 
     @EventHandler
@@ -20,7 +28,15 @@ public class PingListener implements Listener {
         e.setMaxPlayers(maxPlayers);
 
         if (cfg.isMotdEnabled()) {
-            e.setMotd(cfg.getMOTD(onlinePlayers, maxPlayers));
+            if (miniMOTD.getMajorMinecraftVersion() > 15) {
+                e.setMotd(serializer.serialize(miniMessage.parse(cfg.getMOTD(onlinePlayers, maxPlayers))));
+            } else {
+                e.setMotd(legacySerializer.serialize(miniMessage.parse(cfg.getMOTD(onlinePlayers, maxPlayers))));
+            }
+        }
+        final CachedServerIcon favicon = cfg.getRandomIcon();
+        if (favicon != null) {
+            e.setServerIcon(favicon);
         }
     }
 }

src/main/java/xyz/jpenilla/minimotd/spigot/SpigotCommand.java

@@ -1,17 +1,21 @@
 package xyz.jpenilla.minimotd.spigot;
 
+import com.google.common.collect.ImmutableList;
 import lombok.NonNull;
 import net.kyori.adventure.platform.bukkit.BukkitAudiences;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import org.bukkit.command.Command;
 import org.bukkit.command.CommandExecutor;
 import org.bukkit.command.CommandSender;
+import org.bukkit.command.TabCompleter;
 import org.bukkit.entity.Player;
+import org.bukkit.util.StringUtil;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
-public class SpigotCommand implements CommandExecutor {
+public class SpigotCommand implements CommandExecutor, TabCompleter {
     private final MiniMOTD miniMOTD;
     private final BukkitAudiences audience;
     private final MiniMessage miniMessage;
@@ -95,4 +99,16 @@ public class SpigotCommand implements CommandExecutor {
             send(sender, message);
         }
     }
+
+    private static final List<String> COMMANDS = ImmutableList.of("about", "reload", "help");
+
+    @Override
+    public List<String> onTabComplete(CommandSender sender, Command command, String alias, String[] args) {
+        final List<String> completions = new ArrayList<>();
+        if (args.length < 2 && sender.hasPermission("minimotd.admin")) {
+            StringUtil.copyPartialMatches(args[0], COMMANDS, completions);
+            Collections.sort(completions);
+        }
+        return completions;
+    }
 }

src/main/java/xyz/jpenilla/minimotd/spigot/SpigotConfig.java

@@ -1,12 +1,20 @@
 package xyz.jpenilla.minimotd.spigot;
 
-import net.kyori.adventure.text.minimessage.MiniMessage;
-import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
+import org.bukkit.Bukkit;
 import org.bukkit.configuration.file.FileConfiguration;
+import org.bukkit.util.CachedServerIcon;
 import xyz.jpenilla.minimotd.common.MiniMOTDConfig;
 
+import javax.imageio.ImageIO;
+import java.awt.image.BufferedImage;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.ThreadLocalRandom;
+
 public class SpigotConfig extends MiniMOTDConfig {
     private final MiniMOTD miniMOTD;
+    private final List<CachedServerIcon> icons = new ArrayList<>();
 
     public SpigotConfig(MiniMOTD miniMOTD) {
         this.miniMOTD = miniMOTD;
@@ -14,6 +22,13 @@ public class SpigotConfig extends MiniMOTDConfig {
         reload();
     }
 
+    public CachedServerIcon getRandomIcon() {
+        if (icons.isEmpty()) {
+            return null;
+        }
+        return icons.get(ThreadLocalRandom.current().nextInt(icons.size()));
+    }
+
     public void reload() {
         miniMOTD.reloadConfig();
         final FileConfiguration config = miniMOTD.getConfig();
@@ -26,16 +41,36 @@ public class SpigotConfig extends MiniMOTDConfig {
             } else {
                 temp = motd;
             }
-            getMotds().add(miniMessageToLegacy(temp.replace("{br}", "\n")));
+            getMotds().add(temp);
         }
         setMotdEnabled(config.getBoolean(MOTD_ENABLED));
         setMaxPlayersEnabled(config.getBoolean(MAX_PLAYERS_ENABLED));
         setJustXMoreEnabled(config.getBoolean(JUST_X_MORE_ENABLED));
         setMaxPlayers(config.getInt(MAX_PLAYERS));
         setXValue(config.getInt(X_VALUE));
-    }
+        setFakePlayersEnabled(config.getBoolean(FAKE_PLAYERS_ENABLED));
+        setFakePlayers(config.getString(FAKE_PLAYERS));
 
-    private String miniMessageToLegacy(String message) {
-        return LegacyComponentSerializer.builder().hexColors().useUnusualXRepeatedCharacterHexFormat().build().serialize(MiniMessage.get().parse(message));
+        final File iconFolder = new File(miniMOTD.getDataFolder() + File.separator + "icons");
+        if (!iconFolder.exists()) {
+            iconFolder.mkdir();
+        }
+        this.icons.clear();
+        final File[] icons = iconFolder.listFiles(i -> i.getName().endsWith(".png"));
+        if (icons != null) {
+            for (File icon : icons) {
+                try {
+                    BufferedImage bufferedImage = ImageIO.read(icon);
+                    if (bufferedImage.getHeight() == 64 && bufferedImage.getWidth() == 64) {
+                        this.icons.add(Bukkit.loadServerIcon(bufferedImage));
+                    } else {
+                        miniMOTD.getLogger().info("Could not load " + icon.getName() + ": image must be 64x64px");
+                    }
+                } catch (Exception e) {
+                    miniMOTD.getLogger().info("Could not load " + icon.getName() + ": invalid image file");
+                    e.printStackTrace();
+                }
+            }
+        }
     }
 }

src/main/resources/bungee.yml

@@ -2,4 +2,4 @@ name: MiniMOTD
 version: ${project.version}
 main: xyz.jpenilla.minimotd.bungee.MiniMOTD
 author: jmp
-description: Set the MOTD using MiniMessage!
+description: Set the server list MOTD using MiniMessage!

src/main/resources/config.yml

@@ -21,6 +21,9 @@ maxPlayers:
   justXMoreEnabled: false
   xValue: 3
 
+# These options work on Paper Servers as well as BungeeCord or Waterfall based proxies
+# These options do not work on pure Spigot Servers as the API methods are missing
+# Get Paper here: https://papermc.io/downloads
 bungeeOnly:
   # Do you want to enable this feature?
   fakePlayersEnabled: false

src/main/resources/plugin.yml

@@ -1,10 +1,10 @@
 name: MiniMOTD
 version: ${project.version}
 main: xyz.jpenilla.minimotd.spigot.MiniMOTD
-load: STARTUP
 softdepend: [Prisma]
 authors: [jmp]
-description: Set the server MOTD using MiniMessage!
+api-version: 1.13
+description: Set the server list MOTD using MiniMessage!
 website: https://www.spigotmc.org/resources/minimotd.81254/
 commands:
   minimotd: