A Rust port of the C++ mob build automation tool for the ModOrganizer2 project.

If you want to contribute to a single plugin of MO2 or even write your own plugins, check the ModOrganizer2 Wiki.

• Quick start
  • Building from source
• Prerequisites
  • Qt installation
  • Visual Studio
  • Python
  • 7-Zip
  • Transifex CLI (optional)
• Changing options
  • TOML files
  • Environment variables
  • Command line
  • TOML format
• Options
  • [global]
  • [task]
  • [cmake]
  • [tools]
  • [transifex]
  • [versions]
  • [paths]
• Command line
  • Global options
  • build
  • list
  • options
  • release
  • git
  • pr
  • tx
  • cmake-config
  • inis

Download the latest release from GitHub Releases, extract mob.exe and mob.toml into the same directory, then:

mob -d C:\dev\modorganizer build

# install Rust 1.92.0+ (https://rustup.rs)
rustup install stable

# clone and build mob-rs
git clone https://github.com/romeoahmed/mob-rs
cd mob-rs
cargo build --release

# build MO2
./target/release/mob -d C:\dev\modorganizer build

Check mob.toml to find out which version of Qt you need.

aqt is a CLI installer for Qt. It makes installing Qt extremely quick and painless, and doesn't require a login. Check the documentation to install aqt itself.

When using aqt, you can choose which modules to install but we recommend installing all of them in case of changes.

