Skip to content

Repository files navigation

2004-Museum

A desktop RuneScape cache museum. The bundled cache is revision 254 dated 7 September 2004, and the museum can keep it mounted alongside an Old School RuneScape JS5 cache such as the July 2016 build 62 OpenRS2 archive.

Built with Tauri, Svelte, Three.js, a revision-compatible legacy cache decoder, and @abextm/cache2 for OSRS JS5 caches.

Run

Double-click run.bat to install dependencies, regenerate the bundled revision 254 dump, and start the Tauri development app.

If an OSRS build 62 dump was generated previously, it is kept alongside the legacy cache and can be selected from the cache dropdown in the top bar. The first run after upgrading from the old single-cache layout automatically preserves an existing OSRS 62 public\dump as public\dumps\osrs62.

To import or refresh an OSRS OpenRS2 ZIP, pass it as the first argument:

run.bat "C:\Users\Callum\Downloads\cache-oldschool-live-en-b62-2016-07-03-14-29-31-openrs2#406.zip"

The app will then let you switch between the bundled RuneScape revision 254 cache and OSRS build 62 without restarting or redumping.

Dump caches

Generate the bundled legacy dump and keep any existing OSRS 62 dump:

npm run dump

Generate the bundled legacy dump and import/refresh OSRS at the same time:

npm run dump -- --cache "C:\path\to\cache.zip"

You can also set CACHE_SOURCE before running Tauri or the build scripts.

The multi-cache dumps are written to:

  • public\dumps\legacy — bundled RuneScape revision 254
  • public\dumps\osrs62 — Old School RuneScape build 62 when available

Each dump contains:

  • locs.json — world location/scenery definitions
  • npcs.json — NPC definitions
  • objects.json — inventory object/item definitions
  • models\*.bin — model files ready for the viewer's revision-aware decoder
  • animations\*.json — NPC sequence frames and skeleton transforms used by the interactive viewer
  • raw-config\*.dat / *.idx — unpacked definition tables for the legacy 2004 cache
  • manifest.json — cache provenance, revision/store metadata, and counts

For debugging or one-off exports, the original single-cache dumper is still available and accepts an output directory:

npm run dump:single -- --cache "C:\path\to\cache.zip" --output "C:\path\to\output"

The app supports name/ID search, sorting, pagination, generated thumbnails, composite models, cache recolours and scale transforms, orbit/zoom controls, wireframe view, per-record JSON export, cache switching, clickable NPC animation playback (definition-linked movement plus compatible cache sequences), and individual NPC model-part previewing. NPCs with multiple model IDs can be viewed as their normal combined model or stepped through one model at a time.

Supported cache layouts

RuneScape revision 254

The bundled cache store is in cache\ and came from cache-runescape-254-lostcity#5.zip. Keep the six main_file_cache files together when regenerating the default dump.

Old School RuneScape JS5

OSRS support accepts either an extracted native cache containing main_file_cache.dat2, main_file_cache.idx255, and the index files, or an OpenRS2 ZIP containing those files. Configs are decoded from JS5 index 2 and models from index 7. The renderer supports the original model layout plus the FF FF model format used by the 2016-era cache targeted by this project.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages