Directory structure

Root directory

The root directory is the primary directory that contains a game server installation. All game files, and uMod itself, will be installed in a sub-directory under the root directory.

uMod directory

The umod directory is a sub-directory in the game's root directory. The umod directory will contain uMod configuration files and lock files.

umod
  └───apps
      └───compiler
      └───webclient
      └───database
  └───config
  └───data
  └───lang
  └───plugins
  └───tests

apps directory

The apps directory contains the standalone applications used by uMod including the compiler, webclient, and database.

config directory

The config directory contains TOML and JSON plugin configuration files.

data directory

The data directory contains arbitrary data files used by plugins usually in JSON or binary format.

lang directory

The lang directory contains localization files used by plugins.

plugins directory

The plugins directory contains plugins in the C# (.cs) format.

tests directory

The tests directory is primarily a place for developers to place unit tests or test related code for plugins.

Lock files

A lock file is used by the uMod Agent to track and assist with the deployment of plugins, core libraries, and game servers.

Sandbox

Files may not be read, modified, or created using the uMod Filesystem API in any directory above the umod directory.