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

エディタアイコン

When a new class is created and exposed to scripting, the editor's interface will display it with a default icon representing the base class it inherits from. In most cases, it's still recommended to create icons for new classes to improve the user experience.

アイコンの作成

To create new icons, you first need a vector graphics editor installed. For instance, you can use the open source Inkscape editor.

Clone the godot repository containing all the editor icons:

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:

Icons must be 16×16. In Inkscape, you can configure the document size in File > Document Properties.
Lines should be snapped to pixels whenever possible to remain crisp at lower DPI. You can create a 16×16 grid in Inkscape to make this easier.
If the user has configured their editor to use a light theme, Godot will convert the icon's colors based on a set of predefined color mappings. This is to ensure the icon always displays with a sufficient contrast rate. Try to restrict your icon's color palette to colors found in the list above. Otherwise, your icon may become difficult to read on a light background.

Once you're satisfied with the icon's design, save the icon in the cloned repository's editor/icons folder. The icon name should match the intended name in a case-sensitive manner. For example, to create an icon for CPUParticles2D, name the file CPUParticles2D.svg.

Tip

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.

Color conversion for light editor themes

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.

アイコンの最適化

Because the editor renders SVGs once at load time, they need to be small in size so they can be efficiently parsed. When the pre-commit hook runs, it automatically optimizes the SVG using svgo.

注釈

While this optimization step won't impact the icon's quality noticeably, it will still remove editor-only information such as guides. Therefore, it's recommended to keep the source SVG around if you need to make further changes.

トラブルシューティング

If icons don't appear in the editor, make sure that:

各アイコンのファイル名は、前述の命名要件に一致しているか。
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.

参照

editor/icons