Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

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:

  • Python 3.8+.

  • 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.sh within the Godot source repository.

Bemerkung

Wenn Sie Homebrew installiert haben, können Sie SCons einfach mit dem folgenden Befehl installieren:

brew install scons

Bei der Installation von Homebrew werden auch automatisch die Kommandozeilen-Tools für Xcode installiert, falls Sie diese noch nicht haben.

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 an .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 an .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

Um beide Architekturen in einer einzigen "Universal 2"-Binärdatei zu unterstützen, führen Sie die beiden obigen Befehle aus und benutzen Sie lipo, um sie zu bündeln:

lipo -create bin/godot.macos.editor.x86_64 bin/godot.macos.editor.arm64 -output bin/godot.macos.editor.universal

To create an .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

Wenn Sie den master-Branch bauen, müssen Sie auch die Unterstützung für die MoltenVK Vulkan-Portabilitätsbibliothek einbinden. Standardmäßig wird sie statisch von Ihrer Installation des Vulkan-SDK für macOS gelinkt. Sie können sie auch dynamisch linken, indem Sie use_volk=yes übergeben und die dynamische Bibliothek in Ihr .app-Bundle einbinden:

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

Um im headless Modus zu arbeiten, der Editor-Funktionen für den automatisierten Export von Projekten bietet, verwenden Sie den normalen Build:

scons platform=macos target=editor

Und dann benutzen Sie das --headless Kommandozeilenargument:

./bin/godot.macos.editor.x86_64 --headless

Um einen Debug-Server-Build zu kompilieren, der mit Remote Debugging-Tools verwendet werden kann, benutzen Sie:

scons platform=macos target=template_debug

Um ein Release-Server-Build zu kompilieren, das für den Betrieb von dedizierten Spieleservern optimiert ist, verwenden Sie:

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 an .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 an 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.

Sie können dann den Ordner macos_template.app zippen, um die Vorlage macos.zip aus der offiziellen Godot-Distribution zu reproduzieren:

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:

Klonen Sie das OSXCross-Repository irgendwo auf Ihrem Rechner (oder laden Sie eine ZIP-Datei herunter und entpacken Sie sie irgendwo), z.B.:

git clone --depth=1 https://github.com/tpoechtrager/osxcross.git "$HOME/osxcross"
  1. Befolgen Sie die Anweisungen zum Packen des SDK: https://github.com/tpoechtrager/osxcross#packaging-the-sdk

  2. Befolgen Sie die Anweisungen zum Installieren von OSXCross: https://github.com/tpoechtrager/osxcross#installation

Danach müssen Sie OSXCROSS_ROOT als Pfad zur OSXCross-Installation definieren (derselbe Ort, an dem Sie das Repository geklont bzw. das Zip entpackt haben), z.B.:

export OSXCROSS_ROOT="$HOME/osxcross"

Jetzt können Sie mit SCons kompilieren, wie Sie es normalerweise tun würden:

scons platform=macos

Wenn Sie eine andere OSXCross SDK-Version haben als die, die vom SCons Buildsystem erwartet wird, können Sie eine eigene Version mit dem osxcross_sdk Argument angeben:

scons platform=macos osxcross_sdk=darwin15