Kompilieren für MacOS
Bemerkung
Diese Seite beschreibt, wie man den macOS-Editor und die Exportvorlagen-Binärdateien aus dem Quellcode kompiliert . Wenn Sie Ihr Projekt stattdessen nach macOS exportieren möchten, lesen Sie Exportieren für macOS.
Anforderungen
Zum Kompilieren unter MacOS ist Folgendes erforderlich:
SCons 4.0+ build system.
Xcode (oder die leichtgewichtigeren Kommandozeilentools für Xcode).
Vulkan SDK for MoltenVK (macOS doesn't support Vulkan out of the box). The latest Vulkan SDK version can be installed quickly by running
misc/scripts/install_vulkan_sdk_macos.shwithin the Godot source repository.
Bemerkung
If you have Homebrew installed, you can easily install SCons using the following command:
brew install scons
Bei der Installation von Homebrew werden auch automatisch die Kommandozeilen-Tools für Xcode installiert, falls Sie diese noch nicht haben.
Ähnlich wenn Sie MacPorts installiert haben, können Sie SCons einfach mit dem folgenden Befehl installieren:
sudo port install scons
Siehe auch
Um den Godot-Quellcode zum Kompilieren zu erhalten, siehe Beschaffung des Quellcodes.
Eine allgemeine Übersicht über die Verwendung von SCons für Godot finden Sie unter Einführung in das Buildsystem.
Kompilieren
Starten Sie ein Terminal und wechseln Sie in das Stammverzeichnis des Engine-Quellcodes.
Zum Kompilieren für Intel (x86-64) betriebene Macs verwenden Sie:
scons platform=macos arch=x86_64
Um für Apple Silicon (ARM64) betriebene Macs zu kompilieren, verwenden Sie:
scons platform=macos arch=arm64
Tipp
If you are compiling Godot to make changes or contribute to the engine,
you may want to use the SCons options dev_build=yes or dev_mode=yes.
See Aliasnamen für Entwicklung und Produktion
for more info.
Wenn alles gut geht, wird die resultierende ausführbare Binärdatei im Unterverzeichnis bin/ abgelegt. Diese ausführbare Datei enthält die gesamte Engine und läuft ohne jegliche Abhängigkeiten. Wenn Sie sie ausführen, wird der Projektmanager angezeigt.
Bemerkung
Using a standalone editor executable is not recommended, it should be always packaged into a
.app bundle to avoid UI activation issues.
Bemerkung
Wenn Sie getrennte Editoreinstellungen für Ihre eigenen Godot-Builds und die offiziellen Releases verwenden wollen, können Sie den Portabler Modus aktivieren, indem Sie eine Datei namens ._sc_ oder _sc_ im bin/-Ordner anlegen.
Automatic .app bundle creation
To automatically create a .app bundle like in the official builds, use the generate_bundle=yes option on the last
SCons command used to build editor:
scons platform=macos arch=x86_64
scons platform=macos arch=arm64 generate_bundle=yes
Manual .app bundle creation
To support both architectures in a single "Universal 2" binary,
run the above two commands and then use lipo to bundle them together:
lipo -create bin/godot.macos.editor.x86_64 bin/godot.macos.editor.arm64 -output bin/godot.macos.editor.universal
To create a .app bundle, you need to use the template located in misc/dist/macos_tools.app. Typically, for an optimized
editor binary built with dev_build=yes:
cp -r misc/dist/macos_tools.app ./bin/Godot.app
mkdir -p bin/Godot.app/Contents/MacOS
cp bin/godot.macos.editor.universal bin/Godot.app/Contents/MacOS/Godot
chmod +x bin/Godot.app/Contents/MacOS/Godot
codesign --force --timestamp --options=runtime --entitlements misc/dist/macos/editor.entitlements -s - bin/Godot.app
Bemerkung
If you are building the master branch, you also need to include support
for the MoltenVK Vulkan portability library. By default, it will be linked
statically from your installation of the Vulkan SDK for macOS.
You can also choose to link it dynamically by passing use_volk=yes and
including the dynamic library in your .app bundle:
mkdir -p <Godot bundle name>.app/Contents/Frameworks
cp <Vulkan SDK path>/macOS/lib/libMoltenVK.dylib <Godot bundle name>.app/Contents/Frameworks/libMoltenVK.dylib
Ausführen eines Headless/Server-Builds
To run in headless mode which provides editor functionality to export projects in an automated manner, use the normal build:
scons platform=macos target=editor
And then use the --headless command line argument:
./bin/godot.macos.editor.x86_64 --headless
To compile a debug server build which can be used with remote debugging tools, use:
scons platform=macos target=template_debug
To compile a release server build which is optimized to run dedicated game servers, use:
scons platform=macos target=template_release production=yes
Exportvorlagen erstellen
Um macOS-Exportvorlagen zu erstellen, müssen Sie die Targets ohne den Editor kompilieren: target=template_release (Release-Vorlage) und target=template_debug.
Official templates are Universal 2 binaries which support both ARM64 and Intel x86_64 architectures.
To support ARM64 (Apple Silicon) + Intel x86_64:
scons platform=macos target=template_debug arch=arm64 scons platform=macos target=template_release arch=arm64 scons platform=macos target=template_debug arch=x86_64 scons platform=macos target=template_release arch=x86_64 generate_bundle=yes
To support ARM64 (Apple Silicon) only (smaller file size, but less compatible with older hardware):
scons platform=macos target=template_debug arch=arm64 scons platform=macos target=template_release arch=arm64 generate_bundle=yes
To create a .app bundle like in the official builds, you need to use the
template located in misc/dist/macos_template.app. This process can be automated by using
the generate_bundle=yes option on the last SCons command used to build export templates
(so that all binaries can be included). This option also takes care of calling lipo to create
a Universal 2 binary from two separate ARM64 and x86_64 binaries (if both were compiled beforehand).
Bemerkung
You also need to include support for the MoltenVK Vulkan portability
library. By default, it will be linked statically from your installation of
the Vulkan SDK for macOS. You can also choose to link it dynamically by
passing use_volk=yes and including the dynamic library in your .app
bundle:
mkdir -p macos_template.app/Contents/Frameworks
cp <Vulkan SDK path>/macOS/libs/libMoltenVK.dylib macos_template.app/Contents/Frameworks/libMoltenVK.dylib
In most cases, static linking should be preferred as it makes distribution easier. The main upside of dynamic linking is that it allows updating MoltenVK without having to recompile export templates.
You can then zip the macos_template.app folder to reproduce the macos.zip
template from the official Godot distribution:
zip -r9 macos.zip macos_template.app
Cross-Kompilieren für MacOS unter Linux
Es ist möglich, für macOS in einer Linux-Umgebung zu kompilieren (und vielleicht auch in Windows unter Verwendung des Windows-Subsystems für Linux). Dazu müssen Sie OSXCross installieren, um macOS als Target verwenden zu können. Folgen Sie zunächst den Anweisungen, um es zu installieren:
Clone the OSXCross repository somewhere on your machine (or download a ZIP file and extract it somewhere), e.g.:
git clone --depth=1 https://github.com/tpoechtrager/osxcross.git "$HOME/osxcross"
Befolgen Sie die Anweisungen zum Packen des SDK: https://github.com/tpoechtrager/osxcross#packaging-the-sdk
Befolgen Sie die Anweisungen zum Installieren von OSXCross: https://github.com/tpoechtrager/osxcross#installation
After that, you will need to define the OSXCROSS_ROOT as the path to
the OSXCross installation (the same place where you cloned the
repository/extracted the zip), e.g.:
export OSXCROSS_ROOT="$HOME/osxcross"
Now you can compile with SCons like you normally would:
scons platform=macos
If you have an OSXCross SDK version different from the one expected by the SCons buildsystem, you can specify a custom one with the osxcross_sdk argument:
scons platform=macos osxcross_sdk=darwin15
Fehlersuche
Fatal error: 'cstdint' file not found
If you get a compilation error of this form early on, it's likely because the Xcode command line tools installation needs to be repaired after a macOS or Xcode update:
./core/typedefs.h:45:10: fatal error: 'cstdint' file not found
45 | #include <cstdint>
| ^~~~~~~~~
Run these two commands to reinstall Xcode command line tools (enter your administrator password as needed):
sudo rm -rf /Library/Developer/CommandLineTools
sudo xcode-select --install
If it still does not work, try updating Xcode from the Mac App Store and try again.