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 ви можете налаштувати розмір документа в Файл > Властивості документа.

  • Лінії слід прив’язувати до пікселів, щоб залишатися чіткими за нижчої роздільної здатності. Ви можете створити сітку 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.

Посилання