Exportando pacotes, patches e mods

Casos de uso

Oftentimes, one would like to add functionality to one's game after it has been deployed.

Exemplos disso incluem...

• Conteúdo para download: a capacidade de adicionar recursos e conteúdo ao jogo.

• Patches: a capacidade de corrigir um bug que está presente em um produto enviado.

• Mods: conceda a outras pessoas a capacidade de criar conteúdo para o jogo.

Essas ferramentas ajudam os desenvolvedores a estender seu desenvolvimento além do lançamento inicial.

Overview of PCK/ZIP files

Godot enables this via a feature called resource packs (PCK files, with the .pck extension, or ZIP files).

Vantagens:

• atualizações/patches incrementais

• oferecer DLCs

• oferecer suporte a mods

• nenhuma divulgação de código fonte necessária para mods

• estrutura de projeto mais modular

• os usuários não precisam substituir o jogo inteiro

The first part of using them involves exporting and delivering the project to players. Then, when one wants to add functionality or content later on, they just deliver the updates via PCK/ZIP files to the users.

PCK/ZIP files usually contain, but are not limited to:

• scripts

• cenas

• shaders

• modelos

• texturas

• efeitos sonoros

• música

• qualquer outro asset adequado para importação para o jogo

The PCK/ZIP files can even be an entirely different Godot project, which the original game loads in at runtime.

It is possible to load both PCK and ZIP files as additional packs at the same time. See Formatos de arquivo PCK versus ZIP for a comparison of the two formats.

Ver também

If you want to load loose files at runtime (not packed in a PCK or ZIP by Godot), consider using Runtime file loading and saving instead. This is useful for loading user-generated content that is not made with Godot, without requiring users to pack their mods into a specific file format.

The downside of this approach is that it's less transparent to the game logic, as it will not benefit from the same resource management as PCK/ZIP files.

Gerando arquivos PCK

In order to pack all resources of a project into a PCK file, open the project and go to Project > Export and click on Export PCK/ZIP. Also, make sure to have an export preset selected while doing so.

Another method would be to export from the command line with --export-pack. The output file must with a .pck or .zip file extension. The export process will build that type of file for the chosen platform.

Nota

Se alguém deseja suportar mods para seu jogo, eles precisarão que seus usuários criem arquivos exportados da mesma forma. Assumindo que o jogo original espera uma certa estrutura para os recursos do PCK e/ou uma determinada interface para seus scripts, então...

1. O desenvolvedor deve divulgar a documentação dessas estruturas/interfaces esperadas, esperar que os modders instalem o Godot Engine, e também esperar que esses modders estejam de acordo com a API definida pela documentação ao construir o conteúdo do mod para o jogo (para que ele funcione). Os usuários usariam então as ferramentas de exportação Godot construídas pelo Godot para criar um arquivo PCK, conforme detalhado acima.

2. O desenvolvedor usa Godot para construir uma ferramenta GUI para adicionar seu conteúdo API exato a um projeto. Esta ferramenta Godot deve ser executada em uma construção do mecanismo habilitada para ferramentas ou ter acesso a uma (distribuída ao lado ou talvez nos arquivos originais do jogo). A ferramenta pode então utilizar o executável Godot para exportar um arquivo PCK da linha de comando com OS.execute(). O jogo em si não deve utilizar uma ferramenta de construção da engine (para segurança), portanto é melhor manter a ferramenta de modding e o jogo separados.

Opening PCK or ZIP files at runtime

To load a PCK or ZIP file, one uses the ProjectSettings singleton. The following example expects a mod.pck file in the directory of the game's executable. The PCK or ZIP file contains a mod_scene.tscn test scene in its root.

GDScriptC#

func _your_function():
    # This could fail if, for example, mod.pck cannot be found.
    var success = ProjectSettings.load_resource_pack(OS.get_executable_path().get_base_dir().path_join("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")

Aviso

By default, if you import a file with the same file path/name as one you already have in your project, the imported one will replace it. This is something to watch out for when creating DLC or mods. You can solve this problem by using a tool that isolates mods to a specific mods subfolder.

However, it is also a way of creating patches for one's own game. A PCK/ZIP file of this kind can fix the content of a previously loaded PCK/ZIP (therefore, the order in which packs are loaded matters).

Para cancelar este comportamento, passe false como o segundo argumento para ProjectSettings.load_resource_pack().

Nota

Para um projeto em C#, você precisa construir a DLL e colocá-la no diretório do projeto primeiro. Em seguida, antes de carregar o pacote de recursos, você precisa carregar a DLL da seguinte forma: Assembly.LoadFile("mod.dll")

Solução de problemas

If you are loading a resource pack and are not noticing any changes, it may be due to the pack being loaded too late. This is particularly the case with menu scenes that may preload other scenes using preload(). This means that loading a pack in the menu will not affect the other scene that was already preloaded.

To avoid this, you need to load the pack as early as possible. To do so, create a new autoload script and call ProjectSettings.load_resource_pack() in the autoload script's _init() function, rather than _enter_tree() or _ready().

Resumo

This tutorial explains how to add mods, patches, or DLC to a game. The most important thing is to identify how one plans to distribute future content for their game and develop a workflow that is customized for that purpose. Godot should make that process smooth regardless of which route a developer pursues.