Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
RS-Cache
A simple-to-use basic RuneScape cache utility. RS-Cache provides utilities to interact with the RuneScape cache.
Follow this Quick Start guide to begin using rs-cache.
Useful links:
Crates.io
Documentation
Examples
Currently supports both OSRS & RS3, although both are still limited.
Integration tests are running on Oldschool RuneScape revision 180, which you can run at any time because the cache is included in the ./data/osrs_cache directory. RS3 Integration tests are running on revision 904. The RS3 cache is too large to include on GitHub.
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. The public API of this crate is still evolving due to constant discoveries and overhauls to improve the overal usage. If you require a certain feature feel free to open an issue.
Usage
Add this to your Cargo.toml:
[]
= "0.4"
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
Matrix 876
License
RS-Cache is distributed under the terms of the MIT license.
See LICENSE for details.