Quick start

> git clone https://github.com/isanae/mob
> bootstrap
> mob -d prefix/path build

Slow start

• Install Qt 5.14.2 (Installer)

  • MSVC 2017 64-bit
  • Qt WebEngine

• Install Visual Studio 2019 (Installer)

  • Desktop development with C++
  • Git for Windows
  • .NET Framework 3.5 development tools
  • .NET Framework 4.6 targeting pack

• Start the x64 Native Tools Command Prompt for VS 2019

• Do:

  mkdir C:\dev
  cd C:\dev
  git clone https://github.com/isanae/mob
  cd mob
  bootstrap
  mob -d C:\dev\modorganizer build
  

• Once mob is finished, everything will be in C:\dev\modorganizer. Mod Organizer can be run from install\bin\ModOrganizer.exe. The Visual Studio solution for Mod Organizer itself is build\modorganizer_super\modorganizer\vsbuild\organizer.sln.

Changing options

mob has two ways of setting options: from INI files, the MOBINI environment variable, or from the command line.

INI files

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

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

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

Command line

Any option can be overriden from the command like 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.

INI format

Inside the INI file are [sections] and key = value pairs. The [options] section is special because it can be changed for specific tasks instead of globally. Any value under a [task:options] section will only apply to a task named task. The list of available tasks can be seen with mob list. The task super is a shortcut for any task that's from the ModOrganizer2 repository, except for libbsarch, NexusClientCli and usvfs.

Options

[global]

Option	Type	Description
dry	bool	Whether filesystem operations are simulated. Note that many operations will fail and that the build process will most probably not complete. This is mostly useful to get a dump of the options.
redownload	bool	For build, re-downloads archives even if they already exist.
reextract	bool	For build, re-extracts archives even if the target directory already exists, in which case it is deleted first.
reconfigure	bool	For build, tries to delete just enough so that configure tools (such as cmake) will run from scratch.
rebuild	bool	For build, tries to delete just enough so that build tools (such as msbuild) will run from scratch.
clean_task	bool	For build, whether tasks are cleaned.
fetch_task	bool	For build, whether tasks are fetched (download, git, etc.)
build_task	bool	For build, whether tasks are built (msbuild, jobm etc.)
output_log_level	[0-6]	The log level for stdout: 0=silent, 1=errors, 2=warnings, 3=info (default), 4=debug, 5=trace, 6=dump. Note that 6 will dump a lot of stuff, such as debug information from curl during downloads.
file_log_level	[0-6]	The log level for the log file.
log_file	path	The path to a log file.
ignore_uncommitted	bool	When --redownload or --reextract is given, directories controlled by git will be deleted even if they contain uncommitted changes.

[task]

Options for individual tasks. Can be [taskname:task], where taskname is the name of a task (see mob list) , super for all MO tasks or a glob like installer_*.

Option	Type	Description
enabled	bool	Whether this task is enabled. Disabled tasks are never built. When specifying task names with mob build task1 task2..., all tasks except those given are turned off.

Common git options

Unless otherwise stated, applies to any task that is a git repo.

Option	Type	Description
mo_org	string	The organization name when pulling from Github. Only applies to ModOrganizer projects, plus NCC and usvfs.
mo_branch	string	The branch name when pulling from Github. Only applies to ModOrganizer projects, plus NCC and usvfs.
no_pull	bool	If a repo is already cloned, a git pull will be done on it every time mob build is run. Set to false to never pull and build with whatever is in there.
ignore_ts	bool	Marks all the .ts files in a repo with --assume-unchanged. Note that mob git ignore-ts off can be used to revert it.
git_url_prefix	string	When cloning a repo, the URL will be $(git_url_prefix)mo_org/repo.git.
git_shallow	bool	When true, clones with --depth 1 to avoid having to fetch all the history. Defaults to true for third-parties.

Git credentials

These are used to set user.name and user.email. Applies to any task that is a git repo.

Option	Type	Description
git_username	string	Username
git_email	string	Email

Origin and upstream remotes

When git clones, it automatically creates a remote named origin for the URL that was cloned. When set_origin_remote is true, this will:

1. Rename origin to upstream, and
2. Create a new origin with the given parameters.

Option	Type	Description
set_origin_remote	bool	Enables the feature
remote_org	string	Organization on Github for the new remote. The URL will be git@github.com:org/git_file, where git_file is the repo.git file for the current task.
remote_key	string	A PuTTY key, saved in remote.origin.puttykeyfile. Optional.
remote_no_push_upstream	bool	Sets the push URL for upstream to nopushurl to avoid accidental pushes.
remote_push_default_origin	bool	Sets origin as the default push remote.

For example, this will create an origin remote for all ModOrganizer2 projects and mark all .ts files as --assume-unchanged.

[super:options]
ignore_ts                  = true
git_username               = isanae
git_email                  = isanae@users.noreply.github.com
set_origin_remote          = true
remote_org                 = isanae
remote_key                 = private.ppk
remote_no_push_upstream    = true
remote_push_default_origin = true

[tools]

The various tools in this section are used verbatim when creating processes and so will be looked in the PATH environment variable. vcvars is best left empty, it will be found using the vswhere.exe that's bundled as a third-party.

[prebuilt]

Some tasks can use prebuilt binaries instead of building from source.

[versions]

The versions for all the tasks.

[paths]

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

If mob is unable to find the Qt installation directory, it can be specified in qt_install. This directory should contain bin/, include/, etc. It's typically something like C:\Qt\5.14.2\msvc2017_64\. The other path qt_bin will be derived from it, it's just $qt_install/bin/.