Exportieren von Packs, Patches und Mods¶

Anwendungsfälle¶

Oft möchte man seinem Spiel nach dem deploy noch Funktionalität hinzufügen.

Beispiele hierfür sind ...

Herunterladbare Inhalte: die Möglichkeit, Funktionen und Inhalte zu seinem Spiel hinzuzufügen.
Patches: die Fähigkeit, einen Fehler zu beheben, der in einem ausgelieferten Produkt vorhanden ist.
Mods: anderen Personen die Möglichkeit geben, Inhalte für das eigene Spiel zu erstellen.

Diese Tools helfen Entwicklern, ihre Entwicklung über die ursprüngliche Version hinaus zu erweitern.

Übersicht der PCK-Dateien¶

Godot ermöglicht dies über eine Funktion namens Resource Packs (PCK-Dateien, mit der Erweiterung .pck).

Vorteile:

Inkrementelle Aktualisierungen/Patches
DLCs anbieten
Mod-Unterstützung anbieten
Keine Quellcode-Offenlegung für Mods erforderlich
modularere Projektstruktur
Benutzer müssen nicht das gesamte Spiel ersetzen

Der erste Teil ihrer Verwendung besteht darin, das Projekt zu exportieren und den Akteuren zu übergeben. Wenn man dann später Funktionen oder Inhalte hinzufügen möchte, liefern sie die Updates einfach über PCK-Dateien an die Benutzer.

PCK-Dateien enthalten in der Regel, sind aber nicht darauf beschränkt:

Skripte
Szenen
Shader
Modelle
Texturen
Sound-Effekte
Musik
jedes andere Nutzerinhalt (Asset), der für den Import in das Spiel geeignet ist

Die PCK-Dateien können sogar ein völlig anderes Godot-Projekt sein, welches das Originalspiel zur Laufzeit lädt.

Erzeugen von PCK-Dateien¶

Um alle Ressourcen eines Projekts in eine PCK-Datei zu packen, öffnen Sie das Projekt, gehen Sie zu Projekt/Export und klicken Sie auf „PCK/Zip exportieren“. Stellen Sie außerdem sicher, dass Sie dabei eine Exportvorlage ausgewählt haben.

Eine andere Methode wäre: exportieren von der Kommandozeile. Wenn die Ausgabedatei mit einer PCK- oder ZIP-Dateierweiterung endet, dann wird der Exportprozess diesen Dateityp für die gewählte Plattform erstellen.

Bemerkung

Wenn das eigene Spiel eine Mod-Unterstützung erhalten soll, müssen die Nutzer ähnlich exportierte Dateien erstellen. Angenommen, das ursprüngliche Spiel erwartet eine bestimmte Struktur für die Ressourcen des PCK und/oder eine bestimmte Schnittstelle für seine Skripte, dann muss entweder...

Der Entwickler muss die Dokumentation dieser erwarteten Strukturen/Schnittstellen veröffentlichen, von den Moddern erwarten, dass sie die Godot Engine installieren, und dann auch erwarten, dass diese Modder sich an die in der Dokumentation definierte API halten, wenn sie Mod-Inhalte für das Spiel erstellen (damit es funktioniert). Die Benutzer würden dann die in Godot eingebauten Export-Tools verwenden, um eine PCK-Datei zu erstellen, wie oben beschrieben.
The developer uses Godot to build a GUI tool for adding their exact API content to a project. This Godot tool must either run on a tools-enabled build of the engine or have access to one (distributed alongside or perhaps in the original game's files). The tool can then use the Godot executable to export a PCK file from the command line with OS.execute(). The game itself shouldn't use a tool-build of the engine (for security), so it's best to keep the modding tool and game separate.

Öffnen von PCK-Dateien zur Laufzeit¶

To import a PCK file, one uses the ProjectSettings singleton. The following example expects a “mod.pck” file in the directory of the games executable. The PCK file contains a “mod_scene.tscn” test scene in its root.

func _your_function():
    # This could fail if, for example, mod.pck cannot be found.
    var success = ProjectSettings.load_resource_pack("res://mod.pck")

    if success:
        # Now one can use the assets as if they had them in the project from the start.
        var imported_scene = load("res://mod_scene.tscn")

private void YourFunction()
{
    // This could fail if, for example, mod.pck cannot be found.
    var success = ProjectSettings.LoadResourcePack("res://mod.pck");

    if (success)
    {
        // Now one can use the assets as if they had them in the project from the start.
        var importedScene = (PackedScene)ResourceLoader.Load("res://mod_scene.tscn");
    }
}

Warnung

Wenn Sie eine Datei mit dem gleichen Dateipfad/-namen importieren, wie Sie sie bereits in Ihrem Projekt haben, wird sie standardmäßig durch die importierte Datei ersetzt. Dies ist etwas, worauf Sie achten sollten, wenn Sie DLC oder Mods erstellen (einfach gelöst mit einem Werkzeug, das Mods in einen bestimmten Mods-Unterordner isoliert). Es ist jedoch auch eine Möglichkeit, Patches für das eigene Spiel zu erstellen. Eine solche PCK-Datei kann den Inhalt eines zuvor geladenen PCKs reparieren.

Um dieses Verhalten auszuschalten, übergeben Sie als zweites Argument false an ProjectSettings.load_resource_pack().

Bemerkung

Für ein C# Projekt müssen Sie zuerst eine DLL erstellen und sie in den Projektspeicher legen. Vor dem Laden des Ressourcenpaketes muss die DLL dann wie folgt geladen werden: Assembly.LoadFile(mod.dll)

Zusammenfassung¶

Dieses Tutorial soll Ihnen Zeigen, wie einfach es ist Modifikationen, Patches oder DLC zu einem Spiel hinzuzufügen.