New features: Unique Rumors, Trade Support, Player Count

Sindusk · Sindusk · commit 49d787697aff · 2018-05-06T05:00:28.000-04:00
Restructured properties file.
Fixed a nasty bug occurring with Discord service interruptions.
Minor other various tweaks and fixes.
diff --git a/build.gradle b/build.gradle
@@ -13,7 +13,7 @@ apply plugin: 'com.github.johnrengelman.shadow'
 
 group = 'org.nyxcode.wurm'
 
-version = '1.0'
+version = '2.0'
 
 description = "A mod that acts as a discord relay between Wurm kingdom chat and a discord server"
 
@@ -29,8 +29,8 @@ repositories {
 }
 dependencies {
     compile 'net.dv8tion:JDA:3.3.1_289'
-    compile 'org.gotti.wurmunlimited:server-modlauncher:0.33-beta1'
-    compile 'com.github.Sindusk:sindusklibrary:v1.0'
+    compile 'org.gotti.wurmunlimited:server-modlauncher:0.35-beta1'
+    compile 'com.github.Sindusk:sindusklibrary:v1.1'
 }
 
 jar {
@@ -39,7 +39,7 @@ jar {
 
 shadowJar {
     dependencies {
-        exclude(dependency('org.gotti.wurmunlimited:server-modlauncher:0.33-beta1'))
+        exclude(dependency('org.gotti.wurmunlimited:server-modlauncher:0.35-beta1'))
         exclude(dependency('org.gotti.wurmunlimited:common:2182584'))
         exclude(dependency('org.gotti.wurmunlimited:server:2182584'))
     }
diff --git a/mods/DiscordRelay.properties b/mods/DiscordRelay.properties
@@ -2,23 +2,32 @@ classname=org.nyxcode.wurm.discordrelay.DiscordRelay
 classpath=*.jar,libs/*.jar
 sharedClassLoader=true
 
-# Required
-# Discord bot token
+# botToken: Discord bot token. This is the client secret that can be found when reviewing the information for your bot at the following link:
+# https://discordapp.com/developers/applications/me
+# The above link is also where you would create your bot, if you're unfamiliar with Discord bot creation.
+# Image assistance: https://i.imgur.com/NHctYHO.png
 botToken=
 
-# Required
-# Discord server to connect to
+# discordServerName: Discord server to connect to (not case sensitive).
 discordServerName=ServerName
 
-# Required
-# In game relay identification
-# Player name in Wurm that will prefix all discord messages
-wurmBotName=ServerBot
+# useUnderscore: This will determine whether to replace white space with underscores or remove whitespace entirely.
+# Example: True - #ca_help. False - #cahelp
+useUnderscore=true
 
-# Optional
-# true: Kingdom names that contain space will have matching discord
-# channels with spaces replaced by underscores (Freedom Isles -> freedom_isles)
-#
-# false: Kingdom names that contain space will have matching discord
-# channels without them (Freedom Isles -> freedomisles)
-useUnderscore=true
+# showConnectedPlayers: Whether or not to show the amount of players connected as the "game" description of the bot in Discord.
+showConnectedPlayers=true
+# connectedPlayerUpdateInterval: How long, in seconds, before each update of the amount of connected players.
+# Note that the bot can only update at maximum 5 times per minute, so this value should never be set below 12.
+# My personal recommendation is to ensure a minimum of 30 seconds. The default is 120.
+connectedPlayerUpdateInterval=120
+
+# enableRumors: Whether to announce unique rumors to Discord.
+enableRumors=true
+# rumorChannel: Which channel to announce unique rumors to.
+#rumorChannel=rumors
+
+# enableTrade: Whether or not to enable the global trade relay.
+# Any messages sent to trade in-game will be relayed to a global #trade channel in Discord.
+# Any messages sent to the #trade channel in Discord will be relayed in-game to all kingdom's trade chats.
+enableTrade=true
diff --git a/src/main/java/org/nyxcode/wurm/discordrelay/DiscordRelay.java b/src/main/java/org/nyxcode/wurm/discordrelay/DiscordRelay.java
@@ -1,9 +1,6 @@
 package org.nyxcode.wurm.discordrelay;
 
-import com.wurmonline.server.Message;
-import com.wurmonline.server.Players;
-import com.wurmonline.server.Server;
-import com.wurmonline.server.Servers;
+import com.wurmonline.server.*;
 import com.wurmonline.server.creatures.Communicator;
 import com.wurmonline.server.creatures.Creature;
 import com.wurmonline.server.kingdom.Kingdom;
@@ -38,18 +35,23 @@
 /**
  * Created by whisper2shade on 22.04.2017.
  */
-public class DiscordRelay extends ListenerAdapter implements WurmServerMod, PreInitable, Configurable, ChannelMessageListener, PlayerMessageListener {
+public class DiscordRelay extends ListenerAdapter implements WurmServerMod, PreInitable, Configurable, ServerPollListener, ChannelMessageListener, PlayerMessageListener {
     public static final Logger logger = Logger.getLogger(DiscordRelay.class.getName());
 
-    private static JDA jda;
-    private static String botToken;
-    private static String serverName;
+    protected static JDA jda;
+    protected static String botToken = "";
+    protected static String serverName = "";
     //private String wurmBotName;
-    private boolean useUnderscore;
+    protected static boolean useUnderscore = false;
+    protected static boolean showConnectedPlayers = true;
+    protected static int connectedPlayerUpdateInterval = 120;
+    protected static boolean enableRumors = true;
+    protected static String rumorChannel = "rumors";
+    protected static boolean enableTrade = true;
 
 
     public static void sendRumour(Creature creature){
-        sendToDiscord("rumors", "Rumours of " + creature.getName() + " are starting to spread.", true);
+        sendToDiscord(rumorChannel, "Rumours of " + creature.getName() + " are starting to spread.", true);
     }
 
     @Override
@@ -65,49 +67,63 @@ public void preInit() {
 
         // - Send rumour messages to discord - //
         try {
-            CtClass ctCreature = classPool.get("com.wurmonline.server.creatures.Creature");
-            CtClass[] params1 = {
-                    CtClass.intType,
-                    CtClass.booleanType,
-                    CtClass.floatType,
-                    CtClass.floatType,
-                    CtClass.floatType,
-                    CtClass.intType,
-                    classPool.get("java.lang.String"),
-                    CtClass.byteType,
-                    CtClass.byteType,
-                    CtClass.byteType,
-                    CtClass.booleanType,
-                    CtClass.byteType,
-                    CtClass.intType
-            };
-            String desc1 = Descriptor.ofMethod(ctCreature, params1);
-            Util.setReason("Send rumour messages to Discord.");
-            String replace = "$proceed($$);"
-                    + DiscordRelay.class.getName()+".sendRumour(toReturn);";
-            Util.instrumentDescribed(thisClass, ctCreature, "doNew", desc1, "broadCastSafe", replace);
+            if(enableRumors) {
+                CtClass ctCreature = classPool.get("com.wurmonline.server.creatures.Creature");
+                CtClass[] params1 = {
+                        CtClass.intType,
+                        CtClass.booleanType,
+                        CtClass.floatType,
+                        CtClass.floatType,
+                        CtClass.floatType,
+                        CtClass.intType,
+                        classPool.get("java.lang.String"),
+                        CtClass.byteType,
+                        CtClass.byteType,
+                        CtClass.byteType,
+                        CtClass.booleanType,
+                        CtClass.byteType,
+                        CtClass.intType
+                };
+                String desc1 = Descriptor.ofMethod(ctCreature, params1);
+                Util.setReason("Send rumour messages to Discord.");
+                String replace = "$proceed($$);"
+                        + DiscordRelay.class.getName() + ".sendRumour(toReturn);";
+                Util.instrumentDescribed(thisClass, ctCreature, "doNew", desc1, "broadCastSafe", replace);
+            }
         } catch (NotFoundException e) {
             e.printStackTrace();
         }
     }
 
     @Override
     public void configure(Properties properties) {
-        botToken = properties.getProperty("botToken");
-        serverName = properties.getProperty("discordServerName");
-        //wurmBotName = properties.getProperty("wurmBotName");
-        useUnderscore = Boolean.parseBoolean(properties.getProperty("useUnderscore", "false"));
+        botToken = properties.getProperty("botToken", botToken);
+        if(botToken.equals("")){
+            logger.warning("Discord bot token not entered for DiscordRelay. The bot will not function without this.");
+        }
+        serverName = properties.getProperty("discordServerName", serverName);
+        if(serverName.equals("")){
+            logger.warning("Server name not entered for DiscordRelay. The bot will not function without this.");
+        }
+        useUnderscore = Boolean.parseBoolean(properties.getProperty("useUnderscore", Boolean.toString(useUnderscore)));
+        showConnectedPlayers = Boolean.parseBoolean(properties.getProperty("showConnectedPlayers", Boolean.toString(showConnectedPlayers)));
+        connectedPlayerUpdateInterval = Integer.parseInt(properties.getProperty("connectedPlayerUpdateInterval", Integer.toString(connectedPlayerUpdateInterval)));
+        pollPlayerInterval = TimeConstants.SECOND_MILLIS*connectedPlayerUpdateInterval;
+        enableRumors = Boolean.parseBoolean(properties.getProperty("enableRumors", Boolean.toString(enableRumors)));
+        rumorChannel = properties.getProperty("rumorChannel", rumorChannel);
+        enableTrade = Boolean.parseBoolean(properties.getProperty("enableTrade", Boolean.toString(enableTrade)));
     }
 
     private static final DateFormat df = new SimpleDateFormat("HH:mm:ss");
     public static void sendToDiscord(String channel, String message, boolean includeMap){
         MessageBuilder builder = new MessageBuilder();
         message = "[" + df.format(new Date(System.currentTimeMillis())) + "] "+message; // Add timestamp
-        message = message + "(" + Servers.localServer.mapname + ")";
+        if(includeMap) {
+            message = message + " (" + Servers.localServer.mapname + ")";
+        }
 
         builder.append(message);
         try {
-            jda.getPresence().setGame(Game.of(Players.getInstance().getNumberOfPlayers() + " online!"));
             jda.getGuildsByName(serverName, true).get(0).getTextChannelsByName(channel, true).get(0).sendMessage(builder.build()).queue();
         }catch(Exception e){
             e.printStackTrace();
@@ -117,7 +133,12 @@ public static void sendToDiscord(String channel, String message, boolean include
 
     @Override
     public MessagePolicy onKingdomMessage(Message message) {
-        if(message.getWindow().startsWith("GL-")){
+        String window = message.getWindow();
+        if(window.startsWith("Trade")){
+            if(enableTrade) {
+                sendToDiscord("trade", message.getMessage(), false);
+            }
+        }else if(window.startsWith("GL-")){
             byte kingdomId = message.getSender().getKingdomId();
             //Kingdom kingdom = Kingdoms.getKingdom(kingdomId);
             String kingdomName = discordifyName("GL-"+Kingdoms.getChatNameFor(kingdomId));
@@ -136,6 +157,15 @@ public MessagePolicy onKingdomMessage(Message message) {
         return MessagePolicy.PASS;
     }
 
+    public void sendToTradeChat(final String channel, final String message){
+        String window = "Trade";
+        final Message mess = new Message(null, Message.TRADE, window, message);
+        mess.setSenderKingdom((byte) 4);
+        if (message.trim().length() > 1) {
+            Server.getInstance().addMessage(mess);
+        }
+    }
+
     public void sendToGlobalKingdomChat(final String channel, final String message) {
         Kingdom[] kingdoms = Kingdoms.getAllKingdoms();
 
@@ -166,16 +196,6 @@ public void sendToGlobalKingdomChat(final String channel, final String message)
             mess.setSenderKingdom(kingdomId);
             if (message.trim().length() > 1) {
                 Server.getInstance().addMessage(mess);
-                /*final WcKingdomChat wc = new WcKingdomChat(WurmId.getNextWCCommandId(),
-                        wurmId, "[D]", message, false, kingdomId,
-                        -1,
-                        -1,
-                        -1);*/
-                /*if (Servers.localServer.LOGINSERVER){
-                    wc.sendFromLoginServer();
-                }*/
-                //else
-                //wc.sendToLoginServer();
             }
         }
     }
@@ -195,7 +215,13 @@ public void onMessageReceived(MessageReceivedEvent event) {
         super.onMessageReceived(event);
         if (event.isFromType(ChannelType.TEXT) && !event.getAuthor().isBot()) {
             String name = event.getTextChannel().getName();
-            sendToGlobalKingdomChat(name, "<@" + event.getMember().getEffectiveName() + "> " + event.getMessage().getContent());
+            if(name.contains("trade")){
+                if(enableTrade) {
+                    sendToTradeChat(name, "<@" + event.getMember().getEffectiveName() + "> " + event.getMessage().getContent());
+                }
+            }else {
+                sendToGlobalKingdomChat(name, "<@" + event.getMember().getEffectiveName() + "> " + event.getMessage().getContent());
+            }
         }
     }
 
@@ -219,4 +245,23 @@ public MessagePolicy onPlayerMessage(Communicator communicator, String message,
     public boolean onPlayerMessage(Communicator var1, String var2) {
         return false;
     }
+
+    protected static long lastPolledPlayers = 0;
+    protected static long pollPlayerInterval = TimeConstants.SECOND_MILLIS*120;
+    @Override
+    public void onServerPoll() {
+        if(showConnectedPlayers) {
+            if(System.currentTimeMillis() > lastPolledPlayers + pollPlayerInterval) {
+                if (Servers.localServer.LOGINSERVER) {
+                    try {
+                        jda.getPresence().setGame(Game.of(Players.getInstance().getNumberOfPlayers() + " online!"));
+                    }catch(Exception e){
+                        e.printStackTrace();
+                        logger.info("Failed to update player count.");
+                    }
+                }
+                lastPolledPlayers = System.currentTimeMillis();
+            }
+        }
+    }
 }
