# RS-Cache
[![Build](https://github.com/jimvdl/rs-cache/workflows/build/badge.svg)](https://github.com/jimvdl/rs-cache)
[![Crate](https://img.shields.io/crates/v/rs-cache)](https://crates.io/crates/rs-cache)
[![Revision](https://img.shields.io/badge/RuneScape-180-blue)]()
[![API](https://docs.rs/rs-cache/badge.svg)](https://docs.rs/rs-cache)
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.41%2B-yellow)](https://blog.rust-lang.org/2020/01/30/Rust-1.41.0.html)
[![License](https://img.shields.io/crates/l/rs-cache?color=black)](https://github.com/jimvdl/rs-cache/blob/master/LICENSE)
A simple-to-use basic RuneScape cache utility. RS-Cache provides utilities to interact with the RuneScape cache.
Useful links:\
[Documentation](https://docs.rs/rs-cache)\
[Examples](examples/)\
[Release notes](https://github.com/jimvdl/rs-cache/releases)
Integration tests are running on RuneScape revision 180.
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`:
```toml
[dependencies]
rs-cache = "0.1"
```
Examples can be found in the [examples](examples/) directory. These examples include basic use cases and more advanced use cases such as the update protocol.
## Sources
The following sources aided with the development of this crate:\
[OpenRS](https://www.rune-server.ee/runescape-development/rs-503-client-server/downloads/312510-openrs-cache-library.html)\
[RuneLite](https://runelite.net/)\
[OSRS Cache Parsing Blog](https://www.osrsbox.com/blog/2018/07/26/osrs-cache-research-extract-cache-definitions/)\
[RSMod](https://github.com/Tomm0017/rsmod)\
[Librsfs](https://github.com/Velocity-/librsfs)
# License
RS-Cache is distributed under the terms of the MIT license.
See [LICENSE](LICENSE) for details.