Merge pull request #5864 from kwvanderlinde/maintenance/5723-link-to-discord-in-help-menu

Add Discord link to the help menu

Author: cwisniew

src/main/java/net/rptools/maptool/client/AppActions.java

@@ -3227,23 +3227,20 @@ protected final void executeAction() {
 
   /** This class provides an action that displays a url from I18N */
   public static class OpenUrlAction extends TranslatedClientAction {
+    private final String url;
 
-    public OpenUrlAction(String key) {
+    public OpenUrlAction(String key, String url, Icons icon) {
       super(key);
+      this.url = url;
 
-      // The constructor method will load the "key", "key.accel", and "key.description".
-      // The value of "key" will be used as the menu text, the accelerator is not
-      // used,
-      // and the description will be the destination URL. Only the Help menu uses
-      // these objects and
-      // only the Help menu expects that field to be set...
+      // Show the URL as hover text.
+      putValue(Action.SHORT_DESCRIPTION, url);
+      putValue(Action.SMALL_ICON, RessourceManager.getSmallIcon(icon));
     }
 
     @Override
     protected void executeAction() {
-      if (getValue(Action.SHORT_DESCRIPTION) != null) {
-        MapTool.showDocument((String) getValue(Action.SHORT_DESCRIPTION));
-      }
+      MapTool.showDocument(url);
     }
   }
 

src/main/java/net/rptools/maptool/client/ui/AppMenuBar.java

@@ -356,8 +356,7 @@ protected JToggleButton createMinimizeButton(
   }
 
   /**
-   * Builds the help menu. This menu contains a block of special url items. These items are
-   * populated from {@link I18N#getMatchingKeys}.
+   * Builds the help menu. This menu contains a block of special url items.
    *
    * @return the help menu
    */
@@ -367,42 +366,45 @@ protected JMenu createHelpMenu() {
     menu.add(new JMenuItem(AppActions.RESTORE_DEFAULT_IMAGES));
     menu.addSeparator();
 
-    // @formatter:off
-    /*
-     * This next line will retrieve all properties that match the regex, such as:
-     *		action.helpurl.01=http://rptools.net/?page=maptool
-     *		action.helpurl.02=http://forums.rptools.net/
-     * The items are not returned from the method in any kind of order so they are alphabetized here so that their
-     * display in the menu is predictable.
-     */
-    // @formatter:on
-    List<String> helpItems = I18N.getMatchingKeys("^action[.]helpurl[.]\\d+$");
-    if (!helpItems.isEmpty()) {
-      String[] helpArray = helpItems.toArray(new String[0]);
-      Arrays.sort(helpArray);
-      for (String key : helpArray) {
-        OpenUrlAction temp = new AppActions.OpenUrlAction(key);
-        switch (key) {
-          case "action.helpurl.01" ->
-              temp.putValue(
-                  Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_DOCUMENTATION));
-          case "action.helpurl.02" ->
-              temp.putValue(Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_TUTORIALS));
-          case "action.helpurl.03" ->
-              temp.putValue(Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_FORUMS));
-          case "action.helpurl.04" ->
-              temp.putValue(
-                  Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_NETWORK_SETUP));
-          case "action.helpurl.05" ->
-              temp.putValue(Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_SCRIPTING));
-          case "action.helpurl.06" ->
-              temp.putValue(
-                  Action.SMALL_ICON, RessourceManager.getSmallIcon(Icons.MENU_FRAMEWORKS));
-        }
-        menu.add(new JMenuItem(temp));
-      }
-      menu.addSeparator();
-    }
+    menu.add(
+        new JMenuItem(
+            new OpenUrlAction(
+                "action.helpurl.discord", "https://rptools.net/discord", Icons.MENU_DISCORD)));
+    menu.add(
+        new JMenuItem(
+            new OpenUrlAction(
+                "action.helpurl.01",
+                "https://www.rptools.net/toolbox/maptool/",
+                Icons.MENU_DOCUMENTATION)));
+    menu.add(
+        new JMenuItem(
+            new OpenUrlAction(
+                "action.helpurl.02", "https://www.rptools.net/tutorials/", Icons.MENU_TUTORIALS)));
+    menu.add(
+        new JMenuItem(
+            new OpenUrlAction(
+                "action.helpurl.03", "https://forums.rptools.net/", Icons.MENU_FORUMS)));
+    menu.add(
+        new JMenuItem(
+            new OpenUrlAction(
+                "action.helpurl.04",
+                "http://forums.rptools.net/viewtopic.php?f=22&t=3370",
+                Icons.MENU_NETWORK_SETUP)));
+    menu.add(
+        new JMenuItem(
+            new OpenUrlAction(
+                "action.helpurl.05",
+                "https://wiki.rptools.info/index.php/Main_Page",
+                Icons.MENU_SCRIPTING)));
+    menu.add(
+        new JMenuItem(
+            new OpenUrlAction(
+                "action.helpurl.06",
+                "https://wiki.rptools.info/index.php/Frameworks",
+                Icons.MENU_FRAMEWORKS)));
+
+    menu.addSeparator();
+
     menu.add(new JMenuItem(AppActions.GATHER_DEBUG_INFO));
 
     if (!OsDetection.MAC_OS_X) {

src/main/java/net/rptools/maptool/client/ui/startserverdialog/StartServerDialog.java

@@ -69,7 +69,7 @@ public StartServerDialog() {
               // We don't have a good, server-side way of testing anymore.
               boolean ok = MapTool.confirm("msg.info.server.networkingHelp");
               if (ok) {
-                MapTool.showDocument(I18N.getString("msg.info.server.forumNFAQ_URL"));
+                MapTool.showDocument("https://forums.rptools.net/viewtopic.php?f=22&t=3370");
               }
             })
         .addButton(

src/main/java/net/rptools/maptool/client/ui/theme/Icons.java

@@ -89,6 +89,7 @@ public enum Icons {
   GRID_SQUARE,
   INITIATIVE_CURRENT_INDICATOR,
   MAPTOOL,
+  MENU_DISCORD,
   MENU_DOCUMENTATION,
   MENU_FORUMS,
   MENU_FRAMEWORKS,

src/main/java/net/rptools/maptool/client/ui/theme/RessourceManager.java

@@ -17,8 +17,6 @@
 import com.formdev.flatlaf.extras.FlatSVGIcon;
 import java.awt.image.BufferedImage;
 import java.io.IOException;
-import java.nio.file.Files;
-import java.nio.file.Path;
 import java.util.HashMap;
 import java.util.TreeSet;
 import javax.swing.*;
@@ -129,6 +127,7 @@ public class RessourceManager {
           put(Icons.GRID_SQUARE, IMAGE_DIR + "gridSquare.png");
           put(Icons.INITIATIVE_CURRENT_INDICATOR, IMAGE_DIR + "currentIndicator.png");
           put(Icons.MAPTOOL, IMAGE_DIR + "maptool_icon.png");
+          put(Icons.MENU_DISCORD, IMAGE_DIR + "discord.svg");
           put(Icons.MENU_DOCUMENTATION, IMAGE_DIR + "book_open.png");
           put(Icons.MENU_FORUMS, IMAGE_DIR + "marker.png");
           put(Icons.MENU_FRAMEWORKS, IMAGE_DIR + "minilogo.png");
@@ -363,6 +362,7 @@ public class RessourceManager {
           put(Icons.GRID_NONE, ROD_ICONS + "cross.svg");
           put(Icons.GRID_SQUARE, ROD_ICONS + "gridSquare.svg");
           put(Icons.MAPTOOL, ROD_ICONS + "maptool_icon.svg");
+          put(Icons.MENU_DISCORD, ROD_ICONS + "menu/Discord.svg");
           put(Icons.MENU_DOCUMENTATION, ROD_ICONS + "menu/Documentation.svg");
           put(Icons.MENU_FORUMS, ROD_ICONS + "menu/Forums.svg");
           put(Icons.MENU_FRAMEWORKS, ROD_ICONS + "menu/Frameworks.svg");
@@ -619,42 +619,4 @@ private static void checkMissingIcons(
       System.out.println(key + " classic: " + classicIcons.get(key));
     }
   }
-
-  public static void checkMissingFiles() {
-    String basedir = "C:\\Users\\tkunze\\Source\\maptool\\src\\main\\resources\\";
-    for (String value : images.values()) {
-      if (value == null) {
-        continue;
-      }
-
-      var source = Path.of(basedir, value);
-      var target = Path.of(basedir, IMAGE_DIR, "images", source.getFileName().toString());
-
-      if (Files.notExists(source)) {
-        System.out.println(value + " is missing!");
-      }
-    }
-    for (String value : classicIcons.values()) {
-      if (value == null) {
-        continue;
-      }
-
-      var source = Path.of(basedir, value);
-
-      if (Files.notExists(source)) {
-        System.out.println(value + " is missing!");
-      }
-    }
-    for (String value : rodIcons.values()) {
-      if (value == null) {
-        continue;
-      }
-
-      var source = Path.of(basedir, value);
-
-      if (Files.notExists(source)) {
-        System.out.println(value + " is missing!");
-      }
-    }
-  }
 }

src/main/resources/net/rptools/maptool/client/icons/rod_takehara/menu/Discord.svg

@@ -1499,18 +1499,13 @@ action.gridLineWight                          = Grid &Line Weight
 # action.url.##.description which contains the url to load when the action is 
 # executed.  The last key is action.url.##.icon which contains the image embedded
 # inside the MapTool JAR file which appears on the menu item.
+action.helpurl.discord                        = Discord
 action.helpurl.01                             = Documentation
-action.helpurl.01.description                 = https://www.rptools.net/toolbox/maptool/
 action.helpurl.02                             = Tutorials
-action.helpurl.02.description                 = https://www.rptools.net/tutorials/
 action.helpurl.03                             = Forums
-action.helpurl.03.description                 = http://forums.rptools.net/
 action.helpurl.04                             = Networking Setup (forum thread)
-action.helpurl.04.description                 = http://forums.rptools.net/viewtopic.php?f=22&t=3370
 action.helpurl.05                             = Macro Scripting
-action.helpurl.05.description=https://wiki.rptools.info/index.php/Main_Page
 action.helpurl.06                             = Frameworks
-action.helpurl.06.description                 = https\://wiki.rptools.info/index.php/Frameworks
 action.toggleLandingMap                       = &Landing map
 action.toggleLandingMap.description           = Make this map the first one that players see when they connect.
 action.hideMap                                = &Player Visible
@@ -2530,7 +2525,6 @@ msg.info.restoreLayout                        = Restore layout
 msg.info.restoreLayout.description            = Restore the MapTool user interface to the default layout.
 msg.info.screenshotSaved                      = Saved screenshot.
 msg.info.screenshotSaving                     = Saving screenshot...
-msg.info.server.forumNFAQ_URL                 = http://forums.rptools.net/viewtopic.php?f=22&t=3370
 msg.info.server.networkingHelp                = <html>Hosting a MapTool server involves proper network setup.<br>Do you want to visit the forum post that describes this process?
 msg.info.showTransferWindow                   = Show Transfer Window
 msg.info.showTransferWindow.description       = Open a window showing the pending asset transfers.

src/main/resources/net/rptools/maptool/client/image/discord.svg

@@ -1289,17 +1289,11 @@ action.gridLineWight                          = Grid &Line Weight
 # executed.  The last key is action.url.##.icon which contains the image embedded
 # inside the MapTool JAR file which appears on the menu item.
 action.helpurl.01                             = Documentation
-action.helpurl.01.description                 = https\://www.rptools.net/toolbox/maptool/
 action.helpurl.02                             = Tutorials
-action.helpurl.02.description                 = https\://www.rptools.net/tutorials/
 action.helpurl.03                             = Forums
-action.helpurl.03.description                 = http\://forums.rptools.net/
 action.helpurl.04                             = Networking Setup (forum thread)
-action.helpurl.04.description                 = http\://forums.rptools.net/viewtopic.php?f\=22&t\=3370
 action.helpurl.05                             = Macro Scripting
-action.helpurl.05.description=https\://wiki.rptools.info/index.php/Main_Page
 action.helpurl.06                             = Frameworks
-action.helpurl.06.description                 = https\://wiki.rptools.info/index.php/Frameworks
 action.toggleLandingMap                       = &Landing map
 action.toggleLandingMap.description           = Make this map the first one that players see when they connect.
 action.hideMap                                = &Player Visible
@@ -2289,7 +2283,6 @@ msg.info.restoreLayout                        = Restore layout
 msg.info.restoreLayout.description            = Restore the MapTool user interface to the default layout.
 msg.info.screenshotSaved                      = Saved screenshot.
 msg.info.screenshotSaving                     = Saving screenshot...
-msg.info.server.forumNFAQ_URL                 = http\://forums.rptools.net/viewtopic.php?f\=22&t\=3370
 msg.info.server.networkingHelp                = <html>Hosting a MapTool server involves proper network setup.<br>Do you want to visit the forum post that describes this process?
 msg.info.showTransferWindow                   = Show Transfer Window
 msg.info.showTransferWindow.description       = Open a window showing the pending asset transfers.

src/main/resources/net/rptools/maptool/language/i18n.properties

@@ -1289,17 +1289,11 @@ action.gridLineWight                          = Grid &Line Weight
 # executed.  The last key is action.url.##.icon which contains the image embedded
 # inside the MapTool JAR file which appears on the menu item.
 action.helpurl.01                             = Dokumentation
-action.helpurl.01.description                 = https\://www.rptools.net/toolbox/maptool/
 action.helpurl.02                             = Vejledninger
-action.helpurl.02.description                 = https\://www.rptools.net/tutorials/
 action.helpurl.03                             = Fora
-action.helpurl.03.description                 = http\://forums.rptools.net/
 action.helpurl.04                             = Networking Setup (forum thread)
-action.helpurl.04.description                 = http\://forums.rptools.net/viewtopic.php?f\=22&t\=3370
 action.helpurl.05                             = Makro scripting
-action.helpurl.05.description=https\://wiki.rptools.info/index.php/Main_Page
 action.helpurl.06                             = Rammeværktøjer
-action.helpurl.06.description                 = https\://wiki.rptools.info/index.php/Frameworks
 action.toggleLandingMap                       = &Landing map
 action.toggleLandingMap.description           = Make this map the first one that players see when they connect.
 action.hideMap                                = S&piller synlig
@@ -2289,7 +2283,6 @@ msg.info.restoreLayout                        = Gendan layout
 msg.info.restoreLayout.description            = Restore the MapTool user interface to the default layout.
 msg.info.screenshotSaved                      = Gemte skærmbillede.
 msg.info.screenshotSaving                     = Gemmer skærmbillede...
-msg.info.server.forumNFAQ_URL                 = http\://forums.rptools.net/viewtopic.php?f\=22&t\=3370
 msg.info.server.networkingHelp                = <html>Hosting a MapTool server involves proper network setup.<br>Do you want to visit the forum post that describes this process?
 msg.info.showTransferWindow                   = Vis overførselsvindue
 msg.info.showTransferWindow.description       = Open a window showing the pending asset transfers.