为 macOS 平台编译

备注

这个页面描述的是如何从源码编译 macOS 编辑器和导出模板二进制文件。如果你要找的是导出项目到 macOS，请阅读 为 macOS 导出。

需求

在 macOS 下编译时，需要以下条件：

备注

如果你安装了 Homebrew，你可以使用以下命令轻松地安装 SCons 和 yasm：

brew install scons yasm

如果你还没有 Xcode 命令行工具，安装 Homebrew 也会自动进行获取。

同样，如果你安装了 MacPorts，你可以使用以下命令轻松安装 SCons 和 yasm：

sudo port install scons yasm

参见

要获取编译所需的 Godot 源码，请参阅 获取源代码。

有关 Godot 的 SCons 用法的一般概述，请参阅 构建系统介绍。

编译

启动终端, 进入引擎源代码的根目录.

若要为英特尔（x86-64）架构的 Mac 编译，请使用：

scons platform=osx arch=x86_64 --jobs=$(sysctl -n hw.logicalcpu)

要为 Apple Silicon（ARM64）驱动的 Mac 编译，请使用：

scons platform=osx arch=arm64 --jobs=$(sysctl -n hw.logicalcpu)

如果要通过“Universal 2”二进制来同时支持这两种架构，请运行上述两个命令，然后使用 lipo 将它们打包在一起：

lipo -create bin/godot.osx.tools.x86_64 bin/godot.osx.tools.arm64 -output bin/godot.osx.tools.universal

如果一切顺利, 产生的二进制可执行文件将被放置在 bin/ 子目录中. 这个可执行文件包含整个引擎, 运行时没有任何依赖性. 执行它将会弹出项目管理器.

备注

如果你想为自己的 Godot 构建和官方发布使用单独的编辑器设置，你可以通过在 bin/ 文件夹中创建一个名为 ._sc_ 或 _sc_ 的文件来启用 自包含模式。

要创建一个像官方构建的 .app 捆绑包，你需要使用位于 misc/dist/osx_tools.app 的模板。通常，对于用 target=release_debug' 构建的优化编辑器可执行文件：

cp -r misc/dist/osx_tools.app ./Godot.app
mkdir -p Godot.app/Contents/MacOS
cp bin/godot.osx.opt.tools.universal Godot.app/Contents/MacOS/Godot
chmod +x Godot.app/Contents/MacOS/Godot

编译无头/服务器构建

要编译无头构建，支持编辑器的自动化导出项目功能，请使用：

scons platform=server tools=yes target=release_debug --jobs=$(sysctl -n hw.logicalcpu)

如果要编译调试版本的服务器，支持远程调试工具，那么请使用：

scons platform=server tools=no target=release_debug --jobs=$(sysctl -n hw.logicalcpu)

如果要编译发布版本的服务器，针对运行专门的游戏服务器进行优化，那么请使用：

scons platform=server tools=no target=release --jobs=$(sysctl -n hw.logicalcpu)

构建导出模板

要建立macOS的导出模板，你必须用 tools=no （无编辑器）进行编译，并分别为 target=release （发布模板）和 target=release_debug.

官方模板是通用的二进制文件，同时支持英特尔x86_64和ARM64架构。你也可以通过省略下面的 lipo 步骤，创建只支持架构中的一种的导出模板。

  • 对于英特尔 x86_64：

    scons platform=osx tools=no target=release arch=x86_64 --jobs=$(sysctl -n hw.logicalcpu)
scons platform=osx tools=no target=release_debug arch=x86_64 --jobs=$(sysctl -n hw.logicalcpu)

  • 对于 ARM64（Apple M1）：

    scons platform=osx tools=no target=release arch=arm64 --jobs=$(sysctl -n hw.logicalcpu)
scons platform=osx tools=no target=release_debug arch=arm64 --jobs=$(sysctl -n hw.logicalcpu)

要使用“Universal 2”二进制来同时支持这两种架构，请运行上述两个命令块，然后使用 lipo 将它们捆绑在一起：

lipo -create bin/godot.osx.opt.x86_64 bin/godot.osx.opt.arm64 -output bin/godot.osx.opt.universal
lipo -create bin/godot.osx.opt.debug.x86_64 bin/godot.osx.opt.debug.arm64 -output bin/godot.osx.opt.debug.universal

要创建一个像官方构建的 .app 捆绑包，你需要使用位于 misc/dist/osx_template.app 的模板。发布版和调试版应该放在 osx_template.app/Contents/MacOS 里，名称分别为 godot_osx_release.64 和 godot_osx_debug.64。你可以用下面的命令来做（假设是通用构建，否则将 .universal 扩展名替换为你的特定档案的二进制文件）：

cp -r misc/dist/osx_template.app .
mkdir -p osx_template.app/Contents/MacOS
cp bin/godot.osx.opt.universal osx_template.app/Contents/MacOS/godot_osx_release.64
cp bin/godot.osx.opt.debug.universal osx_template.app/Contents/MacOS/godot_osx_debug.64
chmod +x osx_template.app/Contents/MacOS/godot_osx*

然后你可以压缩 osx_template.app 文件夹来复制 Godot 官方发行的 osx.zip 模板：

zip -q -9 -r osx.zip osx_template.app

从 Linux 交叉编译 macOS

在Linux环境下为macOS进行编译是可行的(也许也可以在Windows中使用Windows Subsystem for Linux). 为此, 你需要安装 OSXCross , 以便能够使用macOS作为目标. 首先, 按照说明来安装它:

在你的机器上某处克隆 OSXCross 资源库（或者下载一个 ZIP 文件并解压缩），例如：

git clone --depth=1 https://github.com/tpoechtrager/osxcross.git "$HOME/osxcross"

  1. 按照说明打包SDK:https://github.com/tpoechtrager/osxcross#packaging-the-sdk

  2. 按照说明安装OSXCross:https://github.com/tpoechtrager/osxcross#installation

然后，你需要将 OSXCROSS_ROOT 定义为 OSXCross 的安装路径（与你克隆软件库/提取压缩包的地方相同），例如：

export OSXCROSS_ROOT="$HOME/osxcross"

现在你可以像平时一样用 SCons 进行编译：

scons platform=osx

如果你的 OSXCross SDK 版本与 SCons 构建系统所期望的不同，你可以用 osxcross_sdk 参数指定一个自定义的版本：

scons platform=osx osxcross_sdk=darwin15