diff --git a/getting_started/workflow/export/changing_application_icon_for_windows.rst b/getting_started/workflow/export/changing_application_icon_for_windows.rst index cf82485ac..7d8dd0f21 100644 --- a/getting_started/workflow/export/changing_application_icon_for_windows.rst +++ b/getting_started/workflow/export/changing_application_icon_for_windows.rst @@ -1,18 +1,23 @@ .. _doc_changing_application_icon_for_windows: -Changing application icon for windows +Changing application icon for Windows ===================================== -By default, the exported game icon will be the Godot icon. Most likely you will want to change that for your game. There are two types of icons that can be changed: the file icon and the taskbar icon. +By default, the exported project's icon will be the Godot icon. +You will most likely 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. Changing the taskbar icon ------------------------- -The taskbar icon is the icon that shows up on the taskbar when your game is running. +The taskbar icon is the icon that shows up on the taskbar when your project +is running. .. image:: img/icon_taskbar_icon.png -To change the taskbar icon, go to Project>Project Settings>Application>Config>Icon. Click on the folder icon and select your desired icon. +To change the taskbar icon, go to +**Project → Project Settings → Application → Config → Icon**. +Click on the folder icon and select your desired icon. .. note:: This is also the icon that gets displayed in the Godot project list. @@ -21,48 +26,67 @@ To change the taskbar icon, go to Project>Project Settings>Application>Config>Ic Changing the file icon ---------------------- -The file icon is the icon of the executable that you click on to start the game. +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 +Before selecting it in the export options, you will need to install +an extra tool called **rcedit**. +You can download it `here `_. -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. +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:: For Linux users, you will also need to install wine in order to use rcedit. For more information, check https://www.winehq.org/ +.. note:: Linux and macOS users will also need to install + `WINE `_ to use rcedit. .. image:: img/icon_rcedit.png -Now you have everything ready for changing the file icon. To do that, you will need to specify the icon when exporting. Go to Project>Export. Assuming you have a windows desktop preset ready, in the options, under Application, you will find Icon, select your desired image in ICO format as your file icon. +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. -.. note:: To export an ICO image, you can use GIMP. For more details, please refer to this tutorial: http://skyboygames.com/easily-create-a-windows-app-icon-with-gimp/ - -.. seealso:: Check the documentation for more info about exporting. +.. note:: You can use software such as GIMP to export an ICO image. + For more information, please refer to + `this tutorial `_. .. image:: img/icon_export_settings.png - Testing the result ------------------ -You can now export the game and see whether you have change the icons successfully or not. -If everything works fine, you will see this. +You can now export the project. If it worked correctly, you should see this: .. image:: img/icon_result.png -Icon (ICO) file requirements ----------------------------- +ICO file requirements +--------------------- -Regardless of which program you use to create your ICO file, there are some requirements to ensure the icon (and your executable) works on Windows. +Regardless of which program you use to create your +`ICO file `_, there are +some requirements to ensure the icon (and your executable) works on Windows. -This is a bit tricky, as can be seen in the following StackOverflow threads: `one `__, `two `__. +This is a bit tricky, as can be seen in the following Stack Overflow threads: +`one `_, +`two `_. -Your ICO file should at least contain icons in the following resolutions: 16x16, 48x48 and 256x256. -They should also be uncompressed. The 256x256 icon *can* be compressed, but this breaks backwards compatibility with Windows XP. +Your ICO file should at least contain icons in the following resolutions: +16×16, 48×48 and 256×256. -If you want to fully support high-DPI screens, this is the full list of supported icon sizes on Windows 10: -16, 20, 24, 28, 30, 31, 32, 40, 42, 47, 48, 56, 60, 63, 84 and one larger than 255px. (I.e. 256 or 512 or 1024) +If you want to fully support high-DPI screens, this is the full list of +supported icon sizes on Windows 10: +16, 20, 24, 28, 30, 31, 32, 40, 42, 47, 48, 56, 60, 63, 84 +and one larger than 255 pixels (such as 256, 512 or 1024). -Note that for high-DPI compression may be used, also they should be using 24bpp mode in contrast to the lower resolutions. +It is also possible to convert a PNG image to an hiDPI-friendly ICO file +using this `ImageMagick `_ command: + +.. code-block:: none + + magick convert icon.png -define icon:auto-resize=256,128,64,48,32,16 icon.ico