Implement new compiling methods to work with current client system

 * Use included scripts to update client from remote github repo
 * Hide patcher debug messages, only shows actually patched methods now
 * Add spotless support to openrsc client subproject (automatic when building)
    * this isn't required to pass pipeline right now
 * Add patcher automatic spotless apply (required for pipeline)
 * Remove create zip cache for now
 * update resource folder path
 * update cache sprites in assets
 * always replace our jar when compiling (for now)
       - our method of task (not copy specific task) does not respect MD5 hash checking, so we can't check versions here (yet)
 * Move resources for client into main/java/bot folder for easier access
 * always copyJar AFTER jar is finished running
 * update release to include cache and exclude run files
 * turn back on cache generation but include cache with main repo
 - this is more for a fall back if cache gets removed, and for server and world switching in the future!!!
 * include zipcache in the repo,

Author: KailaBtw

app/build.gradle

@@ -60,18 +60,14 @@ tasks.named('jar') {
       'Build-Jdk' : "${System.properties['java.version']}",
     )
   }
-
   // FTBFS: Set duplicate handling strategy for module-info.class.
   duplicatesStrategy(DuplicatesStrategy.EXCLUDE)
 }
 
 tasks.register('copyJar') {
-  // Final JAR
-  group 'build'
-  description 'copy app.jar to main dir'
 
-  inputs.file "${project(':app').getBuildDir()}/libs/app.jar"
-  outputs.file "Idlersc.jar"
+  description 'copy app.jar to main dir and rename to IdleRSC.jar'
+  dependsOn('build')
 
   doLast {
     copy {
@@ -81,19 +77,19 @@ tasks.register('copyJar') {
       into '../'
     }
   }
-
-  //File appJar = new File(project(':app').getBuildDir(), "libs/${project(':app').getName()}.jar")
-//  from("${project(':app').getBuildDir()}/libs/app.jar")
-//  into "."
 }
 
 tasks.named('testClasses') {
   finalizedBy('copyJar')
 }
+tasks.named('build') {
+  finalizedBy('copyJar')
+}
 
 // Add additional files to clean task
 tasks.named('clean') {
   delete 'src/main/resources'
+  delete '../IdleRSC.jar'
 }
 
 // Create resources before processResources runs

app/src/main/java/bot/AuthFrame.java

@@ -18,7 +18,7 @@ final class AuthFrame extends JFrame {
   private Color backgroundColor = Main.getColorCode(1, 0);
   private Color textColor = Main.getColorCode(0, 0);
   private boolean loadSettings = false;
-  private final String resourceLocation = "src/main/resources/";
+  private final String resourceLocation = "app/src/main/java/bot/res/";
   private static final Dimension fieldSize = new Dimension(100, 25);
   private final Window parent;
   private JPasswordField password;

app/src/main/java/bot/EntryFrame.java

@@ -18,29 +18,14 @@ public final class EntryFrame extends JFrame {
   private static String account = "";
   private final Choice accountChoice;
   private String themeName = "RuneDark Theme";
-  private final String resourceLocation = "src/main/resources/";
+  private final String resourceLocation = "app/src/main/java/bot/res/";
   private boolean okie = false;
 
   // todo add theme select to cli
   public static String getAccount() {
     return account;
   }
 
-  private String getStringProperty(final String name, String propertyName) {
-    if (name == null || propertyName == null) {
-      System.out.println("Error accessing string property");
-    }
-    final Properties p = new Properties();
-    final File file = Paths.get("accounts").resolve(name + ".properties").toFile();
-    try (final FileInputStream stream = new FileInputStream(file)) {
-      p.load(stream);
-      return p.getProperty(propertyName, " ");
-    } catch (final Throwable t) {
-      System.out.println("Error loading account " + name + ": " + t);
-    }
-    return "";
-  }
-
   private void loadAccounts() {
     try {
       final File dir = Paths.get("accounts").toFile();
@@ -75,14 +60,14 @@ public EntryFrame() {
         new ImageIcon(resourceLocation + "icons/welcome.icon.png")
             .getImage()
             .getScaledInstance(230, 30, java.awt.Image.SCALE_SMOOTH);
-    Image okImage =
-        new ImageIcon(resourceLocation + "icons/ok.icon.png")
-            .getImage()
-            .getScaledInstance(120, 26, java.awt.Image.SCALE_SMOOTH);
-    Image cancelImg =
-        new ImageIcon(resourceLocation + "icons/cancel2.icon.png")
-            .getImage()
-            .getScaledInstance(120, 26, java.awt.Image.SCALE_SMOOTH);
+    //    Image okImage =
+    //        new ImageIcon(resourceLocation + "icons/ok.icon.png")
+    //            .getImage()
+    //            .getScaledInstance(120, 26, java.awt.Image.SCALE_SMOOTH);
+    //    Image cancelImg =
+    //        new ImageIcon(resourceLocation + "icons/cancel2.icon.png")
+    //            .getImage()
+    //            .getScaledInstance(120, 26, java.awt.Image.SCALE_SMOOTH);
     // ImageIcon icon = new ImageIcon("res/ui/present_edit.png"); // Christmas mode
     // ImageIcon icon = new ImageIcon("res/ui/scales.png"); // Red
 
@@ -283,6 +268,21 @@ public void waitForLaunch() {
     dispose();
   }
 
+  private String getStringProperty(final String name, String propertyName) {
+    if (name == null || propertyName == null) {
+      System.out.println("Error accessing string property");
+    }
+    final Properties p = new Properties();
+    final File file = Paths.get("accounts").resolve(name + ".properties").toFile();
+    try (final FileInputStream stream = new FileInputStream(file)) {
+      p.load(stream);
+      return p.getProperty(propertyName, " ");
+    } catch (final Throwable t) {
+      System.out.println("Error loading account " + name + ": " + t);
+    }
+    return "";
+  }
+
   @Override
   public void setVisible(final boolean visible) {
     if (visible) {

app/src/main/java/bot/Main.java

@@ -12,6 +12,8 @@
 import controller.Controller;
 import java.awt.*;
 import java.awt.event.*;
+import java.io.File;
+import java.io.FileWriter;
 import java.io.IOException;
 import java.lang.reflect.InvocationTargetException;
 import java.net.MalformedURLException;
@@ -38,6 +40,7 @@
 import orsc.mudclient;
 import reflector.Reflector;
 import scripting.idlescript.IdleScript;
+import utils.Extractor;
 import utils.Version;
 
 /**
@@ -263,7 +266,7 @@ public static void main(String[] args)
     }
 
     config.absorb(parseResult);
-    // handleCache(config);
+    handleCache(config);
 
     Reflector reflector = new Reflector(); // start up our reflector helper
     OpenRSC client = reflector.createClient(); // start up our client jar
@@ -946,92 +949,96 @@ public void focusLost(FocusEvent e) {
     };
   }
 
-  //  /** Checks if the user has made a Cache/ folder. If not, spawns a wizard to create the folder.
-  // */
-  //  private static void handleCache(Config config) {
-  //    final int COLESLAW_PORT = 43599;
-  //    final int URANIUM_PORT = 43601;
-  //    // Does the directory exist?
-  //    File cacheDirectory = new File("Cache/");
-  //
-  //    if (cacheDirectory.exists()) return;
-  //
-  //    // If --init-cache argument is used, bypass the GUI
-  //    if (!config.getInitCache().isEmpty()) {
-  //      if (config.getInitCache().equals("uranium")) {
-  //        // Create Uranium cache
-  //        createCache(URANIUM_PORT);
-  //        return;
-  //      } else if (config.getInitCache().equals("coleslaw")) {
-  //        // Create Coleslaw cache
-  //        createCache(COLESLAW_PORT);
-  //        return;
-  //      } else {
-  //        System.out.println("Server (" + config.getInitCache() + ") is not known.");
-  //      }
-  //    }
-  //
-  //    JFrame cacheFrame = new JFrame("Cache Setup");
-  //    JLabel cacheLabel = new JLabel("First setup: you must select either Uranium or Coleslaw.");
-  //    JButton uraniumButton = new JButton("Uranium (2018 RSC)");
-  //    JButton coleslawButton = new JButton("Coleslaw (modified RSC, new content)");
-  //
-  //    uraniumButton.addActionListener(
-  //        e -> {
-  //          // Create Uranium cache
-  //          createCache(URANIUM_PORT);
-  //        });
-  //
-  //    coleslawButton.addActionListener(
-  //        e -> {
-  //          // Create Coleslaw cache
-  //          createCache(COLESLAW_PORT);
-  //        });
-  //
-  //    cacheFrame.setLayout(new GridLayout(0, 1));
-  //    cacheFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
-  //    cacheFrame.add(cacheLabel);
-  //    cacheFrame.add(uraniumButton);
-  //    cacheFrame.add(coleslawButton);
-  //
-  //    cacheFrame.pack();
-  //    cacheFrame.setLocationRelativeTo(null);
-  //    cacheFrame.setVisible(true);
-  //    cacheFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
-  //
-  //    while (!cacheDirectory.exists()) {
-  //      try {
-  //        Thread.sleep(100);
-  //      } catch (InterruptedException e) {
-  //        e.printStackTrace();
-  //      }
-  //      cacheDirectory = new File("Cache/");
-  //    }
-  //    cacheFrame.setVisible(false);
-  //    cacheFrame.dispose();
-  //  }
-
-  //  private static void createCache(int ServerPort) {
-  //    // Create Cache directory
-  //    File dir = new File("." + File.separator + "Cache");
-  //    dir.mkdirs();
-  //
-  //    // Copy embedded cache to cache directory
-  //    try {
-  //      Extractor.extractZipResource("/cache/ZipCache.zip", dir.toPath());
-  //    } catch (IOException ignored) {
-  //      System.out.print(ignored);
-  //    }
-  //
-  //    // Add port to client cache
-  //    try {
-  //      FileWriter portFile = new FileWriter("Cache/port.txt");
-  //      portFile.write(Integer.toString(43599));
-  //      portFile.close();
-  //    } catch (IOException ignored) {
-  //      System.out.print(ignored);
-  //    }
-  //  }
+  /** Checks if the user has made a Cache/ folder. If not, spawns a wizard to create the folder. */
+  private static void handleCache(Config config) {
+    final int COLESLAW_PORT = 43599;
+    final int URANIUM_PORT = 43601;
+    // Does the directory exist?
+    File cacheDirectory = new File("Cache/");
+
+    if (cacheDirectory.exists()) return;
+
+    // If --init-cache argument is used, bypass the GUI
+    if (!config.getInitCache().isEmpty()) {
+      if (config.getInitCache().equals("uranium")) {
+        // Create Uranium cache
+        createCache(URANIUM_PORT);
+        return;
+      } else if (config.getInitCache().equals("coleslaw")) {
+        // Create Coleslaw cache
+        createCache(COLESLAW_PORT);
+        return;
+      } else {
+        System.out.println("Server (" + config.getInitCache() + ") is not known.");
+      }
+    } else {
+      createCache(COLESLAW_PORT);
+      return;
+    }
+
+    JFrame cacheFrame = new JFrame("Cache Setup");
+    JLabel cacheLabel = new JLabel("First setup: you must select either Uranium or Coleslaw.");
+    JButton uraniumButton = new JButton("Uranium (2018 RSC)");
+    JButton coleslawButton = new JButton("Coleslaw (modified RSC, new content)");
+
+    uraniumButton.addActionListener(
+        e -> {
+          // Create Uranium cache
+          createCache(URANIUM_PORT);
+        });
+
+    coleslawButton.addActionListener(
+        e -> {
+          // Create Coleslaw cache
+          createCache(COLESLAW_PORT);
+        });
+
+    cacheFrame.setLayout(new GridLayout(0, 1));
+    cacheFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
+    cacheFrame.add(cacheLabel);
+    cacheFrame.add(uraniumButton);
+    cacheFrame.add(coleslawButton);
+
+    cacheFrame.pack();
+    cacheFrame.setLocationRelativeTo(null);
+    cacheFrame.setVisible(true);
+    cacheFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
+
+    while (!cacheDirectory.exists()) {
+      try {
+        Thread.sleep(100);
+      } catch (InterruptedException e) {
+        e.printStackTrace();
+      }
+      cacheDirectory = new File("Cache/");
+    }
+    cacheFrame.setVisible(false);
+    cacheFrame.dispose();
+  }
+
+  private static void createCache(int ServerPort) {
+    // Create Cache directory
+    File dir = new File("." + File.separator + "Cache");
+    dir.mkdirs();
+
+    // Copy embedded cache to cache directory
+    try {
+      Extractor.extractZipResource("/cache/ZipCache.zip", dir.toPath());
+    } catch (IOException e) {
+      e.printStackTrace();
+      System.out.println(e.getMessage());
+    }
+
+    // Add port to client cache
+    try {
+      FileWriter portFile = new FileWriter("Cache/port.txt");
+      portFile.write(Integer.toString(43599));
+      portFile.close();
+    } catch (IOException e) {
+      e.printStackTrace();
+      System.out.println(e.getMessage());
+    }
+  }
 
   private static void copyDirectory(
       String sourceDirectoryLocation, String destinationDirectoryLocation) {

app/src/main/resources/icons/cancel.icon.png app/src/main/java/bot/res/icons/cancel.icon.png

@@ -0,0 +1,53 @@
+70a77a7b18554b81941b23e966b76561  ./config.txt
+f900366006fb6f98b73a07c265694e53  ./OpenRSC.jar
+4ee4ae8bf5c68343effce65d6697ed71  ./openrsc.apk
+59f8d97492fdb1286018ec89b0755657  ./Open_RSC_Client_dev.jar
+b8419160170a41ae01abab13a3b887df  ./ip.txt
+2bc77ee6aff6405a4233e55c87138d8c  ./port.txt
+e7db55346a3c9e1e2dc4156a5080e3e3  ./audio/spellfail.wav
+a35f59926c22a2763a898509ac46ac05  ./audio/chisel.wav
+e975b69136d8cea9eafd1f7dad2f6e92  ./audio/spellok.wav
+1a6bd03dc01873ca5a2a3e51c6f13b12  ./audio/combat2b.wav
+98395590acfc5a09ca6838d2c73846ca  ./audio/foundgem.wav
+3ba2c9d80d3876bbd53e03a16ad415bb  ./audio/potato.wav
+9c48528aa1856071bddd96f1ccf0280d  ./audio/sounds.mem
+4e5da6ef24f2f1d51d6cab1d38b40e17  ./audio/prayeroff.wav
+67d5e5731f6fee2bd0825f1f886ac7b1  ./audio/recharge.wav
+2987aa4c8fa1d396ace73b71eda3118d  ./audio/closedoor.wav
+9f266ba9ec03a5f6d25c27434b447e6d  ./audio/retreat.wav
+5eca4d35fc8ee3ea435560da0eca6c6d  ./audio/anvil.wav
+eeaafe253ccb7f566fc2d30c03915842  ./audio/cooking.wav
+821a71555b8e0924784ad07b02e63582  ./audio/death.wav
+6d8f9ccb2338ec9b5579da52cfd51195  ./audio/outofammo.wav
+a2237aa906d418df12f801a67948710b  ./audio/secretdoor.wav
+19f3c3b2d2dc7d0a8bb190c2c4d1c8fd  ./audio/prayeron.wav
+e2721d63e3df7b55e081ee71c66e56c3  ./audio/underattack.wav
+8f3b3864c52cf51814fdf0fa0b2b741b  ./audio/advance.wav
+bbe470bcd82a2e2dc605760d7d0ffaa5  ./audio/takeobject.wav
+ef610914a731786b42bbce9bb622d3a0  ./audio/combat1b.wav
+da1e22c96fb52e7f72dd0464e833b4d2  ./audio/filljug.wav
+7b3039a8bd7120135d50679ea5d8f792  ./audio/combat3a.wav
+652c31cb123c1a7260827294ebaa80ab  ./audio/mine.wav
+b88a5f4a16ed18b0665b459723fd2211  ./audio/dropobject.wav
+06da45374b5113d1aea98a72c9699539  ./audio/combat1a.wav
+6be1531321281f9099b3184f938f1715  ./audio/eat.wav
+9fab30ff683e4933115549efcce1aa16  ./audio/shoot.wav
+55ef3d424e79626e32748b9032ed48df  ./audio/combat2a.wav
+347fc00ecee0aad4a75909599fc4b21c  ./audio/mix.wav
+6fabaf1726a553115835427a7f3ae269  ./audio/victory.wav
+7da40aec7309e78fdc338cc1ea809711  ./audio/opendoor.wav
+5ffadf2eebd5da8e852351193455af02  ./audio/coins.wav
+82e2da66cecbcf84002461ca47cdb37d  ./audio/click.wav
+532df52e741613540730be1ca109a424  ./audio/prospect.wav
+3493216d321637c2c56237ce3c161ae9  ./audio/fish.wav
+daa945fd3476cb088b7822ad44a000ac  ./audio/mechanical.wav
+2bdc3e524ce56419c10079f05b74786e  ./audio/combat3b.wav
+d41d8cd98f00b204e9800998ecf8427e  ./uid.dat
+3bbc851bd8a0aff7dc4a01ca327b30bc  ./video/Authentic_Sprites.orsc
+f868a8fb9266f219edd7f47ef0028a6b  ./video/Custom_Landscape.orsc
+1a8c3f966fc4259a6f3d6ff32cebd6a8  ./video/models.orsc
+c95ded5d48c3a78c5a267e0301160367  ./video/spritepacks/Menus.osar
+6cdb4549a7813f54a3473564a3231399  ./video/Authentic_Landscape.orsc
+8ccf8b4697c432ccdcd84be3979b91b3  ./video/Custom_Sprites.osar
+4445d7d9c1535a6f47a09ef33c02c15f  ./video/library.orsc
+8101c301d8ad141b92842f6a1e4d295c  ./Open_RSC_Client.jar