modio provides a set of building blocks for interacting with the mod.io API.
The client uses asynchronous I/O, backed by the futures and tokio crates, and requires both to be used alongside.
mod.io is a drop-in modding solution from the founders of ModDB.com, that facilitates the upload, search, browsing, downloading and trading of mods in-game.
To use modio, add this to your Cargo.toml
toml
[dependencies]
modio = "0.6"
```rust use modio::{Credentials, Modio, Result};
async fn main() -> Result<()> { let modio = Modio::new( Credentials::new("user-or-game-apikey"), )?;
// create some tasks and execute them
// let result = task.await?;
Ok(())
} ```
```rust // Request a security code be sent to the email address. modio.auth().request_code("john@example.com").await?;
// Wait for the 5-digit security code let token = modio.auth().security_code("QWERT").await?;
// Create an endpoint with the new credentials let modio = modio.with_credentials(token); ``` See full example.
```rust use modio::filter::prelude::*;
// List games with filter name_id = "0ad"
let games = modio.games().search(NameId::eq("0ad")).collect().await?;
```
```rust // List all mods for 0 A.D. let mods = modio.game(5).mods().search(Default::default()).collect().await?;
// Get the details of the balancing-mod mod
let balancingmod = modio.mod(5, 110).get().await?;
```
```rust use futures::TryStreamExt;
let filter = Fulltext::eq("tftd").limit(10); let mut st = modio.game(51).mods().search(filter).paged().await?; let (pagecount, ) = st.sizehint();
// Stream of paged results Page<Mod> with page size = 10
while let Some(page) = st.trynext().await? {
println!("Page {}/{} - Items #{}", page.current(), page.pagecount(), page.len());
for item in page {
println!(" {}. {}", item.id, item.name);
}
}
let filter = Fulltext::eq("soldier"); let mut st = modio.game(51).mods().search(filter).iter().await?; let (total, _) = st.sizehint();
// Stream of Mod
while let Some(mod) = st.trynext().await? {
println!("{}. {}", mod.id, mod.name);
}
```
```rust use future_util::{future, TryStreamExt}; use modio::download::{ResolvePolicy, DownloadAction};
// Download the primary file of a mod. let action = DownloadAction::Primary { gameid: 5, modid: 19, }; modio.download(action).savetofile("mod.zip").await?;
// Download the specific file of a mod. let action = DownloadAction::File { gameid: 5, modid: 19, fileid: 101, }; modio.download(action).saveto_file("mod.zip").await?;
// Download the specific version of a mod.
// if multiple files are found then the latest file is downloaded.
// Set policy to ResolvePolicy::Fail to return with modio::download::Error::MultipleFilesFound
// as source error.
let action = DownloadAction::Version {
gameid: 5,
modid: 19,
version: "0.1".tostring(),
policy: ResolvePolicy::Latest,
};
modio.download(action)
.stream()
.tryfor_each(|bytes| {
println!("bytes: {:?}")
future::ok(())
})
.await?;
```
See examples directory for some getting started examples.
Licensed under either of
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.