Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

Exporting for macOS¶

Requirements¶

Download the Redot export templates. Use the Redot menu: Editor > Manage Export Templates.
A valid and unique Bundle identifier should be set in the Application section of the export options.

Warning

Projects exported without code signing and notarization will be blocked by Gatekeeper if they are downloaded from unknown sources, see the Running Redot apps on macOS page for more information.

Code signing and notarization¶

By default, macOS will run only applications that are signed and notarized. If you use any other signing configuration, see Running Redot apps on macOS for workarounds.

To notarize an app, you must have a valid Apple Developer ID Certificate.

If you have an Apple Developer ID Certificate and exporting from macOS¶

Install Xcode command line tools and open Xcode at least once or run the sudo xcodebuild -license accept command to accept license agreement.

To sign exported app¶

Select Xcode codesign in the Code Signing > Codesign option.
Set valid Apple ID certificate identity (certificate "Common Name") in the Code Signing > Identity section.

To notarize exported app¶

Select Xcode altool in the Notarization > Notarization option.
Disable the Debugging entitlement.
Set valid Apple ID login / app. specific password or App Store Connect API UUID / Key in the Notarization section.

You can use the xcrun notarytool history command to check notarization status and use the xcrun notarytool log {ID} command to download the notarization log.

If you encounter notarization issues, see Resolving common notarization issues for more info.

After notarization is completed, staple the ticket to the exported project.

If you have an Apple Developer ID Certificate and exporting from Linux or Windows¶

Install PyOxidizer rcodesign, and configure the path to rcodesign in the Editor Settings > Export > macOS > rcodesign.

To sign exported app¶

Select PyOxidizer rcodesign in the Code Signing > Codesign option.
Set valid Apple ID PKCS #12 certificate file and password in the Code Signing section.

To notarize exported app¶

Select PyOxidizer rcodesign in the Notarization > Notarization option.
Disable the Debugging entitlement.
Set valid App Store Connect API UUID / Key in the Notarization section.

You can use the rcodesign notary-log command to check notarization status.

After notarization is completed, use the rcodesign staple command to staple the ticket to the exported project.

If you do not have an Apple Developer ID Certificate¶

Select Built-in (ad-hoc only) in the Code Signing > Codesign option.
Select Disabled in the Notarization > Notarization option.

In this case Redot will use an ad-hoc signature, which will make running an exported app easier for the end users, see the Running Redot apps on macOS page for more information.

Signing Options¶

Option	Description
Codesign	Tool to use for code signing.
Identity	The "Full Name" or "Common Name" of the signing identity, store in the macOS keychain. 1
Certificate File	The PKCS #12 certificate file. 2
Certificate Password	Password for the certificate file. 2
Custom Options	Array of command line arguments passed to the code signing tool.

1: This option is visible only when signing with Xcode codesign.
2(1,2): These options are visible only when signing with PyOxidizer rcodesign.

Notarization Options¶

Option	Description
Notarization	Tool to use for notarization.
Apple ID Name	Apple ID account name (email address). 3
Apple ID Password	Apple ID app-specific password. See Using app-specific passwords to enable two-factor authentication and create app password. 3
Apple Team ID	Team ID ("Organization Unit"), if your Apple ID belongs to multiple teams (optional). 3
API UUID	Apple App Store Connect API issuer UUID.
API Key	Apple App Store Connect API key.

Note

You should set either Apple ID Name/Password or App Store Connect API UUID/Key.

3(1,2,3): These options are visible only when notarizing with Xcode altool.

See Notarizing macOS Software Before Distribution for more info.

Entitlements¶

Hardened Runtime Entitlements¶

Hardened Runtime entitlements manage security options and resource access policy. See Hardened Runtime for more info.

