RS-Cache

A simple-to-use basic RuneScape cache utility. RS-Cache provides utilities to interact with the RuneScape cache.

Currently only supports the OSRS cache but RS3 support is in progress.

Follow this Quick Start guide to begin using rs-cache.

Useful links:
        Crates.io
        Documentation
        Examples

Integration tests are running on RuneScape revision 180, which you can run at any time because the cache is included in the ./data/cache directory.

The minimum supported rustc version is 1.41.

This crate is passively maintained. Additional features will be implemented once they are needed for my own server. If you require a certain feature feel free to open an issue.

Usage

Add this to your Cargo.toml:

[dependencies]
rs-cache = "0.3"

Examples can be found in the examples directory. These examples include setting up your own custom cache or store and how the update protocol could be handled.

Acknowledgements

The following sources aided with the development of this crate:
        OpenRS
        RuneLite
        OSRS Cache Parsing Blog
        RSMod
        Librsfs
        OSRSBox
        Jagex-Store-5
        OldScape-Cache

License

RS-Cache is distributed under the terms of the MIT license.

See LICENSE for details.