Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Ícones do editor
Quando uma nova classe é criada e exposta ao script, a interface do editor a exibirá com um ícone padrão representando a classe base da qual ela herda. Na maioria dos casos, ainda é recomendável criar ícones para novas classes para melhorar a experiência do usuário.
Criando ícones
Para criar novos ícones, primeiro você precisa ter um editor de gráficos vetoriais instalado. Por exemplo, você pode usar o editor de código aberto Inkscape.
Clone o repositório godot que contém todos os ícones do editor:
git clone https://github.com/godotengine/godot.git
Os ícones devem ser criados em um editor de gráficos vetoriais no formato SVG. Existem três requisitos principais a serem seguidos:
Os ícones devem ter 16×16 pixels. No Inkscape, você pode configurar o tamanho do documento em Arquivo > Propriedades do Documento.
As linhas devem ser ajustadas aos pixels sempre que possível para manter a nitidez em resoluções mais baixas (DPI). Você pode criar uma grade de 16x16 no Inkscape para facilitar esse processo.
Se o usuário configurou o editor para usar um tema claro, a Godot converterá as cores do ícone com base em um conjunto de mapeamentos de cores predefinidos <https://github.com/godotengine/godot/blob/master/editor/themes/editor_color_map.cpp>`__. Isso garante que o ícone seja sempre exibido com uma taxa de contraste suficiente. Tente restringir a paleta de cores do seu ícone às cores encontradas na lista acima. Caso contrário, o ícone poderá ficar difícil de ler em um fundo claro.
Após ficar satisfeito com o design do ícone, salve-o na pasta editor / icons do repositório clonado. O nome do ícone deve corresponder ao nome pretendido, respeitando maiúsculas e minúsculas. Por exemplo, para criar um ícone para CPUParticles2D, nomeie o arquivo como CPUParticles2D.svg.
Dica
Você também pode navegar por todos os ícones existentes no site Ícones do editor Godot.
Opções de importação para ícones personalizados
Para ícones personalizados presentes em projetos (e não no código-fonte da engine), existem duas opções de importação que você deve habilitar:
Dimensionamento para telas HiDPI
Em telas HiDPI, os ícones precisam ser dimensionados corretamente para garantir que permaneçam nítidos e grandes o suficiente para serem legíveis.
Para garantir que o ícone seja renderizado na escala correta em telas de alta HiDPI, selecione o arquivo SVG no painel Sistema de Arquivos, habilite a opção Editor > Dimensionar com a Escala do Editor no painel Importar e clique em . Observe que essa opção está disponível apenas para ícones no formato SVG, pois requer o uso de um formato vetorial para funcionar.
Conversão de cores para temas de editor claro
Para garantir que as cores do ícone sejam convertidas quando o usuário estiver usando um tema claro, selecione o arquivo SVG no painel Sistema de Arquivos, habilite a opção Editor > Converter Cores com o Tema do Editor no painel Importar e clique em . Observe que essa opção está disponível apenas para ícones no formato SVG, pois requer o uso de um formato vetorial para funcionar.
Otimização de ícones
Como o editor renderiza SVGs apenas uma vez no momento do carregamento, eles precisam ter um tamanho pequeno para que possam ser processados de forma eficiente. Quando o hook de pré-commit é executado, ele otimiza automaticamente o SVG usando o svgo.
Nota
Embora essa etapa de otimização não afete a qualidade do ícone de forma perceptível, ela removerá informações exclusivas do editor, como guias. Portanto, recomenda-se manter o arquivo SVG original caso precise fazer alterações adicionais.
Integrar e compartilhar os ícones
Se você estiver contribuindo para a própria engine, faça um pull request para adicionar ícones otimizados ao diretório editor / icons no repositório principal. Recompile a engine para que ela reconheça os novos ícones para as classes.
Também é possível criar ícones personalizados dentro de um módulo. Se você estiver criando seu próprio módulo e não planeja integrá-lo ao Godot, não precisa fazer um pull request separado para que seus ícones fiquem disponíveis no editor, pois eles podem ser autocontidos.
Para instruções específicas sobre como criar ícones de módulos, consulte Criando ícones de módulos personalizados.
Solução de problemas
Se os ícones não aparecerem no editor, verifique se:
O nome de cada ícone corresponde ao requisito de nomenclatura descrito anteriormente.
O módulo
svgé habilitado em tempo de compilação (está habilitado por padrão). Sem este módulo, os ícones não aparecerão no editor.