Info/Mejrs' Cache Tool

Overview

Mejrs' Cache Tool (also called RS3 cache tool) is an open-source tool that can extract data from the NXT cache created by Mejrs. The project's GitHub page can be found here

The tool do not supports Java caches.

Installation instructions

Instructions are incomplete

Check offline compliance

Consider bundling that tool with RuneLibris

• Download the repo files from here
• Run cargo +nightly install --git https://github.com/mejrs/rs3cache/ rs3cache --bin rs3 --features=rs3 in Powershell
• Install Python through python-3.13.3-amd64.exe Do not install in a custom path and check "PATH" option
• Run "-m pip install maturin in CMD
• Install Rust through rustup-init.exe
• Run cd "C:\Users\PC\Desktop\Mejrs cache tool old (important)\2 (Clean install)\rs3cache-master\rs3_py" in CMD
• Run maturin build in CMD
• Run pip install "C:\Users\PC\Desktop\Mejrs cache tool old (important)\2 (Clean install)\rs3cache-master\target\wheels\rs3-0.1.0-cp313-cp313-win_amd64.whl" in CMD

Setting the cache path

• On Windows 10, open the settings, go into "system", go to "about", "system info" and "advanced system setting".
• Add the RS3_CACHE_INPUT_FOLDER, the second string being the path to said cache
  • The NXT cache is in C:\ProgramData\Jagex\RuneScape by default

Running a script

• Open a Powershell prompt in the location of the script.py you want to run.
• Run py "script.py" | Out-File "data.txt" in Powershell

Dumping enums

• In CMD, type rs3 --dump enums
• The output will be in C:\Users\%USER%\enums.json

Dumping structs

• In CMD, type rs3 --dump structs
• The output will be in C:\Users\%USER%\structs.json

Dumping mapsquare renders

• In CMD, type rs3 --render all
• The output will be in C:\Users\%USER%\mapsquares

Scripts

• Script to dump the position of all locs
• Script to dump all locs of a given mapsquare in RuneLibris format
• Script to dump the definitions of a single loc
• Script to dump the defs of every loc (outputs an error when done)
• Script to dump the defs of every loc (escluding nulls) (outputs an error when done)
• Script to dump the defs of every NPCs (excluding nulls) (outputs an error when done)