tuned mouse, improved stop(), improved demo

Author: debajit gayen

src/main/java/com/chromascape/base/BaseScript.java

@@ -3,6 +3,8 @@
 import static java.time.temporal.ChronoUnit.MINUTES;
 
 import com.chromascape.controller.Controller;
+import com.chromascape.utils.core.runtime.HotkeyListener;
+import com.chromascape.utils.core.runtime.ScriptStoppedException;
 import com.chromascape.web.logs.LogService;
 import java.time.LocalTime;
 
@@ -20,6 +22,7 @@ public abstract class BaseScript {
   private final Controller controller;
   private final int duration; // Duration to run the script in minutes
   private final LogService logger;
+  private final HotkeyListener hotkeyListener;
   private boolean running = true;
   private LocalTime startTime;
 
@@ -34,6 +37,7 @@ public BaseScript(final boolean isFixed, final int duration, final LogService lo
     controller = new Controller(isFixed, logger);
     this.duration = duration;
     this.logger = logger;
+    this.hotkeyListener = new HotkeyListener(this);
   }
 
   /**
@@ -45,35 +49,51 @@ public BaseScript(final boolean isFixed, final int duration, final LogService lo
    *
    * <p>This method blocks until completion.
    */
-  public void run() {
+  public final void run() {
     startTime = LocalTime.now();
     LocalTime endTime = startTime.plusMinutes(duration);
     logger.addLog("Starting. Script will run for " + duration + " minutes.");
     controller.init();
-    while (startTime.isBefore(endTime) && running) {
-      if (Thread.currentThread().isInterrupted()) {
-        logger.addLog("Thread interrupted, stopping.");
-        break;
+    hotkeyListener.start();
+
+    try {
+      while (running && LocalTime.now().isBefore(endTime)) {
+        if (Thread.currentThread().isInterrupted()) {
+          logger.addLog("Thread interrupted, exiting.");
+          break;
+        }
+        try {
+          cycle();
+        } catch (ScriptStoppedException e) {
+          logger.addLog("Cycle interrupted: " + e.getMessage());
+          break;
+        } catch (Exception e) {
+          logger.addLog("Exception in cycle: " + e.getMessage());
+          break;
+        }
       }
-      cycle();
-      startTime = LocalTime.now();
+    } finally {
+      logger.addLog("Stopping and cleaning up.");
+      controller.shutdown();
     }
-    logger.addLog("Finished running script. Exiting.");
-    controller.shutdown();
+    logger.addLog("Finished running script.");
   }
 
   /**
    * Stops the script execution.
    *
-   * <p>Can be called externally (e.g., via UI controls or programmatically) to request a graceful
-   * stop of the running script. If the script is already stopped, this method does nothing.
+   * <p>Can be called externally (e.g., via UI controls or programmatically) to request an immediate
+   * stop of the running script via the {@code ScriptStoppedException}. If the script is already
+   * stopped, this method does nothing.
    */
   public void stop() {
     if (!running) {
       return;
     }
     logger.addLog("Stop requested");
     running = false;
+    hotkeyListener.stop();
+    throw new ScriptStoppedException();
   }
 
   /**

src/main/java/com/chromascape/controller/Controller.java

@@ -3,7 +3,6 @@
 import com.chromascape.utils.core.input.keyboard.VirtualKeyboardUtils;
 import com.chromascape.utils.core.input.mouse.VirtualMouseUtils;
 import com.chromascape.utils.core.input.remoteinput.Kinput;
-import com.chromascape.utils.core.runtime.HotkeyListener;
 import com.chromascape.utils.core.screen.window.ScreenManager;
 import com.chromascape.utils.core.screen.window.WindowHandler;
 import com.chromascape.utils.domain.zones.ZoneManager;
@@ -30,7 +29,6 @@ private enum ControllerState {
   private final boolean isFixed;
 
   private Kinput kinput;
-  private HotkeyListener hotkeyListener;
   private VirtualMouseUtils virtualMouseUtils;
   private VirtualKeyboardUtils virtualKeyboardUtils;
   private ZoneManager zoneManager;
@@ -60,10 +58,6 @@ public void init() {
     // Obtain process ID of the target window to initialize input injection
     kinput = new Kinput(WindowHandler.getPid(WindowHandler.getTargetWindow()));
 
-    // Start listening for hotkeys to allow emergency runtime control
-    hotkeyListener = new HotkeyListener(this);
-    hotkeyListener.start();
-
     // Ensure the target window is focused for input simulation
     ScreenManager.focusWindow(WindowHandler.getTargetWindow());
     boolean isFullscreen = ScreenManager.isWindowFullscreen(WindowHandler.getTargetWindow());
@@ -88,7 +82,6 @@ public void init() {
   public void shutdown() {
     state = ControllerState.STOPPED;
     kinput.destroy();
-    hotkeyListener.stop();
     logger.addLog("Shutting down");
   }
 

src/main/java/com/chromascape/scripts/DemoWineScript.java

@@ -31,6 +31,7 @@ public class DemoWineScript extends BaseScript {
   private static final String grapes = "/images/user/Grapes.png";
   private static final String jugs = "/images/user/Jug_of_water.png";
   private static final String dumpBank = "/images/user/Dump_bank.png";
+  private static final String unfermented = "/images/user/Unfermented.png";
 
   private static final int MAX_ATTEMPTS = 15;
   private static final int INVENT_SLOT_GRAPES = 13;
@@ -60,30 +61,41 @@ public DemoWineScript(boolean isFixed, int duration, LogService logger) {
    */
   @Override
   protected void cycle() {
-
     if (bankFlag) {
       clickBank(); // Open the bank once at the start of the script
-      Sleeper.waitRandomMillis(150, 300);
+      Sleeper.waitRandomMillis(700, 900);
       bankFlag = false;
       // Cannot start in bank because UI needs to initialise
     }
 
-    clickImage(grapes, "medium", 0.085); // Take out grapes
+    clickImage(grapes, "fast", 0.07); // Take out grapes
     Sleeper.waitRandomMillis(300, 600);
+
     clickImage(jugs, "slow", 0.065); // Take out water jugs
     Sleeper.waitRandomMillis(400, 500);
+
     pressEscape(); // Exit bank UI
     Sleeper.waitRandomMillis(600, 800);
-    clickInventSlot(INVENT_SLOT_JUGS, "medium"); // Click the jugs of water in the inventory
+
+    clickInventSlot(INVENT_SLOT_JUGS, "fast"); // Click the jugs of water in the inventory
     Sleeper.waitRandomMillis(400, 800);
+
     clickInventSlot(INVENT_SLOT_GRAPES, "slow"); // Use the jugs on the grapes to start making wine
     Sleeper.waitRandomMillis(800, 900);
+
     pressSpace(); // Accept the start button
-    Sleeper.waitRandomMillis(18000, 20000); // Wait for wines to combine
+    Sleeper.waitRandomMillis(17000, 18000); // Wait for wines to combine
+
     clickBank(); // Open the bank to drop off items
-    Sleeper.waitRandomMillis(400, 600);
-    clickImage(dumpBank, "medium", 0.03); // Put the fermenting wines in the bank to repeat
-    Sleeper.waitRandomMillis(300, 600);
+    Sleeper.waitRandomMillis(700, 900);
+
+    clickImage(dumpBank, "medium", 0.055); // Put the fermenting wines in the bank to repeat
+    Sleeper.waitRandomMillis(400, 500);
+
+    if (checkIfImageExists(unfermented, 0.055)) { // Repeating because bank is weird
+      controller().mouse().leftClick();
+      Sleeper.waitRandomMillis(600, 800);
+    }
   }
 
   /**
@@ -161,12 +173,14 @@ private void clickBank() {
    * Searches for the provided image template within the current game view, then clicks a random
    * point within the detected bounding box if the match exceeds the defined threshold.
    *
-   * @param image the BufferedImage template to locate and click within the game view
+   * @param imagePath the BufferedImage template to locate and click within the game view
+   * @param speed the speed that the mouse moves to click the image
+   * @param threshold the openCV threshold to decide if a match exists
    */
-  private void clickImage(String image, String speed, double threshold) {
+  private void clickImage(String imagePath, String speed, double threshold) {
     try {
       BufferedImage gameView = ScreenManager.captureWindow();
-      Rectangle boundingBox = TemplateMatching.match(image, gameView, threshold, false);
+      Rectangle boundingBox = TemplateMatching.match(imagePath, gameView, threshold, false);
 
       if (boundingBox == null || boundingBox.isEmpty()) {
         logger.addLog("Template match failed: No valid bounding box.");
@@ -189,7 +203,8 @@ private void clickImage(String image, String speed, double threshold) {
   /**
    * Clicks a random point within the bounding box of a given inventory slot.
    *
-   * @param slot the index of the inventory slot to click
+   * @param slot the index of the inventory slot to click (0-27)
+   * @param speed the speed that the mouse moves to click the image
    */
   private void clickInventSlot(int slot, String speed) {
     try {
@@ -211,4 +226,30 @@ private void clickInventSlot(int slot, String speed) {
       stop();
     }
   }
+
+  /**
+   * Checks if an image exists on the screen and returns a boolean referring to if it was detected.
+   *
+   * @param imagePath the path to the image being searched on screen
+   * @param threshold the openCV threshold to decide if a match exists
+   * @return true if the image exists on screen, else false
+   */
+  private boolean checkIfImageExists(String imagePath, double threshold) {
+    try {
+      BufferedImage gameView = ScreenManager.captureWindow();
+      Rectangle boundingBox = TemplateMatching.match(imagePath, gameView, threshold, false);
+
+      if (boundingBox == null || boundingBox.isEmpty()) {
+        logger.addLog("Template match failed: No valid bounding box.");
+        return false;
+      }
+
+      return true;
+
+    } catch (Exception e) {
+      logger.addLog("clickImage failed: " + e.getMessage());
+      stop();
+    }
+    return false;
+  }
 }

src/main/java/com/chromascape/utils/core/input/mouse/MousePathing.java

@@ -184,8 +184,10 @@ private static int[] calculateOffset(final int distance) {
       return new int[] {10, 30};
     } else if (distance >= 100) {
       return new int[] {5, 10};
-    } else {
+    } else if (distance >= 20) {
       return new int[] {3, 5};
+    } else {
+      return new int[] {2, 4};
     }
   }
 
@@ -241,17 +243,19 @@ private static double calculateEasing(final int distance) {
     if (distance >= 1200) {
       return 16;
     } else if (distance >= 1000) {
-      return 12;
+      return 14;
     } else if (distance >= 800) {
-      return 10;
+      return 12;
     } else if (distance >= 600) {
-      return 8;
+      return 10;
     } else if (distance >= 400) {
-      return 6;
+      return 8;
     } else if (distance >= 200) {
-      return 5;
-    } else {
+      return 6;
+    } else if (distance >= 100) {
       return 4;
+    } else {
+      return 2;
     }
   }
 }

src/main/java/com/chromascape/utils/core/runtime/HotkeyListener.java

@@ -1,5 +1,6 @@
 package com.chromascape.utils.core.runtime;
 
+import com.chromascape.base.BaseScript;
 import com.chromascape.controller.Controller;
 import com.github.kwhat.jnativehook.GlobalScreen;
 import com.github.kwhat.jnativehook.NativeHookException;
@@ -17,7 +18,7 @@
  */
 public class HotkeyListener implements NativeKeyListener {
 
-  private final Controller controller;
+  private final BaseScript baseScript;
 
   // These track whether the shutdown hotkeys are currently being held
   private boolean equals = false;
@@ -26,10 +27,10 @@ public class HotkeyListener implements NativeKeyListener {
   /**
    * Constructs a new HotkeyListener bound to a specific Controller instance.
    *
-   * @param controller The controller whose shutdown method will be triggered by the hotkey.
+   * @param baseScript The controller whose shutdown method will be triggered by the hotkey.
    */
-  public HotkeyListener(final Controller controller) {
-    this.controller = controller;
+  public HotkeyListener(final BaseScript baseScript) {
+    this.baseScript = baseScript;
   }
 
   /**
@@ -74,12 +75,12 @@ public void nativeKeyPressed(final NativeKeyEvent key) {
     if (key.getKeyCode() == NativeKeyEvent.VC_EQUALS) {
       equals = true;
       if (minus) {
-        controller.shutdown();
+        baseScript.stop();
       }
     } else if (key.getKeyCode() == NativeKeyEvent.VC_MINUS) {
       minus = true;
       if (equals) {
-        controller.shutdown();
+        baseScript.stop();
       }
     }
   }

src/main/java/com/chromascape/utils/core/runtime/ScriptStoppedException.java

@@ -0,0 +1,21 @@
+package com.chromascape.utils.core.runtime;
+
+/**
+ * Exception used to indicate that a running script has been requested to stop.
+ *
+ * <p>This unchecked exception is thrown internally to signal that the script execution
+ * should be terminated gracefully. It can be caught by the script runner to halt execution
+ * without treating the stop as an error.
+ *
+ * <p>Typically, this exception is thrown by calling {@code stop()} methods in the script
+ * lifecycle to immediately exit the current execution cycle.
+ */
+public class ScriptStoppedException extends RuntimeException {
+
+  /**
+   * Constructs a new ScriptStoppedException with a default message.
+   */
+  public ScriptStoppedException() {
+    super("Script stopped");
+  }
+}