feat: add current task overlay

Adds an overlay displaying the current task. This is the same overlay that is used in the GenerateTask videos.

Author: remcowesterhoud

src/main/java/com/westerhoud/osrs/taskman/TaskmanConfig.java

@@ -24,4 +24,13 @@ default String spreadsheetKey() {
   default String passphrase() {
     return "";
   }
+
+  @ConfigItem(
+      position = 2,
+      keyName = "showOverlay",
+      name = "Show current task overlay",
+      description = "Adds an overlay displaying the current task to the game client")
+  default boolean showOverlay() {
+    return true;
+  }
 }

src/main/java/com/westerhoud/osrs/taskman/TaskmanPlugin.java

@@ -5,6 +5,7 @@
 import com.westerhoud.osrs.taskman.domain.AccountProgress;
 import com.westerhoud.osrs.taskman.domain.Task;
 import com.westerhoud.osrs.taskman.service.SheetService;
+import com.westerhoud.osrs.taskman.ui.CurrentTaskOverlay;
 import com.westerhoud.osrs.taskman.ui.TaskmanPluginPanel;
 import java.awt.image.BufferedImage;
 import javax.inject.Inject;
@@ -18,6 +19,7 @@
 import net.runelite.client.plugins.PluginDescriptor;
 import net.runelite.client.ui.ClientToolbar;
 import net.runelite.client.ui.NavigationButton;
+import net.runelite.client.ui.overlay.OverlayManager;
 import net.runelite.client.util.ImageUtil;
 import okhttp3.OkHttpClient;
 
@@ -28,6 +30,8 @@ public class TaskmanPlugin extends Plugin {
   @Inject private ClientToolbar clientToolbar;
   @Inject private TaskmanConfig config;
   @Inject private OkHttpClient okHttpClient;
+  @Inject private OverlayManager overlayManager;
+  @Inject private CurrentTaskOverlay currentTaskOverlay;
 
   private TaskmanPluginPanel sidePanel;
   private SheetService sheetService;
@@ -49,6 +53,7 @@ protected void startUp() throws Exception {
             .panel(sidePanel)
             .build();
     clientToolbar.addNavigation(navigationButton);
+    overlayManager.add(currentTaskOverlay);
   }
 
   @Override
@@ -58,15 +63,21 @@ protected void shutDown() throws Exception {
   }
 
   public Task getCurrentTask() throws Exception {
-    return sheetService.getCurrentTask(getCredentials().getIdentifier());
+    final Task task = sheetService.getCurrentTask(getCredentials().getIdentifier());
+    currentTaskOverlay.setTask(task);
+    return task;
   }
 
   public Task generateTask() throws Exception {
-    return sheetService.generateTask(getCredentials());
+    final Task task = sheetService.generateTask(getCredentials());
+    currentTaskOverlay.setTask(task);
+    return task;
   }
 
   public Task completeTask() throws Exception {
-    return sheetService.completeTask(getCredentials());
+    final Task task = sheetService.completeTask(getCredentials());
+    currentTaskOverlay.setTask(task);
+    return task;
   }
 
   public AccountProgress progress() throws Exception {

src/main/java/com/westerhoud/osrs/taskman/domain/Task.java

@@ -15,13 +15,17 @@
 public class Task {
   private String name;
   private String imageUrl;
+  private transient BufferedImage image;
 
   public String getImageUrl() {
     return imageUrl.startsWith("http://") ? imageUrl.replace("http://", "https://") : imageUrl;
   }
 
   public BufferedImage getImage() {
-    BufferedImage image = null;
+    if (image != null) {
+      return image;
+    }
+
     try {
       final URL imageUrl = new URL(getImageUrl());
       image = ImageIO.read(imageUrl);

src/main/java/com/westerhoud/osrs/taskman/ui/CurrentTaskComponent.java

@@ -0,0 +1,50 @@
+package com.westerhoud.osrs.taskman.ui;
+
+import com.westerhoud.osrs.taskman.domain.Task;
+import java.awt.Dimension;
+import java.awt.Graphics2D;
+import java.awt.Image;
+import java.awt.Point;
+import java.awt.Rectangle;
+import java.awt.image.BufferedImage;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import net.runelite.client.ui.overlay.components.LayoutableRenderableEntity;
+import net.runelite.client.util.ImageUtil;
+
+@RequiredArgsConstructor
+@Setter
+public class CurrentTaskComponent implements LayoutableRenderableEntity {
+
+  public static final int BORDER_SIZE = 15;
+  private final Task task;
+  private final BufferedImage background =
+      ImageUtil.loadImageResource(getClass(), "empty_dark.png");
+
+  @Getter private final Rectangle bounds = new Rectangle();
+  private Point preferredLocation = new Point();
+
+  @Override
+  public void setPreferredSize(final Dimension dimension) {}
+
+  @Override
+  public Dimension render(final Graphics2D graphics) {
+    graphics.drawImage(background, preferredLocation.x, preferredLocation.y, null);
+
+    final int taskIconSize = background.getHeight() - (BORDER_SIZE * 2);
+    final int taskIconX = background.getWidth() - BORDER_SIZE - taskIconSize;
+
+    final Image resizedTaskIcon = resizeImage(task.getImage(), taskIconSize, taskIconSize);
+    graphics.drawImage(resizedTaskIcon, taskIconX, BORDER_SIZE, null);
+
+    final Dimension dimension = new Dimension(background.getWidth(), background.getHeight());
+    bounds.setLocation(preferredLocation);
+    bounds.setSize(dimension);
+    return dimension;
+  }
+
+  private Image resizeImage(final BufferedImage image, final int width, final int height) {
+    return image.getScaledInstance(width, height, Image.SCALE_SMOOTH);
+  }
+}

src/main/java/com/westerhoud/osrs/taskman/ui/CurrentTaskOverlay.java

@@ -0,0 +1,29 @@
+package com.westerhoud.osrs.taskman.ui;
+
+import com.westerhoud.osrs.taskman.TaskmanConfig;
+import com.westerhoud.osrs.taskman.domain.Task;
+import java.awt.Dimension;
+import java.awt.Graphics2D;
+import javax.inject.Inject;
+import lombok.Setter;
+import net.runelite.client.ui.overlay.OverlayPanel;
+
+public class CurrentTaskOverlay extends OverlayPanel {
+
+  @Setter private Task task;
+  private final TaskmanConfig config;
+
+  @Inject
+  public CurrentTaskOverlay(final TaskmanConfig config) {
+    this.config = config;
+  }
+
+  @Override
+  public Dimension render(final Graphics2D graphics) {
+    if (!config.showOverlay() || task == null) {
+      return null;
+    }
+    panelComponent.getChildren().add(new CurrentTaskComponent(task));
+    return super.render(graphics);
+  }
+}