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

Иконки должны быть созданы в векторном графическом редакторе в формате SVG. Необходимо соблюдать три основных требования:

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

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

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

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

Совет

Вы также можете просмотреть все существующие иконки на сайте Godot editor icons.

Параметры импорта для пользовательских иконок

Для пользовательских иконок, присутствующих в проектах (в отличие от исходного кода движка), существует два параметра импорта, которые следует включить:

Масштабирование для дисплеев с высоким DPI

Иконки должны правильно масштабироваться на дисплеях с высоким DPI, чтобы оставаться чёткими и достаточно крупными для чтения.

Чтобы гарантировать, что иконка отображается с правильным масштабом на дисплеях с высоким DPI, выберите SVG-файл в доке FileSystem, включите опцию Editor > Scale with Editor Scale в доке Import и нажмите Reimport. Обратите внимание, что эта опция доступна только для иконок в формате SVG, так как для её работы требуется использование векторного формата.

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

Чтобы гарантировать, что цвета иконки преобразуются при использовании пользователем светлой темы, выберите SVG-файл в доке FileSystem, включите опцию Editor > Convert Colors with Editor Theme в доке Import и нажмите Reimport. Обратите внимание, что эта опция доступна только для иконок в формате SVG, так как для её работы требуется использование векторного формата.

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

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

Примечание

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

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

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

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

Конкретные инструкции по созданию значков модулей см. в разделе Создание пользовательских значков модулей.

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

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

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

  2. Модуль svg включён во время компиляции (он включён по умолчанию). Без этого модуля иконки вообще не будут отображаться в редакторе.

Ссылки