Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

mod.io

modiom

CI

modiom is a command line tool for mod.io to search, download and update mods for games without builtin support.

  1. Building
  2. Installation
  3. Usage
    1. modiom login
    2. modiom search
    3. modiom info
    4. modiom subs
      1. modiom subs list
      2. modiom subs add
      3. modiom subs rm
    5. modiom download
    6. modiom upload
  4. Manifest format

Building

modiom is written in Rust, so you'll need to grab a Rust installation in order to compile it. Building is easy:

$ git clone https://github.com/nickelc/modiom.git
$ cd modiom
$ cargo build --release
$ ./target/release/modiom --version
modiom 0.3.0

Installation

Cargo

$ git clone https://github.com/nickelc/modiom.git
$ cargo install --path modiom

Usage

modiom login

$ modiom login --help
modiom-login

USAGE:
    modiom login [OPTIONS] [api-key] [token]

OPTIONS:
        --test-env    use the test environment
    -h, --help        Prints help information

ARGS:
    <api-key>
    <token>

modiom search

$ modiom search --help
modiom-search

USAGE:
    modiom search [OPTIONS] [--] [FULLTEXT]

OPTIONS:
        --game-id <ID>
        --id <ID>...
        --name <VALUE>
        --name-id <VALUE>
        --expr <EXPR>...
        --test-env           use the test environment
    -h, --help               Prints help information

ARGS:
    <FULLTEXT>

modiom info

$ modiom info --help
modiom-info
Show information of mods

USAGE:
    modiom info [OPTIONS] <GAME> <MOD>

OPTIONS:
        --files       List all files.
        --stats       Show the statistics.
        --test-env    Use the mod.io test environment
    -h, --help        Prints help information

ARGS:
    <GAME>    Unique id of a game.
    <MOD>     Unique id of a mod.

modiom subscriptions

$ modiom subs --help
modiom-subscriptions
Show information of subscriptions

USAGE:
    modiom subscriptions [OPTIONS] <SUBCOMMAND>

OPTIONS:
        --test-env    Use the mod.io test environment
    -h, --help        Prints help information

SUBCOMMANDS:
    list
    add
    remove

modiom subscriptions list

$ modiom subs list --help
modiom-subscriptions-list

USAGE:
    modiom subscriptions list [OPTIONS]

OPTIONS:
        --game-id <ID>    Unique id of a game.
        --test-env        Use the mod.io test environment
    -h, --help            Prints help information

modiom subscriptions add

$ modiom subs add --help
modiom-subscriptions-add

USAGE:
    modiom subscriptions add [OPTIONS] <GAME> <MOD>

OPTIONS:
        --test-env    Use the mod.io test environment
    -h, --help        Prints help information

ARGS:
    <GAME>    Unique id of a game.
    <MOD>     Unique id of a mod.

modiom subscriptions remove

$ modiom subs rm --help
modiom-subscriptions-remove

USAGE:
    modiom subscriptions remove [OPTIONS] <GAME> <MOD>

OPTIONS:
        --test-env    Use the mod.io test environment
    -h, --help        Prints help information

ARGS:
    <GAME>    Unique id of a game.
    <MOD>     Unique id of a mod.

modiom download

$ modiom download --help
modiom-download

USAGE:
    modiom download [OPTIONS] --game-id <ID> --mod-id <ID>... [--] [DEST]

OPTIONS:
        --game-id <ID>
        --mod-id <ID>...
        --with-dependencies
        --test-env             use the test environment
    -h, --help                 Prints help information

ARGS:
    <DEST>

modiom upload

$ modiom upload --help
modiom-upload
Upload new files

USAGE:
    modiom upload [OPTIONS] <GAME> <MOD> <FILE>

OPTIONS:
        --filename <NAME>          Overwrite the filename.
        --version <VERSION>        Version of this file release.
        --changelog <CHANGELOG>    Changelog of this release.
        --not-active               When this flag is enabled, the upload will not be labeled as current release.
        --metadata-blob <BLOB>
        --checksum                 Calculate the checksum before uploading.
        --test-env                 Use the mod.io test environment
    -h, --help                     Prints help information

ARGS:
    <GAME>    Unique id of the game.
    <MOD>     Unique id of the mod.
    <FILE>    Zip file to upload.

The Modio Manifest Format

The Modio.toml file

The [game] section

[game]
# id = (int|string)
id = "gametwo" # the name_id of the game or alternative its id

The with-dependencies field (optional)

This field specifies globally whether dependencies of mods are downloaded. If you don't specify the field, it will default to false.

[game]
# ...
with-dependencies = true

Specifying mods

[mods]
mod1 = 1
mod2 = "mod-two"
mod3 = { id = "mod-three" }

[mods.mod4]
id = 4
with-dependencies = true

The with-dependencies field (optional)

This field specifies whether dependencies of the mod are downloaded and overrides the global setting. If you don't specify the field, it will default to false.

The file field (optional)

This field specifies the downloaded file id.

[mods.mod1]
id = "mod-one"
file = 34

The version field (optional)

This field specifies the downloaded version.

[mods.mod1]
id = "mod-one"
version = "1.2"

About

Command-line tool for https://mod.io to search, upload, download and update mods for games without builtin support.

Topics

Resources

License

Stars

Watchers

Forks

Languages