Skip to content

Add OSD Display#11906

Open
Blinqks wants to merge 6 commits into
runelite:masterfrom
Blinqks:add-osd-display
Open

Add OSD Display#11906
Blinqks wants to merge 6 commits into
runelite:masterfrom
Blinqks:add-osd-display

Conversation

@Blinqks
Copy link
Copy Markdown

@Blinqks Blinqks commented May 13, 2026

Adds OSD Display — a custom HUD plugin for RuneLite.

Source repo: https://github.com/Blinqks/osd-display
Pinned commit: e8532a557ccbaf575bc40329e2bef15e150a82c3

What the plugin does

A combined HUD that puts the most-checked info in one configurable cluster:

  • Stat orbs — HP / Prayer / Special Attack / Run Energy, each rendered as a draggable liquid-fill orb with a glass sheen. Left-click dispatches the same widget action as the native minimap orb (Cure / Toggle Quick Prayers / Use Special Attack / Toggle Run); right-click injects the matching native action menu.
  • XP bar — last-trained skill icon plus a progress bar toward the next level or a user-set per-skill goal. Goals are entered via the in-game chatbox (no Swing popups). Right-click "Reset XP rate" on the bar.
  • Floating XP drops — animated gains, configurable color modes (skill / single / rainbow / gold), text styles, animations (float / bounce / slide / fade), and an optional damage number derived from HitsplatApplied (exact, not estimated from HP XP).
  • Multi-skill XP summary — separate draggable strip with rate, session XP, and ETA; switchable between last-skill and multi-skill modes. Right-click any skill on the stats tab to set a goal or toggle visibility.

Plugin-hub compliance notes

  • enabledByDefault = false
  • BSD-2-Clause license
  • No automation, no synthetic input, no memory reads — every interactive element dispatches MenuAction.CC_OP against the same widget the native orb uses
  • Custom orb icons are restricted to ~/.runelite/osd-display-icons/ (no arbitrary filesystem reads)
  • Hide OSRS Minimap Orbs is opt-in (default off); restores native widgets on plugin disable
  • No 3D model capture, no every-frame DrawManager listener
  • Goal dialog uses ChatboxPanelManager, not JOptionPane

Happy to iterate on review feedback.

@runelite-github-app
Copy link
Copy Markdown

runelite-github-app Bot commented May 13, 2026

@runelite-github-app
Copy link
Copy Markdown

runelite-github-app Bot commented May 13, 2026

This plugin requires a review from a Plugin Hub maintainer. The reviewer will request any additional changes if needed.


Internal use only: Reviewer details Maintainer details

@riktenx
Copy link
Copy Markdown
Member

riktenx commented May 17, 2026

use of client.menuAction is not allowed

@riktenx riktenx added the waiting for author waiting for the pr author to make changes or respond to questions label May 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

plugin added size-0 waiting for author waiting for the pr author to make changes or respond to questions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants