Skip to content

Commit 7034252

Browse files
ScatteredCometAThousandShipsCalinou
authored
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>
1 parent 3141668 commit 7034252

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

tutorials/export/exporting_for_ios.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,14 @@ In the Godot editor, open the **Export** window from the **Project** menu. When
3131
Export window opens, click **Add..** and select **iOS**.
3232

3333
The **App Store Team ID** and (Bundle) **Identifier** options in the **Application** category
34-
are required. Leaving them blank will cause the exporter to throw an error.
34+
are required. Leaving them blank will cause the exporter to throw an error. The bundle ID must be unique.
3535

36+
.. note::
37+
38+
A valid bundle ID can only contain alphanumeric characters, hyphens, and periods (``A-Z``, ``a-z``, ``0-9``, ``-``, and ``.``).
39+
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.
40+
Bundle IDs are case-insensitive. See `CFBundleIdentifier <https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleidentifier>`__.
41+
3642
.. note:: | If you encounter an error during export similar to
3743
| ``JSON text did not start with array or object and option to allow fragments not set``
3844
| then it might be due to a malformated **App Store Team ID**!

tutorials/export/exporting_for_macos.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ Requirements
2929
- Download the Godot export templates. Use the Godot menu: ``Editor > Manage Export Templates``.
3030
- A valid and unique ``Bundle identifier`` should be set in the ``Application`` section of the export options.
3131

32+
.. note::
33+
34+
A valid bundle ID can only contain alphanumeric characters, hyphens, and periods (``A-Z``, ``a-z``, ``0-9``, ``-``, and ``.``).
35+
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.
36+
Bundle IDs are case-insensitive. See `CFBundleIdentifier <https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleidentifier>`__.
37+
3238
.. warning::
3339

3440
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.

0 commit comments

Comments
 (0)