Expand description
An async rust wrapper for the public Modrinth API (v2).
Does not provide any functionality for endpoints requiring Authorization.
§Features
rate-limited: (default) Enables per-client rate limiting.
Note: uses Tokio to rate limit requests. If you cannot or don’t want to use Tokio, you can disable this feature and implement a custom rate limiter. See the Modrinth API Docs for more information.tokio-io: (default) Enables async functions for downloading version files.
If you cannot or don’t want to use Tokio, you can disable this feature and implement a custom downloader usingModrinthClient.download_file_from_hash_response.parse-dates: (default) Enables parsing ISO-8601 date fields intochrono::DateTime.not-found-error: (default) Enables treating HTTP 404 responses as a dedicatedModrinthError::NotFoundvariantloader-enums: Enables theLoaderenum, which will be used to deserialize/serialize loader fields instead of raw strings.donation-platform-enums: Enables theDonationPlatformenum, which will be used to deserialize donation platform fields instead of raw strings.
§Installation
Add the following to your Cargo.toml file:
[dependencies]
modrinth-wrapped = "0.1"
tokio = { version = "1.53.1", features = ["full"] } # at minimum you will need "macros" and "rt-multi-thread"§Examples
These examples use Tokio, but you can theoretically use any async runtime you’d like.
§Fetch a single project by its ID or slug:
use modrinth_wrapped::{ModrinthClient, ModrinthError};
#[tokio::main]
async fn main() -> Result<(), ModrinthError> {
let client = ModrinthClient::new()?;
let project = client.get_project("fabric-api").await?;
println!("project: {:#?}", project.title);
Ok(())
}§Search for projects:
use modrinth_wrapped::{ModrinthClient, SearchQuery, ModrinthError};
#[tokio::main]
async fn main() -> Result<(), ModrinthError> {
let client = ModrinthClient::new()?;
let query = SearchQuery::new()
.with_query("fabric")
.with_limit(5); // default limit is 10, max is 100
let results = client.search(&query).await?;
for hit in results.hits {
println!("hit: {}", hit.title);
}
Ok(())
}§Download a version file:
For this example, the latest 1.20.1 version for fabric-api is being downloaded.
For displaying progress as it is downloaded, see download_file_hash_to_async_writer_with_progress.
ⓘ
use modrinth_wrapped::{ModrinthClient, ModrinthError, VersionHashAlgorithm, VersionQuery};
#[tokio::main]
async fn main() -> Result<(), ModrinthError> {
let client = ModrinthClient::new()?;
let query = VersionQuery::new().with_game_versions(vec!["1.20.1"]);
let versions = client.list_versions_for("fabric-api", Some(&query)).await?;
let latest_file = versions
.first()
.and_then(|version| version.files.first())
.unwrap();
let mut file = tokio::fs::File::create(&latest_file.filename)
.await
.map_err(ModrinthError::IoError)?;
let bytes_written = client
.download_file_from_hash_to_async_writer(
&latest_file.hashes.sha1,
VersionHashAlgorithm::Sha1,
None,
&mut file,
)
.await?;
println!("downloaded {bytes_written} bytes");
Ok(())
}Re-exports§
pub use client::ModrinthClient;pub use error::ModrinthError;pub use models::environment::Environment;pub use models::project::Project;pub use models::search_result::SearchResult;pub use models::version::Dependency;pub use models::version::DependencyType;pub use models::version::Version;pub use models::version::VersionStatus;pub use models::version::VersionType;pub use models::version_file::VersionFile;pub use models::version_file::VersionHashAlgorithm;pub use types::download_progress::DownloadProgress;pub use types::forge_updates_type::ForgeUpdatesQueryType;pub use types::search_query::Facet;pub use types::search_query::FacetField;pub use types::search_query::FacetOperation;pub use types::search_query::SearchQuery;pub use types::search_query::Sort;pub use types::version_hash_query::VersionHashQuery;pub use types::version_query::VersionQuery;