Add Custom Script Directory Support (#41)

- Scripts can now be placed in subdirectories under /scripts (subdirectory names can be anything).
- These subdirectories are ignored by Git (so your custom scripts won’t get committed by accident).
- Scripts stored this way are still fully functional and discoverable by the system, just like scripts in the top-level /scripts folder.
- `PointSelector` now has a second function `getRandomPointByColour() to accept `ColourObj`s directly, allowing users to store colours inline.

Author: evoke-afk

src/main/java/com/chromascape/utils/actions/PointSelector.java

@@ -15,55 +15,41 @@
 import org.apache.logging.log4j.Logger;
 
 /**
- * The {@code PointSelector} class provides utility methods for selecting random
- * points within
- * graphical zones. These methods are designed to reduce code duplication and
- * streamline common
- * actions when automating interactions with graphical objects like colours or
- * images.
+ * The {@code PointSelector} class provides utility methods for selecting random points within
+ * graphical zones. These methods are designed to reduce code duplication and streamline common
+ * actions when automating interactions with graphical objects like colours or images.
  *
- * <p>
- * <b>Features:</b>
+ * <p><b>Features:</b>
  *
  * <ul>
- * <li>Finds a random point within the bounding box of a detected image
- * template.
- * <li>Finds a random point inside the contour of the first detected object of a
- * specified color.
+ *   <li>Finds a random point within the bounding box of a detected image template.
+ *   <li>Finds a random point inside the contour of the first detected object of a specified colour.
  * </ul>
  *
- * <p>
- * These utilities are commonly reused across scripts written for the
- * ChromaScape automation
- * framework. The class does not perform any input actions (such as clicking),
- * but provides the
+ * <p>These utilities are commonly reused across scripts written for the ChromaScape automation
+ * framework. The class does not perform any input actions (such as clicking), but provides the
  * coordinates needed for such actions.
  *
- * <p>
- * <b>Typical Usage:</b>
+ * <p><b>Typical Usage:</b>
  *
  * <pre>
  * Point pointInImage = PointSelector.getRandomPointInImage(templatePath, gameView, threshold);
  * Point pointInColour = PointSelector.getRandomPointInColour(gameView, "Purple", maxAttempts);
  * </pre>
  *
- * <p>
- * All methods are static and thread-safe.
+ * <p>All methods are static and thread-safe.
  */
 public class PointSelector {
 
   private static final Logger logger = LogManager.getLogger(PointSelector.class);
 
   /**
-   * Searches for the provided image template within the current game view, then
-   * returns a random
-   * point within the detected bounding box if the match exceeds the defined
-   * threshold.
+   * Searches for the provided image template within the current game view, then returns a random
+   * point within the detected bounding box if the match exceeds the defined threshold.
    *
-   * @param templatePath the BufferedImage template to locate and click within the
-   *                     larger image view
-   * @param image        the larger image, what you're searching in
-   * @param threshold    the openCV threshold to decide if a match exists
+   * @param templatePath the BufferedImage template to locate and click within the larger image view
+   * @param image the larger image, what you're searching in
+   * @param threshold the openCV threshold to decide if a match exists
    * @return The point to click
    */
   public static Point getRandomPointInImage(
@@ -86,22 +72,19 @@ public static Point getRandomPointInImage(
   }
 
   /**
-   * Attempts to find a random point inside the contour of the first object of the
-   * specified color.
+   * Attempts to find a random point inside the contour of the first object of the specified colour.
    *
-   * @param image       the image to search in (e.g. game view from controller)
-   * @param colourName  the name of the color (must match ColourInstances key,
-   *                    e.g. "Purple")
-   * @param maxAttempts maximum number of attempts to find a point inside the
-   *                    contour
+   * @param image the image to search in (e.g. game view from controller)
+   * @param colourName the name of the colour (must match ColourInstances key, e.g. "Purple")
+   * @param maxAttempts maximum number of attempts to find a point inside the contour
    * @return a random Point inside the contour, or null if not found/error
    */
   public static Point getRandomPointInColour(
       BufferedImage image, String colourName, int maxAttempts) {
-    return getRandomPointByColor(image, ColourInstances.getByName(colourName), maxAttempts);
+    return getRandomPointByColour(image, ColourInstances.getByName(colourName), maxAttempts);
   }
 
-  public static Point getRandomPointByColor(
+  public static Point getRandomPointByColour(
       BufferedImage image, ColourObj colourName, int maxAttempts) {
     List<ChromaObj> objs;
     try {

src/main/java/com/chromascape/web/SendScripts.java

@@ -27,18 +27,19 @@ public class SendScripts {
   /**
    * Returns a list of script file names located in the {@code scripts} directory.
    *
-   * <p>This endpoint scans only the top-level entries (non-recursive).
+   * <p>This endpoint scans the directory recursively so nested folders are included in the results.
    *
    * @return a list of script file names relative to {@code SCRIPTS_DIR}
    * @throws IOException if an I/O error occurs while reading the directory
    */
   @GetMapping("/scripts")
   public List<String> getScripts() throws IOException {
-    try (Stream<Path> stream = Files.walk(SCRIPTS_DIR, 1)) {
+    try (Stream<Path> stream = Files.walk(SCRIPTS_DIR)) {
       return stream
-          .filter(path -> !path.equals(SCRIPTS_DIR))
+          .filter(Files::isRegularFile)
           .map(SCRIPTS_DIR::relativize)
-          .map(Path::toString)
+          .map(path -> path.toString().replace("\\", "/"))
+          .sorted()
           .collect(Collectors.toList());
     }
   }

src/main/java/com/chromascape/web/instance/ScriptInstance.java

@@ -38,7 +38,7 @@ public ScriptInstance(RunConfig config, WebSocketStateHandler stateHandler)
     this.stateHandler = stateHandler;
 
     String fileName = config.getScript();
-    String className = fileName.replace(".java", "");
+    String className = fileName.replace(".java", "").replace("/", ".");
 
     Class<?> script = Class.forName("com.chromascape.scripts." + className);
     Constructor<?> constructor = script.getDeclaredConstructor(boolean.class);