MacOS specific properties

March 14, 2023 · View on GitHub

<macConfig>

    <!-- general properties -->
    <appId>app unique identifier</appId>
    <icnsFile>path/to/icon.icns</icnsFile>
    <generateDmg>true|false</generateDmg>
    <generatePkg>true|false</generatePkg>
    <relocateJar>true|false</relocateJar>
    <macStartup>SCRIPT|UNIVERSAL|X86_64|ARM64</macStartup>

    <!-- signing properties -->
    <developerId>singning identity</developerId>
    <entitlements>path/to/entitlements.plist</entitlements>
    <codesignApp>true|false</codesignApp>
    <hardenedCodesign>true|false</hardenedCodesign>
    <notarizeApp>true|false</notarizeApp>
    <keyChainProfile>xcrun_notarytool_profile_name</keyChainProfile>

    <!-- properties used for DMG disk image generation -->
    <backgroundImage>path/to/png</backgroundImage>
    <windowX>x</windowX>
    <windowY>y</windowY>
    <windowWidth>width</windowWidth>
    <windowHeight>height</windowHeight>
    <iconSize>size</iconSize>
    <textSize>size</textSize>
    <iconX>x</iconX>
    <iconY>y</iconY>
    <appsLinkIconX>x</appsLinkIconX>
    <appsLinkIconY>y</appsLinkIconY>
    <volumeIcon>path/to/icns</volumeIcon>
    <volumeName>${name}</volumeName>

    <!-- properties used for Info.plist file generation -->
    <infoPlist>
        <bundlePackageType>BNDL|APPL|FMWK</bundlePackageType>
        <additionalEntries>
            <![CDATA[
                <key>ThisIsABoolean</key>
                <true/>
                <key>ThisIsAString</key>
                <string>value</string>
                [...]
            ]]>
        </addtionalEntries>
    </infoPlist>

</macConfig>

Property	Mandatory	Default value	Description
`icnsFile`	:x:		ICNS format icon file.*
`generateDmg`	:x:	`true`	Enables DMG disk image file generation.
`generatePkg`	:x:	`true`	Enables installation package generation.
`relocateJar`	:x:	`true`	If `true`, Jar files are located in `Contents/Resources/Java` folder, otherwise they are located in `Contents/Resources` folder.
`appId`	:x:	`${mainClass}`	App unique identifier.

* You can use MacICNS to convert your PNG icon file to ICNS.

Signing properties

Property	Mandatory	Default value	Description
`developerId`	:x:		Signing identity.
`entitlements`	:x:		Path to entitlements file.
`codesignApp`	:x:	`true`	If it is set to `false`, generated app will not be codesigned.
`hardenedCodesign`	:x:	`true`	If it is set to `true`, enable hardened runtime if MacOS version >= 10.13.6.
`notarizeApp`	:x:	`false`	If it is set to `true`, generated app will be submitted to apple for notarization and the ticket will be stapled.
`keyChainProfile`	:x:		Profile name originally provided to `xcrun notarytool store-credentials`. Must be set if `notarizeApp` is `true`.
`macStartup`	:x:	`SCRIPT`	App startup type, using a `SCRIPT` or a binary (compiled version of the script: `UNIVERSAL`, `X86_64` or `ARM64`).

DMG generation properties

Property	Mandatory	Default value	Description
`backgroundImage`	:x:	`classpath:/mac/background.png`	DMG background image.
`windowX`	:x:	`10`	X coordinate of DMG window.
`windowY`	:x:	`50`	Y coordinate of DMG window.
`windowWidth`	:x:	`540`	Width of DMG window.
`windowHeight`	:x:	`360`	Height of DMG window.
`iconSize`	:x:	`128`	DMG icons size.
`textSize`	:x:	`16`	DMG text size.
`iconX`	:x:	`52`	X coordinate of bundled app icon. Relative to DMG window.
`iconY`	:x:	`116`	Y coordinate of bundled app icon. Relative to DMG window.
`appsLinkIconX`	:x:	`360`	X coordinate of Applications link. Relative to DMG window.
`appsLinkIconY`	:x:	`116`	Y coordinate of Applications link. Relative to DMG window.
`volumeIcon`	:x:	`${icon}`	Bundled app icon in ICNS format.
`volumeName`	:x:	`${displayName}`	Volume name (:warning: whitespaces are removed).

DMG properties explained

Info.plist generation properties

Property	Mandatory	Default value	Description
`bundlePackageType`	:x:	BNDL	Bundle package type: BNDL, APPL, FMWK.
`additionalEntries`	:x:	`""`	String with `Info.plist`additional entries.