Skip to content

PedroSilvaAlves/overlay-layouts

Repository files navigation

Overlay Layouts icon

Overlay Layouts

Capture, share, apply, and revert persisted RuneLite overlay layouts.

Overlay Layouts is a local-first RuneLite plugin for saving the overlay positions and infobox groups you have configured. Layouts can be reused across RuneLite profiles or shared as readable JSON files.

Features

  • Capture persisted overlay locations, sizes, snap positions, and origins.
  • Capture active infobox groups and orientation.
  • Keep a shared local library across RuneLite profiles.
  • Import/export files or copy/paste JSON.
  • Review and deselect individual changes before Apply or Revert.
  • Warn about canvas-size and fixed/resizable-mode differences.
  • Back up every apply and roll back partial failures.
  • No accounts, server, network access, telemetry, or gameplay automation.

Important limitation

RuneLite does not expose every overlay and origin through public Plugin Hub APIs. This plugin therefore manages only layout values that RuneLite has already persisted. Applying or reverting writes those profile-scoped values safely, then requires a RuneLite restart.

Untouched or inactive overlays may not appear in captures. Coordinates are preserved exactly and are not scaled. The review is textual rather than a potentially inaccurate graphical preview. See SPEC.md for the complete supported contract.

Development

Requirements:

  • JDK 11 or newer
  • The included Gradle wrapper

Run automated tests:

./gradlew clean test

Launch the development client:

./gradlew run

If you use a Jagex Account, follow RuneLite's development login instructions. Only the user should interact with RuneScape during manual testing.

Manual test

  1. Move or re-anchor an overlay and create or flip an infobox group.
  2. Capture the current layout from the sidebar.
  3. Move those elements elsewhere.
  4. Apply the saved layout and restart RuneLite.
  5. Verify the captured placement, then use Revert last and restart again.

Data location

Local layouts and apply backups live under .runelite/overlay-layouts/. User-initiated exports can be saved elsewhere through the system file chooser.

Licence

BSD 2-Clause. See LICENSE.

About

Capture, share, apply and revert persisted RuneLite overlay and infobox layouts.

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages