Skip to content

Building From Source

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

Tip

You can use git clone "https://github.com/Comet-OSS/comet.git" if you have git installed

Installing darklua & dependencies

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

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

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

Building a release

Comet 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/.