MONS(5)

🎀 MONS(5) — the mons config file, explained by your favorite unix bestie 🎀

okay so this is the manual page for mons, section 5 of the manual (that's the file-formats girlies 💅), and honestly? it's a config file glow-up. let's get into it.

---

✨ NAME ✨

mons — the configuration file, bestie. that's it, that's the whole name section. iconic minimalism.

---

🌸 SYNOPSIS 🌸

$XDG_CONFIG_HOME/mons/config.yaml

that's the path. that's where she lives. $XDG_CONFIG_HOME/mons/config.yaml — write it down, tape it to your monitor, get it tattooed, idc. 🫶

---

💖 DESCRIPTION 💖

the mons configuration file uses the YAML format. yes, YAML. mind your indentation, queen, because YAML will absolutely humble you if you get sloppy with the spaces. 😭

---

✨ OPTIONS ✨

okay here's the whole menu, no skips, no skimming, we're reading the entire thing together like the devoted besties we are. 🍓

• source_directory: str | None — the default path to use when building Everest from source. once you've set it, you can still override it by handing over a path from the commandline. so it's a default, not a prison. 💅
• build_args: List[str] — build options that get passed to dotnet build or msbuild. and listen: if the dotnet cli is not reliably available, both of those tools can accept msbuild options — so you're covered either way. 👑 see msbuild(1) for the available options, iykyk.
• launch_args: List[str] — the default command-line arguments used when launching Celeste. heads up though: Everest will also read arguments from the everest-launch.txt file, so check the Everest documentation for the deets. 🦋
• downloading — the whole section for options related to downloading files. she's a container, she has children:
  • 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. go fast, but like, responsibly. 🔥
• overlayfs — options pertaining to installs using an Overlay Filesystem, and yes it's Linux only, sorry to the mac girlies. 💀 see mons-overlayfs(7) for the full lore on overlayfs installs.
  • data_directory: str | None — used for the upperdir overlay mount option. each install gets its own subdirectory within this folder, and that subdirectory will contain all the files added or modified by that install. ⭐ this directory should be writable.
  • work_directory: str | None — used for the workdir overlay mount option. each install gets its own subdirectory within this folder, and that one gets wiped before each use (not me gasping 🙈). this directory should be writable and on the same filesystem as data_directory.

real talk for a sec: those two directory requirements aren't suggestions, bestie. data_directory needs to be writable, and work_directory needs to be writable and living on the same filesystem as data_directory. also remember work_directory's per-install subdirs get wiped before every use — that's by design, that's the whole bit. 🫶

---

💜 COPYRIGHT 💜

2022-2023, coloursofnoise

---

and that's the page!! mwah 💋 this was mons, manual section 5, dated Aug 23, 2023, brought to you by coloursofnoise — go config responsibly, and remember: YAML indentation is a love language. 🎀✨🦋