Using the engine compilation configuration editor

O Godot vem com um grande conjunto de recursos embutidos. Embora isso seja conveniente, também significa que o tamanho de seu binário é maior do que poderia ser, especialmente para projetos que usam apenas uma pequena porção de seu conjunto de recursos.

Para ajudar a reduzir o tamanho do binário, é possível compilar templates de exportação personalizados com certos recursos desativados. Isso é descrito em detalhes em Otimizando uma compilação para o tamanho. No entanto, determinar quais recursos precisam ser desativados pode ser uma tarefa tediosa. O editor de configuração de compilação do motor visa resolver isso, fornecendo uma interface para visualizar e gerenciar esses recursos facilmente, além de ser capaz de detectar os recursos atualmente em uso no projeto.

O Projeto > Ferramentas > Editor de Configuração de Compilação da Engine permite que você crie e gerencie perfis de build para o seu projeto Godot.

A partir de agora, você tem duas possibilidades:

Visualize a lista e desmarque manualmente os recursos dos quais você não precisa.
Use o botão Detectar de um projeto para detectar automaticamente os recursos atualmente usados no projeto e desativar os não utilizados. Observe que isso substituirá a lista de recursos existente, então se você desmarcou manualmente alguns itens, o estado deles será redefinido com base no uso real do recurso pelo projeto.

Abrindo o Editor de Configuração de Compilação da Engine

Após clicar em Detectar em Projeto, a etapa de detecção do projeto será executada. Isso pode levar de alguns segundos a vários minutos, dependendo do tamanho do projeto. Assim que a detecção for concluída, você verá uma lista atualizada de recursos com alguns recursos desativados:

Lista de recursos atualizada após o uso da detecção de recursos (exemplo da demo de plataforma 3D)

Aviso

Desmarcar recursos nesta caixa de diálogo não reduzirá diretamente o tamanho do binário na exportação. Como só é possível realmente remover recursos do binário no momento da compilação, você ainda precisa compilar templates de exportação personalizados com o perfil de build especificado para realmente se beneficiar do editor de configuração de compilação da Engine.

Agora você pode salvar o perfil de build clicando em Salvar como no topo. O perfil de build pode ser salvo em qualquer local, mas é uma boa ideia salvá-lo em algum lugar da pasta do seu projeto e adicioná-lo ao controle de versão para poder voltar a ele mais tarde, se necessário. Isso também permite usar o controle de versão para rastrear as mudanças no perfil de build.

O perfil de build é um arquivo JSON (com extensão .gdbuild) que se parece com isso após a detecção no exemplo acima:

{
    "disabled_build_options": {
        "disable_navigation_3d": true,
        "disable_xr": true,
        "module_godot_physics_3d_enabled": false,
        "module_msdfgen_enabled": false,
        "module_openxr_enabled": false
    },
    "disabled_classes": [
        "AESContext",
        ...
        "ZIPReader"
    ],
    "type": "build_profile"
}

Este arquivo pode ser passado como uma opção do SCons ao compilar templates de exportação:

scons target=template_release build_profile=/path/to/profile.gdbuild

O sistema de build usará isso para desabilitar classes não utilizadas e, como resultado, reduzir o tamanho do binário.

Limitações

A funcionalidade Detect from Project depende da leitura das cenas e scripts do projeto. Ela não será capaz de detectar os recursos usados nos seguintes cenários:

Funcionalidades que são usados em GDScripts criados de forma procedural e executados em tempo de execução.
Features that are used in expressions.
Funcionalidades que são usados em GDExtensions, a menos que o binding da linguagem permita definir classes usadas e a extensão faça uso dessa funcionalidade. Veja GH-104129 para mais detalhes.
Funcionalidades que são usados em PCKs externos carregados em tempo de execução.
Podem existir certos casos extremos. Em caso de dúvida, por favor abra uma issue no GitHub com um projeto de reprodução mínima anexado.

Ver também

You can achieve further size reductions by passing other options that reduce binary size. See Otimizando uma compilação para o tamanho for more information.