# you can also use -m all to install all modules
aqt install-qt --outputdir "C:\Qt" windows desktop ${QT_VERSION} win64_msvc2022_64 `
  -m qtwebengine qtimageformats qtpositioning qtserialport qtwebchannel qtwebsockets

• Install Qt (Installer) and select these components:
  • MSVC 2022 64-bit
  • Additional Libraries:
    • Qt WebEngine (display nexus pages)
    • Qt Image Formats (display images in image tab and preview)
    • Qt Positioning (required by QtWebEngine)
    • Qt Serial Port (required by Qt Core)
    • Qt WebChannel (required by QtWebEngine)
    • Qt WebSockets (Nexus api/download)
  • Optional:
    • Qt Source Files
    • Qt Debug Files

• Install Visual Studio 2022 (Installer)

  • Desktop development with C++
  • Desktop .NET desktop development (needed by OMOD and FOMOD installers)
  • Individual Components:
    • .Net Framework 4.8 SDK
    • .Net Framework 4.7.2 targeting pack
    • Windows Universal C Runtime
    • C++ ATL for latest v143 build Tools (x86 & x64)
    • C++ /CLI support for v143 build Tools (Latest)
    • Windows 11 SDK (get latest)
    • C++ Build Tools core features
    • Git for Windows
    • CMake tools for Windows

• Install Python 3.12 (required by PyQt, sip, and other MO2 build dependencies)
  • Make sure to check Add python.exe to PATH during installation

• Install 7-Zip (used to extract and create archives)
  • Make sure 7z.exe is in your PATH, or set the path in mob.toml under [tools]

• Install the Transifex CLI (tx) if you need to pull translations
  • Make sure tx is in your PATH, or set the path in mob.toml under [tools]
  • Set the TX_TOKEN environment variable or configure transifex.key in mob.toml

mob has three ways of setting options: TOML files, environment variables, or the command line.

mob builds a list of available TOML files in order of priority. Higher numbers override lower numbers:

1. The master TOML mob.toml in the directory where mob.exe lives (required).
2. Any files set in MOBINI (separated by semicolons).
3. Another mob.toml in the current directory.
4. Files given with --ini.

Use mob inis to see the list of config files in order. If --no-default-inis is given, mob will skip 1) and 2). The first config file it finds after that is considered the master.

Environment variables prefixed with MOB_ are mapped to configuration keys using _ as separator:

$env:MOB_GLOBAL_DRY = "true"          # → global.dry = true
$env:MOB_PATHS_PREFIX = "C:\dev\mo2"  # → paths.prefix = "C:\dev\mo2"
$env:MOB_TASK_MO_ORG = "MyOrg"        # → task.mo_org = "MyOrg"

Environment variables override TOML files but are overridden by CLI options.

Any option can be overridden from the command line with -s task:section/key=value, where task: is optional. Some options have shortcuts, such as --dry for -s global/dry=true and -l5 for -s global/output_log_level=5. See mob options for the list of options.

mob uses TOML for configuration (the C++ version uses INI files). Inside the TOML file are [sections] and key = value pairs. The [task] section is special because it can be overridden for specific tasks using [tasks.<name>]. Any value under a [tasks.usvfs] table will only apply to the task named usvfs. Glob patterns like installer_* are also supported.

[task]
git_shallow = true

[tasks.usvfs]
git_shallow = false # override for usvfs only

The list of available tasks can be seen with mob list. See Task names.

Options for individual tasks. Can be overridden per-task via [tasks.<name>], where <name> is the name of a task (see mob list), super for all MO tasks, or a glob like installer_*.

Example per-task override:

[tasks.super]
no_pull = true
remote_org = "myuser"
remote_no_push_upstream = true
remote_push_default_origin = true

Paths to external tools. These are looked up in PATH if not absolute.

Stylesheet versions are flattened into this section:

[versions]
ss_paper_lad_6788 = "7.2"
ss_paper_automata_6788 = "3.2"
ss_dark_mode_1809_6788 = "3.0"

The only path that's required is prefix, which is where mob will put everything. Within this directory will be downloads/, build/, and install/. Everything else is derived from it.

Do mob --help for global options and the list of available commands. Do mob <command> --help for more help about a command.

Builds tasks. The order in which tasks have to be built is handled by mob, but dependencies will not be built automatically when specifying tasks manually. That is, mob build will build python before pyqt, but mob build pyqt will not build python. Many tasks will be able to run in parallel, but not all, either because they hog the CPU (such as usvfs) or because they have dependencies that have to be built first.

If any task fails to build, all the active tasks are aborted as quickly as possible.

Each task has a name, some have more. MO tasks for example have a full name that corresponds to their git repo (such as modorganizer-game_features) and a shorter name (such as game_features). Both can be used interchangeably. The task name can also be super, which refers to all repos hosted on the Mod Organizer GitHub account. Globs can be used, like installer_*. See mob list for a list of all available tasks.

Lists all the available task names. If a task has multiple names, they are all shown.

Lists all the options after parsing the config files and the command line.

Creates a release. Supports two modes: devbuild and official.

Creates a development build release. A release is made out of archives:

• Binaries from prefix/install/bin
• PDBs from prefix/install/pdb
• Sources from various directories in prefix/build

The archive filename is Mod.Organizer-version-suffix-what.7z, where:

• version is taken from ModOrganizer.exe, version.rc, or from --version
• suffix is the optional --suffix argument
• what is either nothing, src, or pdbs

Creates an official release from a specific branch.

Various commands to manage the git repos.

Renames origin to upstream and adds a new origin with the given info.

Adds a new remote to all the git repos.

Toggles the --assume-unchanged status of all .ts files.

mob git ignore-ts on   # mark .ts files as unchanged
mob git ignore-ts off  # unmark .ts files

Lists all git repos that are not on master.

Applies changes from GitHub pull requests.

mob pr find modorganizer/123                           # list affected repos
mob pr pull modorganizer/123 --github-token $TOKEN     # checkout PR branch
mob pr revert modorganizer/123                         # revert to master

Manages Transifex translations.

Initializes a Transifex project and pulls all translation files.

Compiles all .ts translation files into .qm files using lrelease.

Prints CMake configuration variables used by mob when building so that you can run your own cmake.

cmake --preset vs2022-windows `
  ("-DCMAKE_INSTALL_PREFIX=" + (mob cmake-config install-prefix)) `
  ("-DCMAKE_PREFIX_PATH=" + (mob cmake-config prefix-path))

Shows a list of all the config files that would be loaded, in order of priority. See TOML files.

GPL-3.0-or-later. See LICENSE for details.