# RS-Cache
[](https://github.com/jimvdl/rs-cache)
[](https://crates.io/crates/rs-cache)
[]()
[](https://docs.rs/rs-cache)
[](https://blog.rust-lang.org/2020/01/30/Rust-1.41.0.html)
[](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.
_Currently only supports the OSRS cache but RS3 support is in progress._
Follow this [Quick Start](https://docs.rs/rs-cache/#quick-start) guide to begin using rs-cache.
Useful links:\
<img src="https://oldschool.runescape.wiki/images/thumb/5/5d/Fire_rune_detail.png/800px-Fire_rune_detail.png?07ed5" width="10"> [Crates.io](https://crates.io/crates/rs-cache)\
<img src="https://oldschool.runescape.wiki/images/thumb/7/74/Water_rune_detail.png/800px-Water_rune_detail.png?4e790" width="10"> [Documentation](https://docs.rs/rs-cache)\
<img src="https://oldschool.runescape.wiki/images/thumb/e/ef/Nature_rune_detail.png/800px-Nature_rune_detail.png?a062f" width="10"> [Examples](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`:
```toml
[dependencies]
rs-cache = "0.3"
```
Examples can be found in the [examples](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:\
<img src="https://oldschool.runescape.wiki/images/thumb/d/dc/Cosmic_rune_detail.png/800px-Cosmic_rune_detail.png?734d1" width="10"> [OpenRS](https://www.rune-server.ee/runescape-development/rs-503-client-server/downloads/312510-openrs-cache-library.html)\
<img src="https://oldschool.runescape.wiki/images/thumb/f/f3/Air_rune_detail.png/800px-Air_rune_detail.png?b7f49" width="10"> [RuneLite](https://runelite.net/)\
<img src="https://oldschool.runescape.wiki/images/thumb/0/0f/Law_rune_detail.png/800px-Law_rune_detail.png?dc1f3" width="10"> [OSRS Cache Parsing Blog](https://www.osrsbox.com/blog/2018/07/26/osrs-cache-research-extract-cache-definitions/)\
<img src="https://oldschool.runescape.wiki/images/thumb/a/ae/Chaos_rune_detail.png/800px-Chaos_rune_detail.png?0d8cb" width="10"> [RSMod](https://github.com/Tomm0017/rsmod)\
<img src="https://oldschool.runescape.wiki/images/thumb/8/8b/Soul_rune_detail.png/800px-Soul_rune_detail.png?75ada" width="10"> [Librsfs](https://github.com/Velocity-/librsfs)\
<img src="https://oldschool.runescape.wiki/images/thumb/c/c1/Blood_rune_detail.png/800px-Blood_rune_detail.png?2cf9e" width="10"> [OSRSBox](https://www.osrsbox.com/)\
<img src="https://oldschool.runescape.wiki/images/thumb/7/72/Earth_rune_detail.png/800px-Earth_rune_detail.png?991bd" width="10"> [Jagex-Store-5](https://github.com/guthix/Jagex-Store-5)\
<img src="https://oldschool.runescape.wiki/images/thumb/b/bd/Body_rune_detail.png/800px-Body_rune_detail.png?9e79a" width="10"> [OldScape-Cache](https://github.com/guthix/OldScape-Cache)
## License
RS-Cache is distributed under the terms of the MIT license.
See [LICENSE](LICENSE) for details.