Build a KLite marketplace plugin.

Keep the plugin entrypoint, configuration, automation state machine, and overlay in separate classes. This makes shutdown behavior, testing, and marketplace review easier to reason about.

examples/klite-copper-tin-miner/
├── build.gradle.kts
└── src/main/java/net/runelite/client/plugins/klite/examples/miner/
    ├── CopperTinMinerPlugin.java
    ├── CopperTinMinerConfig.java
    ├── CopperTinMinerTask.java
    └── CopperTinMinerOverlay.java

The entrypoint connects the external plugin to KLite Core and owns every resource that must be released during shutdown.

@PluginDependency(KLitePlugin.class)
@PluginDescriptor(
    name = "Copper and Tin Miner",
    description = "Mines copper and tin near Varrock and banks only when full",
    version = "0.0.2",
    enabledByDefault = false,
    isExternal = true
)
public class CopperTinMinerPlugin extends Plugin
{
    // Inject KLite services and own startup/shutdown here.
}

Provide configuration through ConfigManager. The example exposes a Show overlay option enabled by default, while operational constants remain in the task implementation.

@Provides
CopperTinMinerConfig provideConfig(ConfigManager configManager)
{
    return configManager.getConfig(CopperTinMinerConfig.class);
}

The task implements AutomationTask and advances one bounded unit of work per tick. RuneLite operations return CompletableFuture values; wait through AutomationContext.await with an explicit timeout.

A successful Mine dispatch does not immediately permit another click. Track the rock ID, world location, dispatch time, and whether the mining animation has been observed.

Completion conditions

• The tracked rock disappears or changes object ID at the same tile.
• The mining animation was observed and then remains stopped for a confirmation interval.
• The animation never starts before the startup timeout, allowing one controlled retry.

activeRockId = selected.getObjectId();
activeRockLocation = selected.getLocation();
miningAnimationObserved = false;

// Every task tick:
// 1. Check whether the object ID at the tile changed.
// 2. Check whether the player is still animating.
// 3. Confirm that animation has stopped before selecting another rock.

Begin banking only when all 28 inventory slots are occupied and at least one item is not a pickaxe. This prevents empty, partial, and pickaxe-only inventories from opening the bank.

boolean inventoryFull = inventory.size() >= 28;
Optional<InventoryItem> depositable = inventory.stream()
    .filter(item -> !isPickaxe(item))
    .findFirst();

if (!banking && inventoryFull && depositable.isPresent())
{
    banking = true;
}

The plugin owns destinations and arrival radiuses. KLite Core owns route planning, collision data, waypoint selection, scene and minimap rendering, progress tracking, and stall recovery.

WebWalkResult result = context.await(
    webWalker.step(destination, arrivalDistance),
    API_TIMEOUT
);

if (result.getState() == WebWalkState.NO_PATH)
{
    throw new IllegalStateException(result.getMessage());
}

Keep plugin-specific status separate from the global KLite status overlay. The user should be able to identify what the task is doing without opening logs.

Use KLite Logs → Client / Plugin Debug for task and walker behavior. Use the Marketplace tab for artifact download, hash verification, class loading, enable/disable, and unload failures.

[CopperTinMiner] Tracking rock ... until mining stops or object changes.
[WebWalker] Integrated Shortest Path accepted route length=...
[WebWalker] Clicking waypoint ... surface=minimap
[CopperTinMiner] Deposit result: status=...

./gradlew :copper-tin-miner:clean :copper-tin-miner:jar --no-daemon

1. BuildCreate a reproducible JAR containing only the plugin implementation.
2. CopyPlace the JAR in marketplace-site/public/artifacts/.
3. VerifyCalculate the SHA-256 digest and exact file size.
4. CatalogUpdate plugins.json with version, hash, size, and entrypoint.
5. DeployPublish the static artifact and catalog together.
6. TestUnload the previous in-memory version before enabling the replacement.

• Declares @PluginDependency(KLitePlugin.class) when using KLite services.
• Does not bundle protected RuneLite or KLite classes.
• Stops automation and removes overlays during shutdown.
• Uses bounded asynchronous API calls.
• Does not retain passwords, secrets, or unbounded logs.
• Uses the shared WebWalker instead of implementing arbitrary movement.
• Logs state transitions and actionable failure details.
• Declares accurate version, minimum client version, authors, and entrypoints.