Brimhaven Agility Arena RuneLite Plugin

!Last Release

!Git Version&replace=v%241&label=Git%20Version)

This is a RuneLite plugin to help with the Brimhaven Agility Arena

in OSRS.

Features

Pathfinder

Draws the shortest path (weighted by obstacle) to the active ticket dispenser, taking into account your character's

agility level. The path is found using the A* pathfinding algorithm.

Entry panel

A panel that appears when near the entry of the agility arena, indicating whether the exit cooldown period has elapsed,

whether the entry fee has been paid, and whether the user has a follower.

Diary gloves warning

A panel that appears when your account has completed at least all the tasks in the Karamja Easy & Medium Diaries,

but your character is not wearing the Karamja Gloves 2, 3, or 4. Only appears when near the entrance or in the arena.

When worn, the Karamja Gloves 2, 3, and 4 all grant 10% extra agility experience from obstacles and cashing in tickets.

Plank obstacle solver

Highlights the correct plank of the three planks obstacle to use.

Configuration

Each feature of the plugin can be toggled on and off individually.

If the player wishes to avoid a particular obstacle, they can configure the path to do so. This may be useful to, for

example, avoid the darts obstacle which lowers your agility level by 2 when failed.

Possible future features

These are potential ideas for future expansions of this plugin.

• removing the hint arrow once the ticket has been claimed. A branch exists for

this here, but it breaks some of the core

Agility plugin's functionality, therefore this PR needs to be

accepted into Runelite before this feature can be added

Rejected features

• Menu deprioritization for incorrect planks in the 3 planks obstacle

* Although this does not explicitly violate any 3rd party guidelines from

Jagex, this has been requested not to be added by RuneLite

Changelog

1.2.0

• new configurable feature - highlighting for the 3 planks obstacle
• adds follower check to entry panel

1.1.0

• new configurable feature - entry panel
• new configurable feature - Karamja gloves warning

1.0.0

• computes & displays shortest path to active dispenser, with configurable options

Acknowledgements

• Wouldn't be possible without the excellent RuneLite, and has been generated

based on their example plugin

• The code used to actually draw the line on screen has been taken from

the Quest Helper plugin.

A pathfinding code was based

on Wikipedia's pseudocode implementation

• Information on the Brimhaven Agility Arena was taken from

the OSRS Wiki, in particular the layout, level

requirements, and time to complete each obstacle

• Jagex, and especially the OSRS team, for creating & maintaining Old School Runescape