Entitlement	Description
Allow JIT Code Execution 4	Allows creating writable and executable memory for JIT code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation.
Allow Unsigned Executable Memory 4	Allows creating writable and executable memory without JIT restrictions. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation.
Allow DYLD Environment Variables 4	Allows app to uss dynamic linker environment variables to inject code. If you are using add-ons with dynamic or self-modifying native code, enable them according to the add-on documentation.
Disable Library Validation	Allows app to load arbitrary libraries and frameworks. Enable it if you are using GDExtension add-ons or ad-hoc signing, or want to support user-provided external add-ons.
Audio Input	Enable if you need to use the microphone or other audio input sources, if it's enabled you should also provide usage message in the privacy/microphone_usage_description option.
Camera	Enable if you need to use the camera, if it's enabled you should also provide usage message in the privacy/camera_usage_description option.
Location	Enable if you need to use location information from Location Services, if it's enabled you should also provide usage message in the privacy/location_usage_description option.
Address Book	5 Enable to allow access contacts in the user's address book, if it's enabled you should also provide usage message in the privacy/address_book_usage_description option.
Calendars	5 Enable to allow access to the user's calendar, if it's enabled you should also provide usage message in the privacy/calendar_usage_description option.
Photo Library	5 Enable to allow access to the user's Photos library, if it's enabled you should also provide usage message in the privacy/photos_library_usage_description option.
Apple Events	5 Enable to allow app to send Apple events to other apps.
Debugging	6 You can temporarily enable this entitlement to use native debugger (GDB, LLDB) with the exported app. This entitlement should be disabled for production export.

4(1,2,3): The Allow JIT Code Execution, Allow Unsigned Executable Memory and Allow DYLD Environment Variables entitlements are always enabled for the Redot Mono exports, and are not visible in the export options.
5(1,2,3,4): These features aren't supported by Redot out of the box, enable them only if you are using add-ons which require them.
6: To notarize an app, you must disable the Debugging entitlement.

App Sandbox Entitlement¶

The App Sandbox restricts access to user data, networking and devices. Sandboxed apps can't access most of the file system, can't use custom file dialogs and execute binaries (using OS.execute and OS.create_process) outside the .app bundle. See App Sandbox for more info.

Note

To distribute an app through the App Store, you must enable the App Sandbox.

Entitlement	Description
Enabled	Enables App Sandbox.
Network Server	Enable to allow app to listen for incoming network connections.
Network Client	Enable to allow app to establish outgoing network connections.
Device USB	Enable to allow app to interact with USB devices. This entitlement is required to use wired controllers.
Device Bluetooth	Enable to allow app to interact with Bluetooth devices. This entitlement is required to use wireless controllers.
Files Downloads 7	Allows read or write access to the user's "Downloads" folder.
Files Pictures 7	Allows read or write access to the user's "Pictures" folder.
Files Music 7	Allows read or write access to the user's "Music" folder.
Files Movies 7	Allows read or write access to the user's "Movies" folder.
Files User Selected 7	Allows read or write access to arbitrary folder. To gain access, a folder must be selected from the native file dialog by the user.
Helper Executable	List of helper executables to embedded to the app bundle. Sandboxed app are limited to execute only these executable.

7(1,2,3,4,5): You can optionally provide usage messages for various folders in the privacy/*_folder_usage_description options.

Note

You can override default entitlements by selecting custom entitlements file, in this case all other entitlement are ignored.

Environment variables¶

You can use the following environment variables to set export options outside of the editor. During the export process, these override the values that you set in the export menu.

macOS export environment variables¶
Export option	Environment variable
Encryption / Encryption Key	`GODOT_SCRIPT_ENCRYPTION_KEY`
Options / Codesign / Certificate File	`GODOT_MACOS_CODESIGN_CERTIFICATE_FILE`
Options / Codesign / Certificate Password	`GODOT_MACOS_CODESIGN_CERTIFICATE_PASSWORD`
Options / Codesign / Provisioning Profile	`GODOT_MACOS_CODESIGN_PROVISIONING_PROFILE`
Options / Notarization / API UUID	`GODOT_MACOS_NOTARIZATION_API_UUID`
Options / Notarization / API Key	`GODOT_MACOS_NOTARIZATION_API_KEY`
Options / Notarization / API Key ID	`GODOT_MACOS_NOTARIZATION_API_KEY_ID`
Options / Notarization / Apple ID Name	`GODOT_MACOS_NOTARIZATION_APPLE_ID_NAME`
Options / Notarization / Apple ID Password	`GODOT_MACOS_NOTARIZATION_APPLE_ID_PASSWORD`