Jopejoe1: Add section about using impure env vars

2026-02-27T15:44:46Z

Add section about using impure env vars

@@ Line 14: / Line 14: @@
 or use the {{nixos:package|celestegame}} package.
-For using the <code>celestegame</code> package,
+For using the <code>celestegame</code> package follow one of the 3 methodes:
-first download the Linux version of Celeste on [https://maddymakesgamesinc.itch.io/celeste itch.io],
 and then add it to Nix store by running this command:
@@ Line 23: / Line 26: @@
 You can then install Celeste by the <code>celestegame</code> package on Nixpkgs.
 You can override the source to use something other than the itch.io version,

Klinger: Category:Gaming Category:Applications added

2025-12-29T10:29:20Z

Category:Gaming Category:Applications added

← Older revision		Revision as of 10:29, 29 December 2025
Line 162:		Line 162:
	It can be installed using the {{nixos:package\|everest-mons}} package.		It can be installed using the {{nixos:package\|everest-mons}} package.
	However, it is not advised to use Mons because it is now outdated and does not work with the current modding ecosystem anymore.		However, it is not advised to use Mons because it is now outdated and does not work with the current modding ecosystem anymore.


			[[Category:Gaming]]
			[[Category:Applications]]

UlyssesZhan: Created page with "{{unfree}} {{note|Only x86_64-linux system is supported.}} [https://www.celestegame.com Celeste] is a precision platformer game about climbing a mountain. This page explains how to play the game, possibly with mods, on NixOS. You may seek further support about Celeste on NixOS in a [https://discord.com/channels/403698615446536203/1236055875282800741 thread] in the Discord server for Celeste. == Base game installation == Celeste is not free (as in free beer) for downl..."

2025-10-29T20:28:45Z

Created page with "{{unfree}} {{note|Only x86_64-linux system is supported.}} [https://www.celestegame.com Celeste] is a precision platformer game about climbing a mountain. This page explains how to play the game, possibly with mods, on NixOS. You may seek further support about Celeste on NixOS in a [https://discord.com/channels/403698615446536203/1236055875282800741 thread] in the Discord server for Celeste. == Base game installation == Celeste is not free (as in free beer) for downl..."

New page

{{unfree}}

{{note|Only x86_64-linux system is supported.}}

[https://www.celestegame.com Celeste] is a precision platformer game about climbing a mountain.
This page explains how to play the game, possibly with mods, on NixOS.
You may seek further support about Celeste on NixOS in a [https://discord.com/channels/403698615446536203/1236055875282800741 thread] in the Discord server for Celeste.

== Base game installation ==

Celeste is not free (as in free beer) for downloading.
If you own a copy only on Steam, install [[Steam]], and then install and launch Celeste in Steam.
If you own a copy on itch.io, you can either extract it and run it using {{nixos:package|steam-run}},
or use the {{nixos:package|celestegame}} package.

For using the <code>celestegame</code> package,
first download the Linux version of Celeste on [https://maddymakesgamesinc.itch.io/celeste itch.io],
and then add it to Nix store by running this command:

<syntaxhighlight lang="bash">
nix-store --add-fixed sha256 celeste-linux.zip
</syntaxhighlight>

You can then install Celeste by the <code>celestegame</code> package on Nixpkgs.

You can override the source to use something other than the itch.io version,
as long as it is a Zip file containing the DRM-free game files of Celeste.
The Zip file must not contain only a single top-level directory,
but should contain the files such as the <code>Celeste</code> binary file directly at top-level.
To override the source, write, for example:

<syntaxhighlight lang="nix">
celestegame.override {
overrideSrc = requireFile {
name = "celeste-linux.zip";
hash = "sha256-phNDBBHb7zwMRaBHT5D0hFEilkx9F31p6IllvLhHQb8=";
url = "https://example.com";
};
}
</syntaxhighlight>

== Installing Olympus ==

Olympus is a GUI tool that can be used to manage multiple Celeste installations and their mods.
You can install Olympus by the {{nixos:package|olympus}} package.

* If you want to manage the game from Steam, the game directly extracted from itch.io, or the game installed from the package <code>celestegame.passthru.celeste-unwrapped</code>, install <code>olympus.override { celesteWrapper = "steam-run"; }</code>. Setting <code>celesteWrapper</code> is essential if you want to launch Celeste from Olympus, but other functionalities of Olympus work without this.
* If you want to manage the game installed from the package <code>celestegame</code>, just install <code>olympus</code>.

If you want to manage the game installed by the <code>celestegame</code> package using Olympus, it may not be convenient because Olympus cannot automatically discover it by default,
and if you manually add the Nix store path as a Celeste installation in Olympus,
the path will probably become invalid or outdated after you update Nixpkgs.
To fix this, you can specify an absolute path where a symbolic link to the Celeste installation will be created,
and instruct Olympus to discover a Celeste installation in that path.
For example, in a NixOS configuration, you can write:

<syntaxhighlight lang="nix">
environment.systemPackages = with pkgs; [
(celestegame.override { gameDir = "/home/madeline/Games/Celeste/game"; })
(olympus.override { finderHints = "/home/madeline/Games/Celeste/game"; })
];
</syntaxhighlight>

After switching to this NixOS configuration, you need to launch Celeste once before launch Olympus because
the path specified by <code>gameDir</code> is created the first time you launch Celeste.
You can also specify multiple directories by setting <code>gameDir</code> and <code>finderHints</code> to arrays of strings.

=== Managing mods with Olympus ===

If your game is from Steam or directly extracted from itch.io downloads, then you can install Everest and manage mods in Olympus rightaway.

If you use the <code>celestegame</code> package, you cannot install Everest using Olympus.
Read [[#Installing Everest]] for more information.
A working snippet of NixOS configuration may look like this:

<syntaxhighlight lang="nix">
environment.systemPackages = with pkgs; [
(celestegame.override {
withEverest = true;
writableDir = "/home/madeline/Games/Celeste/writable";
gameDir = "/home/madeline/Games/Celeste/game";
})
(olympus.override { finderHints = "/home/madeline/Games/Celeste/game"; })
];
</syntaxhighlight>

=== Managing multiple installations ===

You can manage different installations, giving benefits of possibly having different sets of mods for each installation.
To do this, you can write something like this in your NixOS configuration:

<syntaxhighlight lang="nix">
environment.systemPackages = with pkgs; [
(celestegame.override {
withEverest = true;
writableDir = "/home/madeline/Games/Celeste/writable1";
gameDir = "/home/madeline/Games/Celeste/game1";
})
(celestegame.override {
withEverest = true;
writableDir = "/home/madeline/Games/Celeste/writable2";
gameDir = "/home/madeline/Games/Celeste/game2";
})
(olympus.override { finderHints = [
"/home/madeline/Games/Celeste/game1"
"/home/madeline/Games/Celeste/game2"
]; })
];
</syntaxhighlight>

However, this may be a little inconvenient because the <code>gameDir</code> is only populated when you launch Celeste for the first time.
Having an activation script for this may be desired. TODO: write instructions about the activation scripts here.

You may also manage both the game from the <code>celestegame</code> package and the game from Steam or itch.io in Olympus.
Because of the limitation of the implementation of Celeste launch wrappers in Olympus,
the same <code>celesteWrapper</code> is used for all of the installtions that you launch through Olympus.
If you set it to <code>"steam-run"</code> for launching the game from Steam, you may have trouble launching the game from the package.
This may be fixed by overriding <code>everest</code> to <code>everest-bin</code>:

<syntaxhighlight lang="nix">
celestegame.override {
withEverest = true;
everest = everest-bin;
writableDir = "/home/madeline/Games/Celeste/writable";
gameDir = "/home/madeline/Games/Celeste/game";
}
</syntaxhighlight>

If it still does not work, you can also try replacing <code>celestegame</code> with <code>celestegame.passthru.celeste-unwrapped</code>,
but this package does not support <code>gameDir</code>.

== Installing Everest ==

[https://everestapi.github.io Everest] is a mod loader for Celeste.

Installing and using Everest for the game from Steam or the game directly extracted from itch.io downloads
is not very different from the upstream documentation
(other than the quirk that you may need [[nix-ld]] or an FHS wrapper like <code>steam-run</code> to run MiniInstaller).
However, different steps are needed if you use the <code>celestegame</code> package.
Because the Nix store is read-only, some further steps are needed to install mods.
You need to override the <code>writableDir</code> argument to make file writing happen there instead of in the Nix store path.
Therefore, to install Celeste with Everest using the <code>celestegame</code> package, you can write:

<syntaxhighlight lang="nix">
celestegame.override {
withEverest = true;
writableDir = "/home/madeline/Games/Celeste/writable";
}
</syntaxhighlight>

After that, all the file writing operations should be only done in the writable directory you set.
For this specific example, you should expect the Everest logs to be at <code>/home/madeline/Games/Celeste/writable/everest-log.txt</code>,
and you should install mods by putting them in <code>/home/madeline/Games/Celeste/writable/Mods</code>.

Notice that, while you can specify multiple paths for <code>gameDir</code>, you can only specify one path for <code>writableDir</code>.
Therefore, if you want this Celeste installation to be playable by multiple users on this machine,
setting <code>writableDir</code> to a path that is writable by all of them is advised.

== Installing Mons ==

[https://mons.coloursofnoise.ca Mons] is a CLI mod manager for Celeste.
It can be installed using the {{nixos:package|everest-mons}} package.
However, it is not advised to use Mons because it is now outdated and does not work with the current modding ecosystem anymore.

Celeste - Revision history

Jopejoe1: Add section about using impure env vars

Klinger: Category:Gaming Category:Applications added