Projekte exportieren¶

Wozu exportieren?¶

Ursprünglich bot Godot keine Möglichkeit, Projekte zu exportieren. Die Entwickler kompilierten die entsprechenden Binärdateien und Bibliotheken für jede Plattform per Hand.

Als immer mehr Entwickler (und Nicht-Programmierer) begannen, Godot einzusetzen, und auch gleichzeitig unser Unternehmen immer mehr Aufträge annahm, stellte sich das als Flaschenhals heraus.

Auf dem PC¶

Ein Projekt für den PC zu verteilen ist vergleichsweise einfach. Sie legen die ausführbare Godot-Datei im selben Verzeichnis wie die project.godot ab, komprimierst den Projektordner und das war's.

Das klingt zunächst einmal simpel, doch es gibt einige Gründe, warum ein Entwickler sich gegen diese Methode auszusprechen mag. Einer davon kann sein, dass es nicht gewünscht ist, viele einzelne Dateien zu verbreiten, entweder um den internen Spielaufbau vor neugierigen Blicken zu schützen, oder weil es unelegant ist, etc. Ein anderer Grund wäre, stattdessen eine speziell kompilierte Binärdatei auszuliefern, die optimiert ist und eine kleinere Dateigröße aufweist und ohne Entwicklungswerkzeuge, wie Editor und Debugger auskommt.

Finally, Godot has a simple but efficient system for creating DLCs as extra package files.

Warnung

Godot does not support loading PCK files larger than 2 GB yet. If your exported project data is larger than 2 GB, you will need to split it into several PCK files by exporting additional PCKs and loading them at run-time.

Auf mobilen Geräten¶

Das gleiche Szenario ist auf mobilen Plattformen etwas komplizierter. Um ein Projekt auf diesen Geräten zu verteilen, wird eine Binärdatei für jede Zielplattform individuell kompiliert und diese im Anschluss in einem nativen Projekt eingebettet, zusammen mit den Spielinhalten.

Dies kann sich als problematisch erweisen, denn der Entwickler muss sich im Vorfeld mit dem SDK der jeweiligen mobilen Plattform vertraut machen, ehe er damit überhaupt etwas exportieren kann. Auch wenn es immer lobenswert ist, sich in unterschiedliche SDKs einzuarbeiten, kann es frustrierend sein, wenn das zu einer ungünstigen Gelegenheit kommt.

Auch kommt eine weitere Problematik mit diesem Ansatz einher: unterschiedliche Geräte verarbeiten bestimmte Daten in unterschiedlichen Formaten. Als prominentes Beispiel dafür steht die Texturkomprimierung. Unter PC-Hardware verwendet man dafür S3TC (BC), welches als der Standard seit über einem Jahrzehnt gilt, doch mobile Geräte verwenden anderweitige Formate für die Texturkomprimierung, wie PVRTC (iOS) oder ETC (Android).

Export-Menü¶

Nachdem verschiedene Lösungen für den Arbeitsablauf des Exports evaluiert wurden, hat sich der gegenwärtige als am besten herausgestellt. Zum Zeitpunkt dieses Schreibens sind noch nicht alle Plattformen abgedeckt, aber die Zahl der unterstützten Plattformen nimmt zu.

Um das Export-Menü zu öffnen, klicken Sie auf die Exportieren-Schaltfläche:

Das Exportieren-Fenster öffnet sich nun. Das Fenster ist jedoch leer. Das liegt daran, dass wir noch ein Exportprofil anlegen müssen.

Um ein Exportprofil anzulegen, klicken Sie auf Hinzufügen… oben im Exportieren-Fenster. Daraufhin klappt ein Menü mit einer Liste von Plattformen auf, für die ein Profil gewählt werden kann.

Die Standardoptionen für den Export sind häufig ausreichend, eine Anpassung ist daher üblicherweise nicht notwendig. Allerdings erfordern viele Plattformen zusätzliche Werkzeuge (SDKs), die vor dem Export installiert sein müssen. Außerdem benötigt Godot Exportvorlagen, die ebenfalls vorher installiert sein müssen. Das Export-Menü weist darauf hin, wenn eine Abhängigkeit fehlt und lässt den Export nicht zu, solange nicht alle Probleme behoben worden sind:

