Skip to content

构建指南

TIP

仅当您准备开发 MaaFramework 本身时,才需要阅读本章节内容。若您仅希望基于 MaaFramework 开发自己的应用,则请参考 快速开始

开始前,请确保已安装 Git、Python 3、CMake 3.24+,以及对应平台的编译链(Windows: MSVC 2022;Linux/macOS: Ninja + g++/clang)。

本地开发

  1. 完整克隆本仓库及子模块(推荐一次性同步)

    子模块包含第三方依赖,构建前必须初始化,可重复执行以保证同步。

    sh
    git clone --recurse-submodules https://github.com/MaaXYZ/MaaFramework.git

    sh
    git clone https://github.com/MaaXYZ/MaaFramework.git
    cd MaaFramework
    git submodule update --init --recursive
  2. 下载 MaaDeps prebuilt

    sh
    python3 tools/maadeps-download.py

    脚本会自动下载并校验预编译依赖,如遇网络问题可重复执行。

  3. 配置 CMake 预设

    • Windows
    bash
    cmake --preset "MSVC 2022"
    • Linux / macOS
    bash
    cmake --preset "NinjaMulti"
  4. 构建并安装

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

根据需要可将 --config 切换为 Debug/RelWithDebInfo。生成的二进制及相关文件默认位于 install 目录。

详情请参考 Build CI

在线开发

使用 Codespaces (Dev Container) 一键配置基础开发环境 (Ninja、Cmake、g++-13):

Open in GitHub Codespaces

随后按照 本地开发 流程进行配置。