Skip to content

Mitchole/waypointer

Repository files navigation

Waypointer

Waypointer

Save your favourite Old School RuneScape locations and travel to them in one click.

License: BSD-2-Clause Java 11 RuneLite Plugin

The Waypointer panel docked in the RuneLite sidebar, the nearest-landmark bar across the top and categories expanded below

Waypointer is a sidebar panel for the places you keep going back to: banks, bosses, farm patches, teleport spots. Mark a tile, name it, file it under a category. Click Play on any waypoint and the Shortest Path plugin draws the route to it on your world map and minimap.

It also keeps a one-click bar to the nearest bank, altar, or anvil, and lets you string waypoints into guided Routes for farm runs and agility laps.

Waypointer needs the Shortest Path plugin. It does the actual pathfinding behind every Play button, the nearest-landmark bar, and routes. Install it from the Plugin Hub before you start.


Contents


Getting started

  1. Install the Shortest Path plugin from the RuneLite Plugin Hub. Waypointer relies on it for all pathfinding.
  2. Install Waypointer from the RuneLite Plugin Hub.
  3. Open the Waypointer panel from the RuneLite sidebar. The tabs across the top are My Waypoints, Presets, and Routes.
  4. Your library starts empty. It is saved per RuneScape account, so the panel stays empty until you log in. Add your own waypoints, or open the Presets tab to start from a curated set.

Saving a waypoint

Four ways to capture a tile:

  • Mark current location saves the tile your character is standing on.
  • Right-click the world map and choose Save as Waypoint.
  • Shift right-click a tile in the 3D world and choose Save as Waypoint.
  • Right-click an NPC or object and choose Save as Waypoint. The name and tile at the moment you click become the defaults.

The last two are off by default; turn them on in Settings.

Each one opens a small dialog where you set the name and pick a category. Stand inside a known bank, altar, anvil, furnace, fairy ring, dungeon entrance, boss arena, or other named landmark, and the name is filled in for you.

The capture dialog with the name pre-filled from the landmark under the player and the category dropdown showing

Organising your library

  • Sort waypoints into categories you name yourself. A fixed Uncategorized bucket holds anything you have not filed.
  • Pin a waypoint to lift it into a section at the very top of the panel, above the categories, for the handful you path to constantly.
  • Drag the handle on a row to reorder a waypoint, or to move it into another category.
  • Drag a category header to reorder the categories.
  • Give any category or waypoint an icon from the in-game sprite picker.
  • Hover a row to read the first line of its notes without opening it.
  • Click a row for an inline editor over its name, category, notes, and tile. Recapture rewrites the waypoint to wherever you are standing now.

A category expanded with the inline editor open on a waypoint, showing the name, notes, and category fields

Travelling to a waypoint

Click Play on a waypoint. Waypointer hands the tile to Shortest Path, which draws the route on the world map and minimap. While a path is active, a Pathing to strip sits at the top of the panel; clear it with Stop pathing in the overflow () menu.

A couple of safety nets, both on by default and both toggleable in Settings:

  • Rows whose tile is in the Wilderness carry a skull, and Playing one asks you to confirm first.
  • Auto-path to death location starts a route back to where you died the moment it happens, so you can run for your gravestone without fishing for the tile.

The nearest-landmark bar

Across the top of the panel is a row of landmark buttons: bank, altar, anvil, and the like. Click one and Waypointer paths to the nearest landmark of that type from wherever you are standing, no saved waypoint needed. The button on the bar lets you choose which landmark types show and in what order. Hide the whole bar from Settings if you would rather not have it.

Routes

A Route is an ordered list of stops you run one after another: a herb farm run, an agility lap, a wintertodt prep loop. Open the Routes tab to build and run them.

A route is made of steps, and there are two kinds:

  • Waypoint steps path to a tile and advance on their own once you arrive.
  • Manual steps are a line of text ("climb the ladder", "bank everything") that wait for you to press Next.

Build a route by adding steps from your library, marking your current tile as you walk it, or typing a manual instruction. Turn on repeat for a loop that starts over at the end.

Run a route from the playback bar: Back, Next, Stop, and a step counter. Set a next-step hotkey in Settings to advance without leaving the game, and keep the in-game route box on screen so the current step is always visible. Share a route with anyone using an RT1: code.

The Routes tab mid-run: the playback bar with its step counter and the in-game route box showing the current step

Preset waypoints

New to the plugin, or picking up content you have not mapped yet? Open the Presets tab.

It holds curated sets covering Slayer masters, herb and tree patches, bosses, raids, runecrafting altars, and more. Expand a set and click + on a waypoint to drop it into your library. Waypoints you already have are marked, so you will not add the same tile twice.

The preset browser with a set expanded, rows showing the already-added tick

Searching

The search bar at the top of the panel filters by waypoint name, notes, or category name as you type. Categories holding a match expand on their own. Clear the search and every category goes back to how you left it.

Sharing

  • Copy a share code for a single waypoint (WP1:), your whole library (WPL1:), or a route (RT1:).
  • Paste someone else's code through Import library... in the overflow menu.

Settings

Setting Default What it does
Right-click tiles to save Off Adds Save as Waypoint to the Shift right-click menu on tiles in the 3D world.
Right-click NPCs and objects to save Off Adds Save as Waypoint to the right-click menu on NPCs and objects.
Show 'nearest landmark' bar On Shows the one-click row of nearest-landmark shortcuts at the top of the panel.
Show 'Pathing to' banner On Shows a status strip at the top of the panel while a path is active.
Confirm before pathing into Wilderness On Asks before Playing a waypoint whose tile is in the Wilderness.
Show wilderness skull on row On Marks rows whose destination is in the Wilderness with a skull.
Auto-path to death location Off Starts a path back to your death tile when you die. Needs Shortest Path.
Newest pin at top On Orders pinned waypoints with the most recently pinned first.
Enable Routes On Shows the Routes tab. Off hides the feature.
Route: next step hotkey Unset Key that advances the current route step while a route runs.
Show in-game route box On Draws the read-only current-step box in the game window during a route.

Requirements

  • RuneLite.
  • The Shortest Path plugin. Waypointer hands every destination to it for pathfinding, so install it first. Without it the Play button, the nearest-landmark bar, and routes have nothing to draw a path with.

License

Released under the BSD 2-Clause License. Built on the RuneLite plugin framework.

Building from source, the code layout, and how to add preset waypoints or landmark locations are covered in DEVELOPER.md and CONTRIBUTING.md.

Credits

Landmark locations (banks, altars, anvils, furnaces, looms, spinning wheels, tanners, spirit trees, charter ships, fairy rings, slayer masters, and more) are derived from the OSRS Wiki under the Creative Commons Attribution-ShareAlike 4.0 International licence.

About

Save your favourite Old School RuneScape locations and travel to them in one click.

Topics

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages