Skip to content

Building From Source

Before we do anything, open a terminal and set its cd to the Cascade source repo. You can download a release from the official cascade repository.

Tip

You can use git clone "https://github.com/cascadeui/Cascade.git" if you have git installed

Installing aftman & dependencies

Aftman is a package manager, it will help you automatically install all the required dependencies that are needed to build cascade.

  1. First, you must install aftman if you don't already have it.

    Ensure it's in your environment variables, this lets us access aftman from a terminal.

  2. Run aftman install in the cascade directory to install all required dependencies

Building a release

Cascade uses ProCMP for build composition.

  • To build a release with ProCMP, use pcmp pipeline/.pcmp.json, this will run the compositor program using our PCMP config. After this, you can select from a build configuration, such as debug.
  • Artifacts will appear in generated/.

Common mistakes

How do I get the cascade source downloaded?

Either download the zip from the cascade repository releases page, or if you have git just run:

git clone "https://github.com/cascadeui/Cascade.git"
aftman isn't being recognized in my terminal

It's probably not in your environment variables. Add aftman to your PATH and restart your terminal, it won't pick up the change otherwise.

aftman install isn't doing anything / errors out

Make sure your terminal is cd'd into the Cascade directory, not just somewhere on your system. aftman looks for aftman.toml in the current folder.

pcmp isn't recognized either

Same deal as aftman, after aftman install finishes, the tools it installed need to be in your PATH. Restart your terminal and try again.

darklua issues / Build error: generated/release/dist.luau — system cannot find path

darklua probably didn't install properly even if aftman install ran fine. Check by running:

darklua --version

If that errors out, aftman installed it but it's not in your PATH yet. Try restarting your terminal first and running it again.

If it still doesn't work, just install darklua manually from the v0.18.0 release page and add it to your environment variables yourself.

build finished but I can't find the output

Check generated/ in the Cascade directory, that's where artifacts land after a successful pipeline run.