Ferinth
Ferinth is a simple library for using the Modrinth API in Rust projects. It uses reqwest
as its HTTP(S) client and deserialises responses to typed structs using serde
.
As of now, the following features have been implemented
- All structure definitions based on https://github.com/modrinth/labrinth/wiki/API-Documentation#structure-definitions
- The following calls:
- Get mod by mod ID
- List mod categories
- List mod loaders
- List game versions
- Get user by user ID
- List team members by team ID
- List versions by mod ID
- Get version by version ID
- Download version file
This means that the following features have not yet been implemented
- Search mods
- User authentication
- Get current user (constrained by lack of user authentication)
Unfortunately, I am not planning to implement any of these features in version 1 due to poor documentation. I will add these features in version 2.
Use
The major version of this crate's version directly corresponds to the API version it uses. So if you want to use the Modrinth API version 1, then specify this crate version as "1"
, and so on.
After you have decided the API version to use, you can add this crate to your Cargo.toml
like so
[dependencies]
ferinth = "1"