Git Product home page Git Product logo

rman-rs's Introduction

Riot Manifest (rman)

github crates.io docs.rs Discord

crates.io crates.io docs.rs GitHub Workflow Status

This is an unofficial rust implementation for parsing the .manifest file format, and downloading containing files.

About

The format was made by RiotGames and is used by RiotClient for downloading game updates.

Layout of the .manifest file is as follows:

Decompressed zstd data is a binary flatbuffer format. This crate uses generated code from a mostly complete schema over at this repository.

rman-schema repository is only added as a submodule as a way to track which schema version is used.

Status

This crate is ready for use as-is and should be able to parse all current and future .manifest files, barring any changes to the format itself. If the library is unable to parse any specific file, or if it breaks in the future, feel free to contribute.

The semver-major version of the crate will stay at 0, until functionality and purpose of all of the fields in the flatbuffer schema is known. Besides that, the crate follows cargo's versioning guidelines.

Installation

Add the following to your Cargo.toml file:

[dependencies]
rman = "0.3"

Usage

See the documentation for examples and information about all of the exposed API's.

Contributing

See CONTRIBUTING.md.

Seeking help

If you need any help with using the library, or have any questions, feel free to open an issue, or ask for assistance on discord.

Documentation

You can find latest release documentation on docs.rs. Versions from 0.3.0 onwards are also published to GitHub pages (e.g. https://ev3nvy.github.io/rman-rs/v0.3.0). You can also find documentation for the latest unpublished version on GitHub pages.

Acknowledgements

Legal

Riot Games, VALORANT, and any associated logos are trademarks, service marks, and/or registered trademarks of Riot Games, Inc.

This project is in no way affiliated with, authorized, maintained, sponsored or endorsed by Riot Games, Inc or any of its affiliates or subsidiaries.

I, the project owner and creator, am not responsible for any legalities that may arise in the use of this project. Use at your own risk.

rman-rs's People

Contributors

ev3nvy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

rman-rs's Issues

Add tests

The following tests should be added:

  • unit tests, (#14)
  • integration tests, (#19) (80170f3)
  • documentation tests. (#21)

Miscellaneous things to do before release

Miscellaneous things that need to be done before 0.1.0 release, and are not applicable to other issues linked in the v0.1.0 milestone:

  • various documentation/info files:
    • README.md file,
    • LICENSE-MIT file,
    • LICENSE-APACHE file,
    • CONTRIBUTING.md file,
    • CHANGELOG.md file (changelog will be kept through GitHub releases),
  • various workflow related files:
    • add .editorconfig
    • add .gitattributes
    • add clippy.toml (doesn't work the way I expected it, so not required)
    • add rustfmt.toml (default rustfmt values seem sane to me, so this is not required)
    • add .vscode/extensions.json
    • edit Cargo.toml
    • edit .gitignore
  • .github specific files:
    • PULL_REQUEST_TEMPLATE.md
    • issue templates

Integrate GitHub actions

Add various GitHub actions.

GitHub actions I'd like to test out (the following list will be updated as I think of other things):

  • generate changelogs (338d83a)
  • generate release - done through GitHub
  • run clippy and rustfmt after making pr (#11)
  • publish to crates.io (23855d4)
  • run tests (d618ea9)

Enforce stricter clippy rules

Default clippy rules are ok, but I'd like to experiment with some of the other rules. Goal is to enable as many as possible, but if something just looks wrong or unfeasible to implement, I just won't implement it. Whichever rules I end up implementing, they will be incorporated into CI, so this issue will also depend on PR for implementing CI (related issue is #3).

Add exports

Add proper exports to lib.rs, and remove main.rs.

Huge crate size on crates.io

Please complete the following tasks

What happened?

Crate size is over 5MB on crates.io which is enormous.

What did you expect to see?

Crate being ~25KB in size.

Operating system

Other (specify which below)

Other OS info

Not OS specific

Rust version

1.67.1

rman version

0.1.1

Logs

No response

Other information

This is because flatc binaries are bundled with the crate when published. Best solution would be that the schema will be compiled within rman-schema, however I'm still not sure which approach I should take.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.