Skip to content

Commit

Permalink
Document automatic ICO generation in Changing application icon for Wi…
Browse files Browse the repository at this point in the history
…ndows

- Remove outdated notice about known issue.
  • Loading branch information
Calinou committed Jan 18, 2025
1 parent 6e1144a commit d7140a8
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions tutorials/export/changing_application_icon_for_windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,22 @@ By default, the exported project's icon will be the Godot icon.
You will most likely want to change that for your project. There are two types
of icons that can be changed on Windows: the file icon and the taskbar icon.

Creating an ICO file
--------------------
Creating a custom ICO file
--------------------------

Windows does not use formats such as png or jpg for application icons. Instead,
.. note::

Since Godot 4.1, Godot can create an ICO file for you based on the icon file
defined in the Windows export preset. This icon file can be in PNG, WebP or
SVG format. If no icon is defined in the Windows export preset, the
:ref:`application/config/icon <class_ProjectSettings_property_application/config/icon>`
project setting is used automatically instead.

Note that even if Godot creates the ICO file for you, you still need to
:ref:`set up rcedit <doc_changing_application_icon_for_windows_changing_the_file_icon>`
so that the file icon actually changes.

Windows does not use formats such as PNG or JPEG for application icons. Instead,
it uses a Windows-only format called ICO. You can create your application icon
in any program but you will have to convert it to an ICO file using a program such
as GIMP.
Expand Down Expand Up @@ -59,6 +71,8 @@ This setting only changes the icon for your exported game on Windows.
To set the icon for macOS, use ``Macos Native Icon``. And for any other platform,
use the ``Icon`` setting.

.. _doc_changing_application_icon_for_windows_changing_the_file_icon:

Changing the file icon
----------------------

Expand All @@ -67,13 +81,6 @@ external tools using `godoticon <https://github.com/pkowal1982/godoticon>`__.
Changing the file icon this way should work for executables containing
an embedded PCK.

.. warning::

There are `known issues <https://github.com/godotengine/godot/issues/33466>`__
when changing the application icon in executables that embed a PCK file.
It's recommended to avoid using rcedit for now if you choose to enable the
**Embed Pck** option for your Windows export preset in the Export dialog.

The file icon is the icon of the executable that you click on to start
the project.

Expand Down

0 comments on commit d7140a8

Please sign in to comment.