feat: add option to show hint to minigame start

Author: Misterio77

src/main/java/io/github/mmagicala/gnomeRestaurant/GnomeRestaurantConfig.java

@@ -86,4 +86,13 @@ default boolean showWorldMapPoint() {
     default boolean useShortestPath() {
         return true;
     }
+
+    @ConfigItem(
+            keyName = GnomeRestaurantPlugin.SHOW_MINIGAME_START,
+            name = "Show Start Hint",
+            description = "Configures whether to also show the path back to Gianne jnr."
+    )
+    default boolean showMinigameStart() {
+        return false;
+    }
 }

src/main/java/io/github/mmagicala/gnomeRestaurant/GnomeRestaurantPlugin.java

@@ -181,6 +181,9 @@ private void setupRefusedOrderTimer() {
      * Returns whether a step has been updated or not
      **/
     private boolean updateOrderStep() {
+        if (order == null) {
+            return true;
+        }
         // Go from the beginning of the recipe to the final item produced
 
         int newStepIdx = 0;
@@ -210,7 +213,16 @@ private int getItemCount(int itemId) {
     }
 
     private void setupUI() {
-        tooltipText = "Deliver " + order.getName() + " to " + customer.getName();
+        if (order == null) {
+            if (!config.showMinigameStart()) {
+                customer = null;
+                return;
+            }
+            tooltipText = "Go back to Gianne for another order";
+            customer = Customer.GIANNE;
+        } else {
+            tooltipText = "Deliver " + order.getName() + " to " + customer.getName();
+        }
 
         if (config.showOverlay()) {
             setupOverlay();
@@ -246,6 +258,9 @@ private void setupOverlay() {
     }
 
     private void setupOrderTimer() {
+        if (order == null) {
+            return;
+        }
         LOGGER.debug("Setting up order timer");
         int numSecondsLeft;
 
@@ -383,10 +398,6 @@ private void onAluftMinigameStarted(int value) {
     }
 
     private void onAluftCustomerChanged(int customerId) {
-        if (customerId == 0) {
-            customer = null;
-            return;
-        }
         customer = Customer.forId(customerId);
         LOGGER.debug("Customer is now {}", customer);
         queueUpdateOrder();
@@ -431,13 +442,21 @@ public void onItemContainerChanged(ItemContainerChanged event) {
     }
 
     private void updateOverlayHeader() {
-        var instruction = order.getSteps().get(stepIdx).getInstruction().getOverlayDirections();
-        overlayHeader = new OverlayHeader(instruction, stepIdx + 1, order.getSteps().size(), customer, order);
+        if (order == null) {
+            overlayHeader = new OverlayHeader(null, 0, 0, customer, order);
+        } else {
+            var instruction = order.getSteps().get(stepIdx).getInstruction().getOverlayDirections();
+            overlayHeader = new OverlayHeader(instruction, stepIdx + 1, order.getSteps().size(), customer, order);
+        }
     }
 
     private void rebuildOverlayTables() {
         clearOverlayTables();
 
+        if (order == null) {
+            return;
+        }
+
         List<Ingredient> stepIngredients = order.getSteps().get(stepIdx).getIngredients();
         rebuildOverlayTable(stepIngredients, stepIngredientsOverlayTable);
 
@@ -485,6 +504,7 @@ GnomeRestaurantConfig provideConfig(ConfigManager configManager) {
     public static final String SHOW_HINT_ARROW = "showHintArrow";
     public static final String SHOW_WORLD_MAP_POINT = "showWorldMapPoint";
     public static final String USE_SHORTEST_PATH = "useShortestPath";
+    public static final String SHOW_MINIGAME_START = "showMinigameStart";
 
     /**
      * Monitor changes to plugin config and update the plugin accordingly
@@ -532,6 +552,15 @@ public void onConfigChanged(ConfigChanged event) {
                 if (event.getNewValue().equals("false")) {
                     removeTimer();
                 }
+            } else if (event.getKey().equals(SHOW_MINIGAME_START)) {
+                if (event.getNewValue().equals("false")) {
+                    removeOverlay();
+                    removeWorldMapPoint();
+                    client.clearHintArrow();
+                    removeShortestPath();
+                } else {
+                    queueUpdateOrder();
+                }
             }
         }
     }

src/main/java/io/github/mmagicala/gnomeRestaurant/order/Customer.java

@@ -9,6 +9,7 @@
 import java.util.List;
 
 public enum Customer {
+    GIANNE(0, "Gianne jnr.", CustomerLocation.fixed(NpcID.ALUFT_GNOME_DELIVERY_CONTROLLER, 2439, 3501, 1)),
 
     TRAINER_NACKLEPEN(1, "Trainer Nacklepen", CustomerLocation.fixed(NpcID.GNOME_TORTOISE_TRAINER, 2421, 3525)),
     HIS_ROYAL_HIGHNESS_KING_NARNODE(2, "King Narnode Shareen", CustomerLocation.fixed(NpcID.GRANDTREE_NARNODE, 2466, 3497)),

src/main/java/io/github/mmagicala/gnomeRestaurant/overlay/GnomeRestaurantOverlay.java

@@ -70,10 +70,20 @@ public GnomeRestaurantOverlay(
     @Override
     public Dimension render(Graphics2D graphics) {
         var header = plugin.overlayHeader();
-        renderOrderOverlay(header);
+        if (header.order != null) {
+            renderOrderOverlay(header);
+        } else {
+            renderStartOverlay(header);
+        }
         return super.render(graphics);
     }
 
+    private void renderStartOverlay(OverlayHeader header) {
+        String headerText = "Go back to Gianne for another order";
+        LineComponent headerComponent = LineComponent.builder().left(headerText).build();
+        panelComponent.getChildren().add(headerComponent);
+    }
+
     private void renderOrderOverlay(OverlayHeader header) {
         String headerCustomerText = header.order.getName() + " to " + header.customer.getName();
         LineComponent headerCustomerComponent = LineComponent.builder().left(headerCustomerText).build();