How to build

TIP

You only need to read this chapter if you are ready to develop MaaFramework itself. If you only want to develop applications based on MaaFramework, please refer to Quick Started.

Local Development

1. Download MaaDeps prebuilt

   python3 tools/maadeps-download.py

2. Configure cmake

   • Windows

   cmake --preset "MSVC 2022"

   • Linux / macOS

   cmake --preset "NinjaMulti"

3. Build the project using cmake

   cmake --build build --config Release
   cmake --install build --prefix install

The generated binaries and related files are located in the install directory.

For more details, refer to Build CI.

Online Development

Use Codespaces (Dev Container) to set up the basic development environment with one click (Ninja, CMake, g++-13):

Then follow the steps in Local Development.