Hier würde vom Anwender erwartet werden, dass er die Dokumentation aufschlägt und den Anweisungen folgt, um dieses System entsprechend einzurichten.

Exportvorlagen¶

Abgesehen von der grundsätzlichen Einrichtung, müssen auch die Exportvorlagen installiert sein, um Projekte zu exportieren. Sie können als TPZ-Dateien (ein umbenanntes ZIP-Archiv) aus dem Download-Bereich der Webseite bezogen werden.

Einmal heruntergeladen, können sie unter Verwalte Exportvorlagen im Editor installiert werden:

Export-Modus¶

Beim Exportieren erzeugt Godot eine Liste aller zu exportierenden Dateien und erstellt dann das Paket. Es gibt 3 verschiedene Export-Modi:

Exportiere alle Ressourcen des Projekts
Exportiere ausgewählte Szenen (inklusive Abhängigkeiten)
Exportiere ausgewählte Ressourcen (inklusive Abhängigkeiten)

Export all resources in the project wird jede Ressource im Projekt exportieren. Export selected scenes und Export selected resources gibt Ihnen eine Liste der Szenen oder Ressourcen im Projekt, und Sie müssen jede Szene oder Ressource die Sie exportieren möchten auswählen.

Von der Kommandozeile exportieren¶

In der Produktion ist es nützlich, Builds zu automatisieren, und Godot unterstützt dies mit den Kommandozeilenparametern --export und --export-debug. Für den Export über die Befehlszeile ist nach wie vor eine Exportvoreinstellung zur Definition der Exportparameter erforderlich. Ein grundlegender Aufruf des Befehls wäre:

godot --export "Windows Desktop" some_name

Es wird nach some_name.exe exportiert, vorausgesetzt es gibt eine Voreinstellung namens "Windows Desktop" und die Vorlage kann gefunden werden. Der Ausgabepfad ist relativ zum Projektpfad oder absolut; es beachtet nicht das Verzeichnis, aus dem der Befehl aufgerufen wurde.

Sie können es auch so konfigurieren, dass nur die PCK- oder ZIP-Datei exportiert wird, so dass ein einziger Export mit mehreren ausführbaren Godot-Programmen verwendet werden kann. Dies findet statt, wenn der Zielname mit .pck oder .zip endet.

Es ist oft nützlich, das --export Flag mit dem --path Flag zu kombinieren und eine dedizierte Exportvoreinstellung für den automatischen Export zu erstellen:

godot --path path/to/project --export "pck" game_name.pck

PCK in Vergleich zu ZIP Pack-Dateiformat¶

Jedes Format hat seine Vor- und Nachteile. PCK ist das Standard- und empfohlene Format für die meisten Anwendungsfälle. Abhängig von Ihren Anforderungen können Sie jedoch stattdessen ein ZIP-Archiv verwenden.

PCK format:

Unkomprimiertes Format. Größere Datei, aber schneller zu lesen/schreiben.
Nicht lesbar und beschreibbar mit Tools, die normalerweise auf dem Betriebssystem des Benutzers vorhanden sind, obwohl es Tools von Drittanbietern zum Extrahieren und Erstellen von PCK-Dateien gibt.

ZIP format:

Komprimiertes Format. Kleinere Dateigröße, aber langsamer zu lesen/schreiben.
Lesbar und beschreibbar mit Tools, die normalerweise auf dem Betriebssystem des Benutzers vorhanden sind. Dies kann nützlich sein, um das Modden zu vereinfachen (siehe auch Exportieren von Packs, Patches und Mods).

Warnung

Due to a known bug, when using a ZIP file as a pack file, the exported binary will not try to use it automatically. Therefore, you have to create a launcher script that the player can double-click or run from a terminal to launch the project:

:: launch.bat (Windows)
@echo off
my_project.exe --main-pack my_project.zip

# launch.sh (Linux)
./my_project.x86_64 --main-pack my_project.zip

Save the launcher script and place it in the same folder as the exported binary. On Linux, make sure to give executable permissions to the launcher script using the command chmod +x launch.sh.