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

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

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

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

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

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

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

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

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

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

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

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

Примечание

Чтобы включить преобразование цветов для тем редактора света:

  1. Import > Import As > Texture2D

  2. Установите editor/convert_colors_with_editor_theme на true

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

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

Примечание

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

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

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

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

Конкретные инструкции по созданию значков модулей см. в разделе Creating custom module icons.

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

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

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

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

Ссылки