godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-07 02:12:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3510 from Calinou/editor-icons-light-theme-conversion

Browse Source 
Document how to work with the editor icons' automatic theme conversion
This commit is contained in:
Max Hilbrunner
2020-05-08 23:15:49 +02:00
committed by GitHub
parent 7d01f45cd3 bacc9368c4
commit bbc199dceb
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
development/editor/creating_icons.rst
View File

@@ -5,8 +5,8 @@ Editor icons
When a new class is created and exposed to scripting, the editor's interface 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 will display it with a default icon representing the base class it inherits
from. Yet in most cases it is recommended to create icons for new classes from. In most cases, it's still recommended to create icons for new classes to
to improve the user experience. improve the user experience.
Creating icons Creating icons
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
@@ -18,7 +18,7 @@ Clone the ``godot`` repository containing all the editor icons:
.. code-block:: bash .. code-block:: bash
git clone https://github.com/godotengine/godot git clone https://github.com/godotengine/godot.git
The icons must be created in a vector graphics editor in SVG format. There are The icons must be created in a vector graphics editor in SVG format. There are
two main requirements to follow: two main requirements to follow:
@@ -33,6 +33,16 @@ 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 name in a case-sensitive manner. For example, to create an icon for
CPUParticles2D, name the file ``CPUParticles2D.svg``. CPUParticles2D, name the file ``CPUParticles2D.svg``.
Color conversion for light editor themes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 <https://github.com/godotengine/godot/blob/b9f2e57d6240346f1833fd0390de195c956299e7/editor/editor_themes.cpp#L122-L184>`__.
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.
Icon optimization Icon optimization
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
@@ -69,7 +79,7 @@ For specific instructions on how to create module icons, refer to
Troubleshooting Troubleshooting
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
If icons don't appear in the editor make sure that: If icons don't appear in the editor, make sure that:
1. Each icon's filename matches the naming requirement as described previously. 1. Each icon's filename matches the naming requirement as described previously.