Server

Install

Install a game

A list of games and instructions to install them can be found on the download page.

Installing a game server with no filter will install a server with the latest game files, patched assemblies, and other uMod dependencies.

umod install <gameName>

Install specific components

• Game Server

  umod install <gameName> --filter=server
  

• uMod Core & Applications

  umod install <gameName> --filter=umod
  

• uMod Core

  umod install <gameName> --filter=core
  

• uMod Applications

  umod install <gameName> --filter=apps
  

Install a specific branch

Choose a specific game branch with the branch option. The branch needs to be specified only once and all subsequent updates will default to that branch.

umod install <gameName> --branch=<branchName>

• Using a password protected branch:

  umod install <gameName> --branch=<branchName> --branch-password=<password>
  

Install a private depot

umod install <gameName> --username=<username> --password=<password>

Install to a specified directory

Installations occur in the current directory unless otherwise specified by the dir option, or if multiple game installations are found in immediate sub-directories (then the target installation is prompted).

umod install <gameName> --dir="/path/to/dir"

Install using pre-release versions

Pre-release versions of uMod components are often unstable, but may be installed by developers and server owners who want to help test upcoming releases.

umod install <gameName> --prerelease

Update

Update a game

Updating a game server with no filter will update a server installation with the latest game files, patched assemblies, and other uMod dependencies.

umod update [gameName]

Update specific components

• Game Server

  umod update [gameName] --filter=server
  

• uMod Core & Applications

  umod update [gameName] --filter=umod
  

• uMod Core

  umod update [gameName] --filter=core
  

• uMod Applications

  umod update [gameName] --filter=apps
  

Update a specific branch

Choose a specific game branch with the branch option. If updating to a different branch, the branch needs to be specified only once and all subsequent updates will default to that branch.

umod update [gameName] --branch=<branchName>

• Using a password protected branch:

  umod update [gameName] --branch=<branchName> --branch-password=<password>
  

Update a private depot

umod update [gameName] --username=<username> --password=<password>

Update to a specified directory

Updates are applied to the current directory unless otherwise specified by the dir option, or if multiple game installations are found in immediate sub-directories (then the target installation is prompted).

umod update [gameName] --dir="/path/to/dir"

Update using pre-release versions

Pre-release versions of uMod are often unstable, but may be installed by developers and server owners who want to help test upcoming releases.

umod update [gameName] --prerelease

Uninstall

Uninstall standalone applications

umod uninstall --apps

Uninstall specific standalone applications

umod uninstall -app=<compiler|database|webclient>

New

The new command provides pre-made files to quickly bootstrap server and development operations.

Launcher

Creates a batch (.bat) or shell (.sh) script in the root directory depending on the current operating system (Windows or Linux).

umod new launcher

New launchers will contain default parameters specific to each game.

Optionally additional launch parameters can be specified..

umod new launcher -logfile output.log

Launch

Run a launcher created with the umod new launcher command.

umod launch