Add Trawling feature

.gitignore

@@ -7,6 +7,4 @@ build
 nbactions.xml
 nb-configuration.xml
 nbproject/
-
-.junie
-.claude
+bin/*

README.md

@@ -17,6 +17,11 @@ Sailing quality-of-life for charting, navigation, facilities, and more.
 
 ![Trimmable Sails](docs/trimmable-sails.png)
 
+## Trawling
+- Highlight Net Buttons: Automatically highlights fishing net depth adjustment buttons when they need to be changed to match the current shoal depth.
+  - Calibration: Shows "Calibrating Nets..." message until the plugin observes a complete shoal movement cycle to sync timing.
+- Show Net Capacity: Displays the current fish count in your nets (max 250 for two nets, 125 for one net).
+
 ## Crewmates
 - Mute Overhead Text: Mute crewmate overhead messages.
   - Modes: `None` (default), `Other boats`, `All`.

build.gradle

@@ -34,6 +34,7 @@ dependencies {
     testAnnotationProcessor 'org.projectlombok:lombok:1.18.30'
 
 	testImplementation 'junit:junit:4.12'
+	testImplementation 'org.mockito:mockito-core:3.12.4'
 	testImplementation group: 'net.runelite', name:'client', version: runeLiteVersion
 	testImplementation group: 'net.runelite', name:'jshell', version: runeLiteVersion
 }

src/main/java/com/duckblade/osrs/sailing/SailingConfig.java

@@ -33,6 +33,14 @@ public interface SailingConfig extends Config
 	)
 	String SECTION_FACILITIES = "facilities";
 
+	@ConfigSection(
+		name = "Trawling",
+		description = "Settings for fishing net trawling.",
+		position = 250,
+		closedByDefault = true
+	)
+	String SECTION_TRAWLING = "trawling";
+
 	@ConfigSection(
 		name = "Crewmates",
 		description = "Settings for your crewmates.",
@@ -399,6 +407,140 @@ default Color highlightCrystalExtractorInactiveColour()
 		return Color.YELLOW;
 	}
 
+    @ConfigItem(
+		keyName = "trawlingHighlightShoals",
+		name = "Highlight Shoals",
+		description = "Highlight fish shoals with a 10x10 tile area.",
+		section = SECTION_TRAWLING,
+		position = 1
+	)
+	default boolean trawlingHighlightShoals()
+	{
+		return false;
+	}
+
+	@ConfigItem(
+		keyName = "trawlingShoalHighlightColour",
+		name = "Shoal Highlight Colour",
+		description = "Colour to highlight fish shoals.",
+		section = SECTION_TRAWLING,
+		position = 2
+	)
+	@Alpha
+	default Color trawlingShoalHighlightColour()
+	{
+		return Color.CYAN;
+	}
+
+	@ConfigItem(
+		keyName = "trawlingShowNetCapacity",
+		name = "Show Net Capacity",
+		description = "Display the current fish count in your nets.",
+		section = SECTION_TRAWLING,
+		position = 3
+	)
+	default boolean trawlingShowNetCapacity()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+		keyName = "trawlingShowFishCaught",
+		name = "Show Fish Caught",
+		description = "Display the number of each fish caught in the session.",
+		section = SECTION_TRAWLING,
+		position = 4
+	)
+	default boolean trawlingShowFishCaught()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+		keyName = "trawlingShowNetDepthTimer",
+		name = "Show Net Depth Timer",
+		description = "Display an overlay showing ticks until net depth change.",
+		section = SECTION_TRAWLING,
+		position = 5
+	)
+	default boolean trawlingShowNetDepthTimer()
+	{
+		return false;
+	}
+
+	@ConfigItem(
+		keyName = "trawlingShowShoalPaths",
+		name = "Show Shoal Routes",
+		description = "Display the known routes for shoals.",
+		section = SECTION_TRAWLING,
+		position = 6
+	)
+	default boolean trawlingShowShoalPaths()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+		keyName = "trawlingShoalPathColour",
+		name = "Route Colour",
+		description = "Colour for displaying shoal routes.",
+		section = SECTION_TRAWLING,
+		position = 7
+	)
+	@Alpha
+	default Color trawlingShoalPathColour()
+	{
+		return Color.WHITE;
+	}
+
+	@ConfigItem(
+		keyName = "trawlingShowShoalDirectionArrows",
+		name = "Show Direction Arrows",
+		description = "Display directional arrows along shoal routes to indicate movement direction.",
+		section = SECTION_TRAWLING,
+		position = 8
+	)
+	default boolean trawlingShowShoalDirectionArrows()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+		keyName = "highlightNetButtons",
+		name = "Highlight Net Buttons ",
+		description = "Highlight the net button to move to the correct shoal depth.",
+		section = SECTION_TRAWLING,
+		position = 9
+	)
+	default boolean highlightNetButtons()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+		keyName = "notifyDepthChange",
+		name = "Notify Shoal Depth Changed",
+		description = "Notify you when the shoal changes depth.",
+		section = SECTION_TRAWLING,
+		position = 9
+	)
+	default Notification notifyDepthChange()
+	{
+		return Notification.OFF;
+	}
+
+	@ConfigItem(
+		keyName = "notifyShoalMove",
+		name = "Notify Shoal Move",
+		description = "Notify you when the shoal moves.",
+		section = SECTION_TRAWLING,
+		position = 10
+	)
+	default Notification notifyShoalMove()
+	{
+		return Notification.OFF;
+	}
+
 	enum CrewmateMuteMode
 	{
 		NONE,

src/main/java/com/duckblade/osrs/sailing/features/trawling/FishCaughtTracker.java

@@ -0,0 +1,170 @@
+package com.duckblade.osrs.sailing.features.trawling;
+
+import com.duckblade.osrs.sailing.features.util.BoatTracker;
+import com.duckblade.osrs.sailing.features.util.SailingUtil;
+import com.duckblade.osrs.sailing.model.Boat;
+import com.duckblade.osrs.sailing.module.PluginLifecycleComponent;
+import java.util.Collections;
+import java.util.EnumMap;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import lombok.extern.slf4j.Slf4j;
+import net.runelite.api.ChatMessageType;
+import net.runelite.api.Client;
+import net.runelite.api.GameState;
+import net.runelite.api.events.ChatMessage;
+import net.runelite.api.events.GameStateChanged;
+import net.runelite.client.eventbus.Subscribe;
+import org.apache.commons.lang3.ArrayUtils;
+
+@Slf4j
+@Singleton
+public class FishCaughtTracker implements PluginLifecycleComponent {
+    public static final Pattern CATCH_FISH_REGEX =
+        Pattern.compile("^(.+?) catch(?:es)? (an?|two|three|four|five|six) (.+?)!$");
+    private final Client client;
+    private final BoatTracker boatTracker;
+
+    /**
+     * All the fish that was caught into the net since it was last emptied.
+     */
+    private final EnumMap<Shoal, Integer> fishInNet = new EnumMap<>(Shoal.class);
+
+    /**
+     * All the fish that was collected by emptying the nets.
+     */
+    private final EnumMap<Shoal, Integer> fishCollected = new EnumMap<>(Shoal.class);
+
+    /**
+     * Creates a new FishCaughtTracker with the specified dependencies.
+     *
+     * @param client the RuneLite client instance
+     * @param boatTracker tracker for boat information including net capacity
+     */
+    @Inject
+    public FishCaughtTracker(Client client, BoatTracker boatTracker) {
+        this.client = client;
+        this.boatTracker = boatTracker;
+    }
+
+    @Override
+    public void startUp() {
+        log.debug("FishCaughtTracker started");
+        reset();
+    }
+
+    @Override
+    public void shutDown() {
+        log.debug("FishCaughtTracker shut down");
+        reset();
+    }
+
+    @Subscribe
+    public void onGameStateChanged(GameStateChanged e) {
+        GameState state = e.getGameState();
+        if (state == GameState.HOPPING || state == GameState.LOGGING_IN) {
+            log.debug("{}; nets are forcibly emptied", state);
+            log.debug("lost fish: {}", fishInNet);
+            fishInNet.clear();
+        }
+    }
+
+    @Subscribe
+    public void onChatMessage(ChatMessage e) {
+        if (!SailingUtil.isSailing(client) ||
+            (e.getType() != ChatMessageType.GAMEMESSAGE && e.getType() != ChatMessageType.SPAM)) {
+            return;
+        }
+
+        String message = e.getMessage();
+        if (message.equals("You empty the nets into the cargo hold.")) {
+            // TODO: handle trying to empty net when already empty (in case of desync)
+            log.debug("Nets manually emptied; collecting fish: {}", fishInNet);
+
+            for (var entry : fishInNet.entrySet()) {
+                fishCollected.merge(entry.getKey(), entry.getValue(), Integer::sum);
+            }
+
+            fishInNet.clear();
+            return;
+        }
+
+        Matcher matcher = CATCH_FISH_REGEX.matcher(message);
+        if (!matcher.find()) {
+            return;
+        }
+
+        String catcher = matcher.group(1);
+        String quantityWord = matcher.group(2);
+        String fish = matcher.group(3);
+
+        int quantity = wordToNumber(quantityWord);
+        if (quantity == -1) {
+            log.debug("Unable to find quantity for message {}", message);
+            return;
+        }
+
+        final var shoal = Shoal.byName(fish);
+        if (shoal == null) {
+            return;
+        }
+
+        log.debug(message);
+        log.debug("{} {} caught by {}; total: {}", quantity, fish, catcher, fishInNet.get(shoal));
+        fishInNet.merge(shoal, quantity, Integer::sum);
+    }
+
+    private int wordToNumber(String word) {
+        if (word.equals("an")) {
+            word = "a";
+        }
+
+        String[] words = {"a", "two", "three", "four", "five", "six"};
+        int wordIndex = ArrayUtils.indexOf(words, word);
+
+        if (wordIndex == ArrayUtils.INDEX_NOT_FOUND) {
+            log.debug("Unable to find quantity for word {}", word);
+            return -1;
+        }
+
+        return wordIndex + 1;
+    }
+
+    /**
+     * Gets the current net capacity based on the player's boat.
+     *
+     * @return the net capacity, or 0 if no boat is available
+     */
+    public int getNetCapacity() {
+        Boat boat = boatTracker.getBoat();
+        return boat != null ? boat.getNetCapacity() : 0;
+    }
+
+	public int getFishInNetCount() {
+		return fishInNet.values()
+			.stream()
+			.reduce(Integer::sum)
+			.orElse(0);
+	}
+
+    /**
+     * All fish caught, either currently in the net or previously collected.
+     */
+    public Map<Shoal, Integer> getFishCaught() {
+        var fishCaught = new EnumMap<>(fishCollected);
+        for (var entry : fishInNet.entrySet()) {
+            fishCaught.merge(entry.getKey(), entry.getValue(), Integer::sum);
+        }
+
+        return Collections.unmodifiableMap(fishCaught);
+    }
+
+    private void reset() {
+        fishInNet.clear();
+        fishCollected.clear();
+    }
+}