Documentation: add information about Apple Bundle IDs (#11809)

* manual: add notes on what counts as a valid bundle ID for Apple builds

specifically, for macOS & iOS builds

* Apply suggestions from code review

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
This commit is contained in:
ScatteredComet
2026-03-21 23:02:38 +00:00
committed by GitHub
parent 3141668b86
commit 7034252757
2 changed files with 13 additions and 1 deletions

View File

@@ -31,8 +31,14 @@ In the Godot editor, open the **Export** window from the **Project** menu. When
Export window opens, click **Add..** and select **iOS**.
The **App Store Team ID** and (Bundle) **Identifier** options in the **Application** category
are required. Leaving them blank will cause the exporter to throw an error.
are required. Leaving them blank will cause the exporter to throw an error. The bundle ID must be unique.
.. note::
A valid bundle ID can only contain alphanumeric characters, hyphens, and periods (``A-Z``, ``a-z``, ``0-9``, ``-``, and ``.``).
Apple recommends using reverse-DNS format (e.g. ``com.example.your-game``) of a domain you own, so that your bundle ID is guaranteed to be unique.
Bundle IDs are case-insensitive. See `CFBundleIdentifier <https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleidentifier>`__.
.. note:: | If you encounter an error during export similar to
| ``JSON text did not start with array or object and option to allow fragments not set``
| then it might be due to a malformated **App Store Team ID**!

View File

@@ -29,6 +29,12 @@ Requirements
- Download the Godot export templates. Use the Godot menu: ``Editor > Manage Export Templates``.
- A valid and unique ``Bundle identifier`` should be set in the ``Application`` section of the export options.
.. note::
A valid bundle ID can only contain alphanumeric characters, hyphens, and periods (``A-Z``, ``a-z``, ``0-9``, ``-``, and ``.``).
Apple recommends using reverse-DNS format (e.g. ``com.example.your-game``) of a domain you own, so that your bundle ID is guaranteed to be unique.
Bundle IDs are case-insensitive. See `CFBundleIdentifier <https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleidentifier>`__.
.. warning::
Projects exported without code signing and notarization will be blocked by Gatekeeper if they are downloaded from unknown sources, see the :ref:`Running Godot apps on macOS <doc_running_on_macos>` page for more information.