{"id":16519256,"url":"https://github.com/mejrs/rs3cache","last_synced_at":"2025-08-17T07:05:23.071Z","repository":{"id":38299101,"uuid":"354428829","full_name":"mejrs/rs3cache","owner":"mejrs","description":"Tools and api for reading and interpreting the RuneScape 3 game cache.","archived":false,"fork":false,"pushed_at":"2025-04-10T23:33:41.000Z","size":96092,"stargazers_count":31,"open_issues_count":3,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-11T00:18:12.285Z","etag":null,"topics":["python","runescape","runescape-cache","rust"],"latest_commit_sha":null,"homepage":"https://mejrs.github.io/rs3cache","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mejrs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-04T01:13:06.000Z","updated_at":"2025-04-10T23:33:44.000Z","dependencies_parsed_at":"2024-10-27T11:09:28.816Z","dependency_job_id":"fd62aa68-fd8c-4766-b8da-6c08b7ff0a7d","html_url":"https://github.com/mejrs/rs3cache","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mejrs/rs3cache","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mejrs%2Frs3cache","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mejrs%2Frs3cache/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mejrs%2Frs3cache/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mejrs%2Frs3cache/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mejrs","download_url":"https://codeload.github.com/mejrs/rs3cache/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mejrs%2Frs3cache/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270816653,"owners_count":24650851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","runescape","runescape-cache","rust"],"created_at":"2024-10-11T16:46:05.799Z","updated_at":"2025-08-17T07:05:23.055Z","avatar_url":"https://github.com/mejrs.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![actions status](https://github.com/mejrs/rs3cache/workflows/CI/badge.svg)](https://github.com/mejrs/rs3cache/actions)\n\n# RS3 cache tool\n\nTools and api for reading and interpreting the [RuneScape 3](https://www.runescape.com/community \"RuneScape\") game cache.\n\n## Installing the command line tool.\n\n- [Install the Rust compiler](https://doc.rust-lang.org/stable/book/ch01-01-installation.html \"Installation - The Rust Programming Language\").\n- Install the tool with \n   ```text\n    cargo +nightly install --git https://github.com/mejrs/rs3cache/ rs3cache --bin rs3 --features=rs3\n    ```\n\n## Usage \n- `rs3 --help` to see a list of commands:\n\n```text\nUSAGE:\n    rs3.exe [OPTIONS]\n\nOPTIONS:\n        --assert-coherence      Checks whether the cache is in a consistent state. Indices 14, 40,\n                                54, 55 are not necessarily complete\n        --dump \u003cDUMP\u003e...        Dumps the given archives [possible values: all, configs, music,\n                                achievements, sprites, locations, locations_each, tiles_each,\n                                location_configs, location_configs_each, npc_config, item_configs,\n                                maplabels, worldmaps, varbit_configs, structs, enums, underlays,\n                                overlays]\n    -h, --help                  Print help information\n        --input \u003cINPUT\u003e         The path where to look for the current cache [env:\n                                RS3_CACHE_INPUT_FOLDER=C:\\ProgramData\\Jagex\\RuneScape] [default: ]\n        --output \u003cOUTPUT\u003e       The path where to place output [env: RS3_CACHE_OUTPUT_FOLDER=]\n                                [default: ]\n        --render \u003cRENDER\u003e...    This exports them as small tiles, formatted as\n                                `\u003clayer\u003e/\u003cmapid\u003e/\u003czoom\u003e/\u003cplane\u003e_\u003cx\u003e_\u003cy\u003e.png`, suitable for use with\n                                interactive map libraries such as \u003chttps://leafletjs.com/\u003e, as seen\n                                on \u003chttps://mejrs.github.io/\u003e [possible values: all, map]\n```\n\n## Building as a Python library.\n\n### Using `maturin`\n\n- Clone the repository:\n   ```text\n   git clone https://github.com/mejrs/rs3cache\n   ```\n- Install [Python](https://www.python.org/downloads/ \"Download Python\"), version 3.7 or newer.\n    - Check that pip is installed (`python -m pip --version`).\n    - Install maturin: `pip install maturin`.\n- [Install the Rust compiler](https://doc.rust-lang.org/stable/book/ch01-01-installation.html \"Installation - The Rust Programming Language\").\n- Navigate to the `/rs3_py` folder and build a Python wheel with \n    ```text\n    maturin build\n    ```\n- Using the wheel from above, run\n    ```text\n    pip install \u003cpath to wheel\u003e\n    ```\n\n- For examples, see `rs3cache/examples`.\n\n### Using `setuptools-rust`\n\nThe following instructions are only tested on **windows**. If you run into issues on other platforms, try following [here](https://github.com/PyO3/setuptools-rust#binary-wheels-on-linux \"setuptools-rust\") or build with [maturin](https://pypi.org/project/maturin/ \"maturin\") instead.\n\n- Clone the repository:\n   ```text\n   git clone https://github.com/mejrs/rs3cache\n   ```\n- Install [Python](https://www.python.org/downloads/ \"Download Python\"), version 3.7 or newer..\n    - Check that pip is installed (`python -m pip --version`).\n    - Install setuptools: `pip install setuptools`.\n    - Install setuptools-rust: `pip install setuptools-rust`.\n- [Install the Rust compiler](https://doc.rust-lang.org/stable/book/ch01-01-installation.html \"Installation - The Rust Programming Language\").\n- Navigate to the `/rs3_py` folder and build a Python wheel with \n    ```text\n    python setup.py install\n    ```\n\n- For examples, see `rs3cache/examples`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmejrs%2Frs3cache","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmejrs%2Frs3cache","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmejrs%2Frs3cache/lists"}