Exportando projetos¶

Por que exportar?¶

Originalmente, Godot não tinha nenhum meio de exportar projetos. Os desenvolvedores compilariam os binários adequados e construiriam os pacotes para cada plataforma manualmente.

Quando mais desenvolvedores (e até mesmo não programadores) começaram a usá-lo, e quando nossa empresa começou a fazer mais projetos ao mesmo tempo, ficou evidente que isso era um gargalo.

No PC¶

Distribuir um projeto de jogo no PC com Godot é bastante fácil. Deixe o binário Godot no mesmo diretório que o arquivo project.godot, depois comprima o diretório do projeto e pronto.

Parece simples, mas provavelmente há algumas razões pelas quais o desenvolvedor pode não querer fazer isso. A primeira é que pode não ser desejável distribuir cargas de arquivos. Alguns desenvolvedores podem não gostar de usuários curiosos espiando como o jogo foi feito, outros podem acha-lo deselegante, e assim por diante. Outra razão é que o desenvolvedor pode preferir um binário especialmente compilado, que é menor em tamanho, mais otimizado e não inclui ferramentas como o editor e o depurador.

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

Aviso

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.

No mobile¶

O mesmo cenário nas plataformas móveis é um pouco pior. Para distribuir um projeto nesses dispositivos, um binário para cada uma dessas plataformas é criado, e em seguida adicionado a um projeto nativo juntamente com os dados do jogo.

Isso pode ser problemático porque significa que o desenvolvedor deve ser familiarizado com o SDK de cada plataforma antes mesmo de ser capaz de exportar. Embora aprender cada SDK seja sempre encorajado, pode ser frustrante ser forçado a fazê-lo em um momento indesejado.

Há também outro problema com essa abordagem: diferentes dispositivos preferem alguns dados em diferentes formatos a serem executados. O principal exemplo disso é a compressão de textura. Todo o hardware do PC usa compressão S3TC (BC) e que foi padronizado por mais de uma década, mas dispositivos móveis usam diferentes formatos para compactação de textura, como PVRTC (iOS) ou ETC (Android).

Menu de exportação¶

Depois de muitas tentativas de diferentes fluxos de trabalho de exportação, a atual provou funcionar melhor. No momento da escrita, nem todas as plataformas ainda são suportadas, mas as plataformas suportadas continuam a crescer.

Para abrir o menu de exportação, clique no botão Exportar :

O menu de exportação será aberto. No entanto, estará completamente vazio. Isso porque precisamos adicionar um preconjunto de exportação.

Para criar um conjunto prévio de exportação, clique no botão Adicionar... na parte superior do menu de exportação. Isso abrirá uma lista de plataformas para escolher para um conjunto prévio de exportação.

As opções padrão são muitas vezes suficientes para exportar, por isso ajustá-las geralmente não é necessária. No entanto, muitas plataformas exigem que ferramentas adicionais (SDKs) sejam instaladas para poder exportar. Além disso, o Godot precisa de modelos de exportação instalados para criar pacotes. O menu de exportação reclamará quando algo estiver faltando e não permitirá que o usuário exporte para essa plataforma até que resolva:

Nesse momento, espera-se que o usuário volte à documentação e siga instruções sobre como configurar adequadamente essa plataforma.

Modelos de exportação¶

Além de configurar a plataforma, os modelos de exportação devem ser instalados para poder exportar projetos. Eles podem ser obtidos como um arquivo TPZ (que é um arquivo ZIP renomeado) a partir da página de download do site.

Uma vez baixados, eles podem ser instalados usando a opção Instalar modelos de exportação no editor:

Modo de exportação¶

Ao exportar, Godot faz uma lista de todos os arquivos para exportar e, em seguida, cria o pacote. Existem 3 modos diferentes para exportação:

Exportar todos os recursos do projeto
Exportar cenas selecionadas (incluindo dependências)
Exportar recursos selecionados (incluindo dependências)

Export all resources in the project will export every resource in the project. Export selected scenes and Export selected resources gives you a list of the scenes or resources in the project, and you have to select every scene or resource you want to export.

Exportação a partir da linha de comando¶

Em produção, é útil automatizar construções, e o Godot suporta isso com os parâmetros de linha de comando -export e -export-debug. Exportar da linha de comando ainda requer um conjunto prévio de exportação para definir os parâmetros de exportação. Uma invocação básica do comando seria:

godot --export "Windows Desktop" some_name

Isso será exportado para some_name.exe, assumindo que há um conjunto prévio chamado "Windows Desktop" e o modelo pode ser encontrado. O caminho de saída é relativo ao caminho do projeto ou absoluto; não respeita o diretório que o comando foi invocado.

Você também pode configurá-lo para exportar apenas o arquivo PCK ou ZIP, permitindo que uma única exportação seja usada com vários executáveis Godot. Isso ocorre se o nome-alvo terminar com .pck ou .zip.

Muitas vezes é útil combinar o argumento -export com o argumento -path e criar um conjunto prévio de exportação dedicado para exportação automatizada:

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

PCK versus ZIP pack file formats¶

Each format has its upsides and downsides. PCK is the default and recommended format for most use cases, but you may want to use a ZIP archive instead depending on your needs.

PCK format:

Uncompressed format. Larger file size, but faster to read/write.
Not readable and writable using tools normally present on the user's operating system, even though there are third-party tools to extract and create PCK files.

ZIP format:

Compressed format. Smaller file size, but slower to read/write.
Readable and writable using tools normally present on the user's operating system. This can be useful to make modding easier (see also Exportando pacotes, patches e mods).

Aviso

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.