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...

Иконки редактора

При создании нового класса и предоставлении его для скриптования в интерфейсе редактора он будет отображаться со значком по умолчанию, представляющим базовый класс, от которого он наследуется. В большинстве случаев рекомендуется создавать значки для новых классов для улучшения пользовательского опыта.

Создание иконок

Для создания новых иконок вам потребуется установить векторный графический редактор. Например, можно использовать редактор с открытым исходным кодом Inkscape.

Клонируйте репозиторий godot, содержащий все иконки редактора:

git clone https://github.com/godotengine/godot.git

The icons must be created in a vector graphics editor in SVG format. There are three main requirements to follow:

  • Размер значков должен быть 16×16. В Inkscape размер документа можно настроить в разделе File > Document Properties.

  • Линии следует по возможности привязывать к пикселям, чтобы они оставались чёткими при низком разрешении. Для упрощения этого можно создать сетку 16×16 в Inkscape.

  • Если пользователь настроил свой редактор на использование светлой темы, Godot преобразует цвета значка на основе набора предопределённых цветовых сопоставлений. Это необходимо для обеспечения достаточной контрастности значка. Попробуйте ограничить цветовую палитру значка цветами из списка выше. В противном случае значок может стать трудночитаемым на светлом фоне.

Когда вы будете удовлетворены дизайном значка, сохраните его в папке editor/icons клонированного репозитория. Имя значка должно совпадать с предполагаемым именем с учётом регистра. Например, чтобы создать значок для CPUParticles2D, назовите файл CPUParticles2D.svg.

Совет

You can also browse all existing icons on the Godot editor icons website.

Import options for custom icons

For custom icons that are present in projects (as opposed to the engine source code), there are two import options you should enable:

Scaling for hiDPI displays

Icons need to be scaled properly on hiDPI displays to ensure they remain crisp and large enough to be readable.

To ensure the icon is rendered at a correct scale on hiDPI displays, select the SVG file in the FileSystem dock, enable the Editor > Scale with Editor Scale option in the Import dock and click Reimport. Note that this option is only available for icons in SVG format, as it requires the use of a vector format to work.

Преобразование цветов для тем светового редактора

To ensure the icon has its colors converted when the user is using a light theme, select the SVG file in the FileSystem dock, enable the Editor > Convert Colors with Editor Theme option in the Import dock and click Reimport. Note that this option is only available for icons in SVG format, as it requires the use of a vector format to work.

Оптимизация иконок

Поскольку редактор отображает SVG-файлы один раз при загрузке, для эффективного анализа они должны быть небольшого размера. При запуске pre-commit hook он автоматически оптимизирует SVG с помощью svgo.

Примечание

Хотя этот шаг оптимизации не окажет заметного влияния на качество значка, он всё равно удалит информацию, доступную только редактору, например направляющие. Поэтому рекомендуется сохранить исходный SVG-файл на случай необходимости внесения дальнейших изменений.

Интеграция и совместное использование иконок

Если вы участвуете в разработке самого движка, вам следует сделать запрос на добавление оптимизированных значков в папку editor/icons в основном репозитории. Перекомпилируйте движок, чтобы он подхватил новые значки для классов.

Также можно создавать собственные значки внутри модуля. Если вы создаёте свой собственный модуль и не планируете интегрировать его с Godot, вам не нужно делать отдельный запрос на извлечение, чтобы ваши значки были доступны в редакторе, поскольку они могут быть самостоятельными.

For specific instructions on how to create module icons, refer to Creating custom module icons.

Устранение неполадок

Если значки не отображаются в редакторе, убедитесь, что:

  1. Имя файла каждого значка соответствует требованиям к именованию, описанным ранее.

  2. The svg module is enabled at compile-time (it is enabled by default). Without this module, icons won't appear in the editor at all.

Ссылки