Skip to content

Commit 0f2162a

Browse files
Add documentation for themed icons (monochrome)
1 parent 67e37b5 commit 0f2162a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

tutorials/export/exporting_for_android.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ There are two types of icons required by Godot:
100100

101101
- **Main Icon:** The "classic" icon. This will be used on all Android versions up to Android 8 (Oreo), exclusive. Must be at least 192×192 px.
102102
- **Adaptive Icons:** Starting from Android 8 (inclusive), `Adaptive Icons <https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive>`_ were introduced. Applications will need to include separate background and foreground icons to have a native look. The user's launcher application will control the icon's animation and masking. Must be at least 432×432 px.
103+
- **Themed Icons:** Starting from Android 13 (inclusive), Themed Icons were introduced. Applications will need to include a monochrome icon to enable this feature. The user's launcher application will control the icon's theme. Must be at least 432×432 px.
104+
105+
.. caution:: It is mandatory to provide a monochrome icon. Failure to do so will result in the default Godot monochrome icon being used.
103106

104107
.. seealso:: It's important to adhere to some rules when designing adaptive icons. `Google Design has provided a nice article <https://medium.com/google-design/designing-adaptive-icons-515af294c783>`_ that helps to understand those rules and some of the capabilities of adaptive icons.
105108

@@ -110,6 +113,7 @@ If you don't provide some of the requested icons, Godot will replace them using
110113
- **Main Icon:** Provided main icon -> Project icon -> Default Godot main icon.
111114
- **Adaptive Icon Foreground:** Provided foreground icon -> Provided main icon -> Project icon -> Default Godot foreground icon.
112115
- **Adaptive Icon Background:** Provided background icon -> Default Godot background icon.
116+
- **Adaptive Icon Monochrome:** Provided monochrome icon -> Default Godot monochrome icon.
113117

114118
It's highly recommended to provide all the requested icons with their specified resolutions.
115119
This way, your application will look great on all Android devices and versions.

0 commit comments

Comments
 (0)