Skip to content

Building From Source

Before doing anything, open a terminal and set its cd to the Myriad source repository.

You can Download source from the official repository or clone the Myriad Repository.

Tip

You can use git clone "https://github.com/Standard-2/Myriad.git" if you have git installed

Installing aftman & dependencies

Aftman is a package manager that automatically installs the required dependencies needed to build Myriad.

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

    Ensure it's in your Environment Variables, this allows aftman to be accessed from a terminal.

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

Building a release

Myriad uses ProCMP for build composition.

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

Common mistakes

How do I get the Myriad source downloaded?

Either Download source from the Myriad Repository releases page, or if you have git just run:

git clone "https://github.com/Standard-2/Myriad.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 Myriad 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, 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 Myriad directory. That's where artifacts are placed after a successful pipeline run.