QuickStart

mons is a commandline Everest installer and mod manager for Celeste.

It was originally built for productivity when working on Everest, but can be used by players and developers alike.

This program requires basic competency using the commandline for your operating system. For a graphical installer, please use Olympus instead.

Install:

Arch Linux:

Install from the AUR: everest-mons

Using pip:

$ python3 -m pip install --user mons

Usage:

At any time, add the --help flag to print usage information for the current command.

A copy of this documentation is hosted online at mons.coloursofnoise.ca.

$ mons --help
$ mons install --help

Setup

The first step is to add a reference for your Celeste install. For the purposes of this documentation, it will be assumed that the install is named main.

$ mons add main path/to/Celeste/install

Every command that operates on a Celeste install (pretty much everything except list and config) will require the install name as the first argument.

Everest

Installing Everest can be done with a variety of options, including branch name (stable/beta/dev), build number (3366), or zip artifact (--zip /path/to/zip/archive).

Using the --latest flag will always install the most recent build available.

$ mons install main stable
$ mons install main --latest

Everest in an overlay filesystem (Linux only)

On Linux, an Overlay Filesystem can be used to isolate any modifications made by an Everest. This allows multiple Everest installs to use the same base Celeste files, and also makes uninstalling Everest much more reliable.

Use the --overlay option when adding an Everest install to assign it to an overlay filesystem:

$ mons add main path/to/Everest/install --overlay path/to/Celeste/install

Since mounting a filesystem requires elevated privileges, it is recommended to add it to /etc/fstab or use User Namespaces to avoid the need to enter the root password every time.

Everest from source

mons was created with Everest development in mind, and tries to make the process as streamlined as possible. Passing the --src option with the path to a copy of the Everest repo to mons install will, by default:

  1. Run dotnet build or msbuild in the project folder.

  2. Copy updated build artifacts from the build output into the Celeste install folder.

  3. Run miniinstaller.exe to install Everest from the build artifacts.

On GNU/Linux and macOS, mons will use the MonoKickstart executable bundled with Celeste to run miniinstaller, so a system install of mono is not required.

$ mons install main --src /path/to/Everest/repo --launch

Mods

mons supports Celeste mods that have been posted on GameBanana, but can also attempt to install from local or remote zip files, including Google Drive share links.

Dependencies will be automatically resolved where possible, and missing dependencies can be resolved at any point using mons mods resolve.

The --search option when adding mods uses the GameBanana Search API to provide a list of possible matches to install.

$ mons mods add main SpringCollab2022
$ mons mods add main https://gamebanana.com/mods/53697 # Communal Helper
$ mons mods add main --search Helper
$ mons mods update main
$ mons mods remove --recurse SpringCollab2022

Table of Contents

Usage

Reference