mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
Update docs for built-in ICO file creation
This commit is contained in:
@@ -1,34 +1,24 @@
|
||||
.. _doc_changing_application_icon_for_windows:
|
||||
|
||||
Changing application icon for Windows
|
||||
=====================================
|
||||
Manually changing application icon for Windows
|
||||
==============================================
|
||||
|
||||
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.
|
||||
Windows applications use a Windows only format called ICO for their file icon and
|
||||
taskbar icon. Since Godot 4.1, Godot can create an ICO file for you based on the
|
||||
icon file defined in the Windows export preset. Supported formats are PNG, WebP,
|
||||
and SVG. 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.
|
||||
|
||||
This means you no longer need to follow the steps in this section to
|
||||
manually create an ICO file, unless you wish to have control over the icon
|
||||
design depending on its displayed size.
|
||||
|
||||
Creating a custom ICO file
|
||||
--------------------------
|
||||
|
||||
.. 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.
|
||||
|
||||
This means you no longer need to follow the steps in this section to
|
||||
manually create an ICO file, unless you wish to have control over the icon
|
||||
design depending on its displayed size. 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.
|
||||
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.
|
||||
|
||||
`This video tutorial <https://www.youtube.com/watch?v=uqV3UfM-n5Y>`_ goes over how to
|
||||
export an ICO file with GIMP.
|
||||
@@ -79,65 +69,18 @@ use the ``Icon`` setting.
|
||||
Changing the file icon
|
||||
----------------------
|
||||
|
||||
In Godot 3.5 and later, you can change the file icon without
|
||||
external tools using `godoticon <https://github.com/pkowal1982/godoticon>`__.
|
||||
Changing the file icon this way should work for executables containing
|
||||
an embedded PCK.
|
||||
|
||||
The file icon is the icon of the executable that you click on to start
|
||||
the project.
|
||||
|
||||
.. image:: img/icon_file_icon.png
|
||||
|
||||
Before selecting it in the export options, you will need to install
|
||||
an extra tool called **rcedit**.
|
||||
You can download it `here <https://github.com/electron/rcedit/releases>`_.
|
||||
|
||||
After downloading, you need to tell Godot the path to the rcedit executable
|
||||
on your computer.
|
||||
Go to **Editor > Editor Settings > Export > Windows**.
|
||||
Click on the folder icon for the **rcedit** entry.
|
||||
Navigate to and select the rcedit executable.
|
||||
|
||||
.. note::
|
||||
|
||||
Linux and macOS users will also need to install
|
||||
`WINE <https://www.winehq.org/>`_ to use rcedit.
|
||||
|
||||
On macOS, make sure to use a 64-bit version of both WINE and rcedit since
|
||||
32-bit applications aren't supported anymore.
|
||||
|
||||
.. image:: img/icon_rcedit.webp
|
||||
|
||||
You should now have everything in place to change the file icon.
|
||||
To do that, you will need to specify the icon when exporting.
|
||||
Go to **Project > Export**. Assuming you have already created
|
||||
a Windows Desktop preset, select your icon in ICO format in
|
||||
the **Application > Icon** field.
|
||||
|
||||
.. warning::
|
||||
|
||||
All the supplied metadata must be valid. Most importantly, the version
|
||||
identifiers **must** take the form ``major.minor.patch.revision`` where
|
||||
every component is required and is a positive integer. For instance,
|
||||
``1.2.0.0`` is valid but ``1.2.0`` is not.
|
||||
|
||||
If you provide invalid metadata in the export preset, the application icon
|
||||
won't change as rcedit will fail to change the executable's metadata.
|
||||
|
||||
.. image:: img/icon_export_settings.webp
|
||||
|
||||
.. note::
|
||||
|
||||
If rcedit fails to change the icon, you can instead
|
||||
:ref:`compile your own Windows export templates <doc_compiling_for_windows>`
|
||||
with the icon changed. To do so, replace
|
||||
`platform/windows/godot.ico <https://github.com/godotengine/godot/blob/master/platform/windows/godot.ico>`__
|
||||
with your own ICO file *before* compiling export templates.
|
||||
|
||||
Once this is done, you can specify your export templates as custom export
|
||||
templates in your project's Windows export preset.
|
||||
|
||||
Testing the result
|
||||
------------------
|
||||
|
||||
@@ -147,6 +90,6 @@ You can now export the project. If it worked correctly, you should see this:
|
||||
|
||||
.. note::
|
||||
|
||||
If your icon isn't showing up properly, on Windows 10, try clearing the icon
|
||||
If your icon isn't showing up properly try clearing the icon
|
||||
cache. To do so, open the **Run** dialog and enter ``ie4uinit.exe
|
||||
-ClearIconCache`` or ``ie4uinit.exe -show``.
|
||||
|
||||
@@ -21,10 +21,10 @@ binary that is smaller, faster and does not contain the editor and debugger.
|
||||
Changing the executable icon
|
||||
----------------------------
|
||||
|
||||
To change the exported executable icon from the default Godot icon,
|
||||
you need to set up a tool called *rcedit*. Godot will then call this tool
|
||||
on export automatically. This process is documented in
|
||||
:ref:`doc_changing_application_icon_for_windows`.
|
||||
Godot will automatically use whatever image is set as your project's icon in the project
|
||||
settings, and convert it to an ICO file for the exported project. If you want to
|
||||
manually create an ICO file for greater control over how the icon looks at different
|
||||
resolutions then see the :ref:`doc_changing_application_icon_for_windows` page.
|
||||
|
||||
Code signing
|
||||
------------
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 12 KiB |
Reference in New Issue
Block a user