Guide Overlay

OSRS guides as a checklist inside RuneLite — no more alt-tabbing to the wiki.

Pick a guide, and it appears in your sidebar as a checklist. The plugin checks steps off as you complete them, shows you where to go, and gets your bank ready for each section. Every feature below can be turned on or off in the settings.

Built-in guides

• B0aty HCIM Guide V3
• BRUHsailer Ironman Guide
• Add your own: paste any OSRS wiki guide link, or import from a file

Checklist

• Checkboxes for every step, with progress bars per section and overall
• Progress saves automatically and keeps across sessions
• Search your guide, or jump straight to your next unchecked step
• When a finished bank auto-collapses, the next one opens and scrolls into view by itself
• Starting mid-guide? Right-click any step to mark everything before it complete — or clear everything after it to rewind
• Separate progress per character — if your hardcore dies, the new one starts fresh
• Back up your progress to the clipboard and restore it anywhere

Auto-completion

• Steps check themselves off when the game confirms them: quests started/finished, skill levels reached, items collected
• Unticking a step manually always wins — it stays unticked

Step navigation

• Small ◀ ▶ arrow buttons check off your current step or un-check the last one — attached under the on-screen box, free-floating anywhere (Alt+drag), or hidden, your choice
• Optional keybinds for next/previous step, unbound by default and fully configurable

Finding your way

• Pin a step and its NPC gets the in-game hint arrow and a glowing outline
• Too far away? A compass arrow points toward them with the tile distance — and with nothing pinned it points at your next step's target automatically
• Compass looks are configurable: full dial or bare arrow, solid triangle or an arrow with a tail
• The world map marks where your next step wants you to go
• NPCs and ground items your current section needs are highlighted automatically

Fastest route

• The on-screen overlay suggests the quickest teleport to your next objective
• Only suggests teleports you can actually use — it checks your runes and jewelry in your inventory, gear, and bank ("in bank" items are labeled)
• Choose which kinds count: spells, teleport tablets, jewelry, other items
• Have the Shortest Path plugin installed? Guide Overlay sends it your destination so the walking path is drawn on the ground for you

Bank help

• Opening your bank shows a tab with just the items your current section needs
• Finished steps drop off the tab automatically
• Item pictures under each step turn green when you have the item, red when missing

On-screen overlay

• A small movable box shows your current section, next steps, and route tip
• The current step's item pictures can show right in the box (toggleable), so you see what to grab without opening the sidebar
• Everything repositions with Alt+drag and has size/font/color settings

Getting started

1. Install Guide Overlay from the RuneLite Plugin Hub
2. Click the scroll icon in the sidebar and confirm the one-time guide download
3. Play — right-click a step to sync the checklist to wherever you already are

Privacy & fair play

• Guides download once, only when you confirm — never automatically. Your guide and progress can't be changed behind your back
• Nothing about you or your account is ever sent anywhere
• The plugin only displays and tracks. It never clicks, moves, or acts for you

Development checks

• Run ./gradlew clean test before release.
• Run ./tools/audit.sh for dependency-free safety checks.
• Pin both raw GitHub data URLs to reviewed commit SHAs before Plugin Hub submission; tools/submit.sh performs that pinning automatically.

License

BSD 2-Clause. Guide content belongs to its original authors.