Icons

Customising the icon files allows you to brand your application's shortcut icon, tray icon and other relevant system locations.

By default, placeholder icon assets are included with the template in the /build folder.

All platforms support icon with transparent backgrounds.

We've successfully used the free online cloudconvert tool to create bundled icon files from high quality png source files, though there are specific programs available for Windows and macOS which can add frames, backgrounds and provide better previews of the smaller icontypes.

Windows

Requires a .ico file which contains a series of square resolution variants typically ranging from 32x32 to 512x512.

The file should be at build/icon.ico for automatic use with release builds.

macOS

Requires a .icns file which contains a series of square resolution variants from 16x16 to 512x512.

You will likely experience issues building the output dmg/executable if the 512x512px variant is missing.

As of macOS 11 (Big Sur), PNG files are preferred.

The file should be at build/icon.icns and build/icon.png for automatic use with release builds.

DMG Background

Optionally add build/background.png and build/[email protected] files for automatic inclusion in the DMG container (default macOS build target).

Without an image specified, the background will be a plain solid colour (the macOS Finder default background colour).

Linux

Requires a .png icon file located at build/icon.png.

We've tested the automatic display of this icon with Ubuntu, Solus, and Manjaro.