Skip to content

Repository files navigation

Logo License Revision 240 Lines of Code

OS Map Viewer is a desktop map viewer for the Old School RuneScape world map.

The app includes a 2D world map, a 3D cache-backed scene viewer, cache-backed NPC spawns, and built-in plugins for RuneLite/HDOS ground markers, shortest-path routing, and printable mesh export.

3D Mode

When the app opens, choose 3D Viewer. You can also open 3D mode later from the Options menu. 3D mode reads your local OSRS cache and renders nearby regions, objects, and NPCs around a free camera.

Preview: image

3D mode does NOT rely on a Jagex client and does NOT modify game files.

2D Mode

When the app opens, choose 2D Map. You can also open 2D mode later from the Options menu. 2D mode reads the bundled FullWorldMap.atlas file and displays a layered 2D map. It can show the entire logical world map, including areas hidden by the OSRS vanilla world map.

Preview: image

2D mode relies on map data generated by the RuneLite map printer that is included in the bundled cache library. It does NOT modify game files.

Map Printer

The Options menu includes a map printer that uses the RuneLite cache library to read your installed game cache and print a new 2D atlas after game updates.

Requirements

  • Java 17 or newer
  • Gradle, or the included gradlew script (if building from source)

Main Features

  • View the bundled OSRS world map.
  • Choose 2D or 3D mode on startup.
  • Pan and zoom the map.
  • Fly around the game world in 3D with a free camera.
  • See NPCs at known OSRS spawn locations, with idle or walk animation when cache data supports it.
  • Use the 3D controls panel to change rendering, view distance, visible planes, NPC display, agility overlays, overlay colors, and jump targets.
  • Use the 3D minimap, floating world map, and area search to navigate.
  • Change map planes.
  • Search for map areas by name.
  • Jump to a region ID, region coordinates, or world tile.
  • Show or hide grid lines.
  • Show region IDs or region coordinates over the map.
  • Show or hide atlas text and map icons.
  • Show tooltips for supported map icon locations.
  • Lock the map so it cannot be moved or zoomed by mistake.
  • Change the map background color.
  • Save your last viewed region and zoom level.
  • Enable, disable, and load plugins. One plugin can be active at a time.
  • Use ground markers and shortest-path overlays in both 2D and 3D.
  • Export compacted NPC, object, or connected structure meshes as STL or OBJ files.

Documentation

This project was developed on Linux!

About

OS Map Viewer is a desktop map viewer for the Old School RuneScape world map. The app includes a 2D world map, a 3D cache-backed scene viewer, cache-backed NPC spawns, and built-in plugins for RuneLite/HDOS ground markers and shortest-path routing.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages