Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

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.6+.

  • SCons 3.0+-Buildsystem.

  • Xcode (oder die leichtgewichtigeren Kommandozeilentools für Xcode).

  • Vulkan SDK für MoltenVK (macOS unterstützt Vulkan nicht von Haus aus).

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

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

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

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.

Um ein .app-Bundle wie in den offiziellen Builds zu erstellen, müssen Sie die Vorlage verwenden, die sich in misc/dist/macos_tools.app befindet. Typischerweise ist dies für ein optimiertes Editor-Binary, das mit dev_build=yes gebaut wurde:

cp -r misc/dist/macos_tools.app ./Godot.app
mkdir -p Godot.app/Contents/MacOS
cp bin/godot.macos.editor.universal Godot.app/Contents/MacOS/Godot
chmod +x Godot.app/Contents/MacOS/Godot
codesign --force --timestamp --options=runtime --entitlements misc/dist/macos/editor.entitlements -s - 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.app/Contents/Frameworks
cp <Vulkan SDK path>/macOS/lib/libMoltenVK.dylib Godot.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.

Die offizielle Vorlagen sind universelle Binärdateien, die sowohl Intel x86_64 als auch ARM64-Architekturen unterstützen. Sie können auch Exportvorlagen erstellen, die nur eine der beiden Architekturen unterstützen, indem Sie den Schritt lipo weglassen.

  • Für Intel x86_64:

    scons platform=macos target=template_release arch=x86_64
scons platform=macos target=template_debug arch=x86_64

  • For Arm64 (Apple M1):

    scons platform=macos target=template_release arch=arm64
scons platform=macos target=template_debug arch=arm64

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

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

To create an .app bundle like in the official builds, you need to use the template located in misc/dist/macos_template.app. The release and debug builds should be placed in macos_template.app/Contents/MacOS with the names godot_macos_release.universal and godot_macos_debug.universal respectively. You can do so with the following commands (assuming a universal build, otherwise replace the .universal extension with the one of your arch-specific binaries):

cp -r misc/dist/macos_template.app .
mkdir -p macos_template.app/Contents/MacOS
cp bin/godot.macos.template_release.universal macos_template.app/Contents/MacOS/godot_macos_release.universal
cp bin/godot.macos.template_debug.universal macos_template.app/Contents/MacOS/godot_macos_debug.universal
chmod +x macos_template.app/Contents/MacOS/godot_macos*

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 macos_template.app/Contents/Frameworks
cp <Vulkan SDK path>/macOS/libs/libMoltenVK.dylib macos_template.app/Contents/Frameworks/libMoltenVK.dylib

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

zip -q -9 -r macos.zip macos_template.app

Pyston für eine schnellere Entwicklung nutzen

Sie können Pyston verwenden, um SCons auszuführen. Pyston ist eine JIT-fähige Implementierung der Sprache Python (in der SCons geschrieben ist). Die "volle" Version ist derzeit nur mit Linux kompatibel, aber Pyston-lite ist auch mit macOS (sowohl x86 als auch ARM) kompatibel. Pyston kann inkrementelle Builds erheblich beschleunigen, oft um einen Faktor zwischen 1,5× und 2×. Pyston kann mit alternativen Linkern wie LLD oder Mold kombiniert werden, um noch schnellere Builds zu erhalten.

Um Pyston-lite zu installieren, führen Sie python -m pip install pyston_lite_autoload aus und starten Sie SCons wie gewohnt. Dies wird automatisch eine Teilmenge der Pyston-Optimierungen in jedes Python-Programm laden, das Sie ausführen. Allerdings bringt dies keine so große Performanceverbesserung im Vergleich zur Installation von "vollem" Pyston (was derzeit unter macOS nicht möglich ist).

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