modio 0.2.0

Rust interface for mod.io
Documentation

modio-rs

Crates.io License Released API docs Master API docs Travis Build Status

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

mod.io is a drop-in modding solution from the founders of ModDB.com, that facilitates the upload, upload, search, browsing, downloading and trading of mods in-game.

Usage

To use modio, add this to your Cargo.toml

[dependencies]
modio = "0.1"

Basic Setup

extern crate modio;
extern crate tokio;

use modio::{Credentials, Error, Modio};
use tokio::runtime::Runtime;

fn main() -> Result<(), Error> {
    let mut rt = Runtime::new()?;
    let modio = Modio::new(
        "user-agent-name/1.0",
        Credentials::ApiKey(String::from("user-or-game-apikey")),
    );

    // create some tasks and execute them
    // let result = rt.block_on(task)?;
    Ok(())
}

Authentication

// Request a security code be sent to the email address.
rt.block_on(modio.auth().request_code("john@example.com"))?;

// Wait for the 5-digit security code
let token = rt.block_on(modio.auth().security_code("QWERT"))?;

// Create an endpoint with the new credentials
let modio = modio.with_credentials(Credentials::Token(token));

See full example.

Games

use modio::filter::Operator;
use modio::games::GamesListOptions;

// List games with filter `name_id = "0ad"`
let task = modio.games().list(
    &GamesListOptions::new()
        .name_id(Operator::Equals, "0ad"),
);

let games = rt.block_on(task)?;

Mods

// List all mods for 0 A.D.
let mods = rt.block_on(modio.game(5).mods().list(&Default::default))?;

// Get the details of the `balancing-mod` mod
let balancing_mod = rt.block_on(modio.mod_(5, 110).get())?;

Examples

See examples directory for some getting started examples.

License

Licensed under either of

Contribution

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.