Skip to content

Commit 4ef6d89

Browse files
committed
Update docs for built-in ICO file creation
1 parent 9511dea commit 4ef6d89

File tree

4 files changed

+19
-66
lines changed

4 files changed

+19
-66
lines changed
Lines changed: 15 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,24 @@
11
.. _doc_changing_application_icon_for_windows:
22

3-
Changing application icon for Windows
3+
Manually changing application icon for Windows
44
=====================================
55

6-
By default, the exported project's icon will be the Godot icon.
7-
You will most likely want to change that for your project. There are two types
8-
of icons that can be changed on Windows: the file icon and the taskbar icon.
6+
Windows applications use a windows only format called ICO for their file icon and
7+
taskbar icon. Since Godot 4.1, Godot can create an ICO file for you based on the
8+
icon file defined in the Windows export preset. This icon file can be in PNG, WebP
9+
or SVG format. If no icon is defined in the Windows export preset, the
10+
:ref:`application/config/icon <class_ProjectSettings_property_application/config/icon>`
11+
project setting is used automatically instead.
12+
13+
This means you no longer need to follow the steps in this section to
14+
manually create an ICO file, unless you wish to have control over the icon
15+
design depending on its displayed size.
916

1017
Creating a custom ICO file
1118
--------------------------
1219

13-
.. note::
14-
15-
Since Godot 4.1, Godot can create an ICO file for you based on the icon file
16-
defined in the Windows export preset. This icon file can be in PNG, WebP or
17-
SVG format. If no icon is defined in the Windows export preset, the
18-
:ref:`application/config/icon <class_ProjectSettings_property_application/config/icon>`
19-
project setting is used automatically instead.
20-
21-
This means you no longer need to follow the steps in this section to
22-
manually create an ICO file, unless you wish to have control over the icon
23-
design depending on its displayed size. Note that even if Godot creates the
24-
ICO file for you, you still need to
25-
:ref:`set up rcedit <doc_changing_application_icon_for_windows_changing_the_file_icon>`
26-
so that the file icon actually changes.
27-
28-
Windows does not use formats such as PNG or JPEG for application icons. Instead,
29-
it uses a Windows-only format called ICO. You can create your application icon
30-
in any program but you will have to convert it to an ICO file using a program such
31-
as GIMP.
20+
You can create your application icon in any program but you will have to convert it
21+
to an ICO file using a program such as GIMP.
3222

3323
`This video tutorial <https://www.youtube.com/watch?v=uqV3UfM-n5Y>`_ goes over how to
3424
export an ICO file with GIMP.
@@ -79,37 +69,11 @@ use the ``Icon`` setting.
7969
Changing the file icon
8070
----------------------
8171

82-
In Godot 3.5 and later, you can change the file icon without
83-
external tools using `godoticon <https://github.com/pkowal1982/godoticon>`__.
84-
Changing the file icon this way should work for executables containing
85-
an embedded PCK.
86-
8772
The file icon is the icon of the executable that you click on to start
8873
the project.
8974

9075
.. image:: img/icon_file_icon.png
9176

92-
Before selecting it in the export options, you will need to install
93-
an extra tool called **rcedit**.
94-
You can download it `here <https://github.com/electron/rcedit/releases>`_.
95-
96-
After downloading, you need to tell Godot the path to the rcedit executable
97-
on your computer.
98-
Go to **Editor > Editor Settings > Export > Windows**.
99-
Click on the folder icon for the **rcedit** entry.
100-
Navigate to and select the rcedit executable.
101-
102-
.. note::
103-
104-
Linux and macOS users will also need to install
105-
`WINE <https://www.winehq.org/>`_ to use rcedit.
106-
107-
On macOS, make sure to use a 64-bit version of both WINE and rcedit since
108-
32-bit applications aren't supported anymore.
109-
110-
.. image:: img/icon_rcedit.webp
111-
112-
You should now have everything in place to change the file icon.
11377
To do that, you will need to specify the icon when exporting.
11478
Go to **Project > Export**. Assuming you have already created
11579
a Windows Desktop preset, select your icon in ICO format in
@@ -123,21 +87,10 @@ the **Application > Icon** field.
12387
``1.2.0.0`` is valid but ``1.2.0`` is not.
12488

12589
If you provide invalid metadata in the export preset, the application icon
126-
won't change as rcedit will fail to change the executable's metadata.
90+
won't change.
12791

12892
.. image:: img/icon_export_settings.webp
12993

130-
.. note::
131-
132-
If rcedit fails to change the icon, you can instead
133-
:ref:`compile your own Windows export templates <doc_compiling_for_windows>`
134-
with the icon changed. To do so, replace
135-
`platform/windows/godot.ico <https://github.com/godotengine/godot/blob/master/platform/windows/godot.ico>`__
136-
with your own ICO file *before* compiling export templates.
137-
138-
Once this is done, you can specify your export templates as custom export
139-
templates in your project's Windows export preset.
140-
14194
Testing the result
14295
------------------
14396

@@ -147,6 +100,6 @@ You can now export the project. If it worked correctly, you should see this:
147100

148101
.. note::
149102

150-
If your icon isn't showing up properly, on Windows 10, try clearing the icon
103+
If your icon isn't showing up properly try clearing the icon
151104
cache. To do so, open the **Run** dialog and enter ``ie4uinit.exe
152105
-ClearIconCache`` or ``ie4uinit.exe -show``.

tutorials/export/exporting_for_windows.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ binary that is smaller, faster and does not contain the editor and debugger.
2121
Changing the executable icon
2222
----------------------------
2323

24-
To change the exported executable icon from the default Godot icon,
25-
you need to set up a tool called *rcedit*. Godot will then call this tool
26-
on export automatically. This process is documented in
27-
:ref:`doc_changing_application_icon_for_windows`.
24+
Godot will automatically use whatever image is set as your projects icon in project
25+
settings, and convert it to an ICO file for the exported project. If you want to
26+
manually create an ICO file for greater control over how the icon looks at different
27+
resolutions then see the :ref:`doc_changing_application_icon_for_windows` page.
2828

2929
Code signing
3030
------------

tutorials/export/img/icon_rcedit.webp

-11.7 KB
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)