Configuration

$XDG_CONFIG_HOME/mons/config.yaml

The mons configuration file uses the YAML format.

source_directory: str | None

The default path to use when building Everest from source.

Once set, this can still be overridden by providing a path from the commandline.

build_args: List[str]

Build options that are passed to dotnet build or msbuild.

If the dotnet cli is not reliably available, both tools can accept msbuild options.

See msbuild(1) for available options.

launch_args: List[str]

The default command-line arguments used when launching Celeste.

Everest will also read arguments from the everest-launch.txt file. See Everest documentation for details.

downloading

Options related to downloading files.

everest_builds: str | None

The URL used to fetch the list of Everest builds.

By default, the URL is read from the contents of https://everestapi.github.io/everestupdater.txt.

mod_db: str | None

The URL used to fetch the database of Everest-compatible mods.

By default, the URL is read from the contents of https://everestapi.github.io/modupdater.txt.

thread_count: int

The maximum number of parallel downloads to use.

overlayfs

Options pertaining to installs using an Overlay Filesystem (Linux only).

See mons-overlayfs(7) for information on overlayfs installs.

data_directory: str | None

Used for the upperdir overlay mount option.

Each install will have its own subdirectory within this folder, which will contain all files added or modified by this install. This directory should be writable.

work_directory: str | None

Used for the workdir overlay mount option.

Each install will have its own subdirectory within this folder, which will be wiped before each use. This directory should be writable, on the same filesystem as data_directory.