Skip to main content

Set up iOS

Introduction​

This guide outlines the steps to setup an iOS game on ShipThis.

To create a new iOS game, or to re-apply the iOS setup process for an existing game please run the wizard command in a directory with a project.godot file:

tip

The wizard will try to complete each of these steps for you. You can also run each step individually with the commands shown.

1. Connect ShipThis with Apple​

note

Your Apple Developer credentials never leave your local computer. We recommend enabling two-factor authentication (2FA) for your Apple ID.

ShipThis makes use of Apple's APIs to manage your signing certificates, API keys, provisioning profiles, bundleIds and apps within the Apple Developer Portal on your behalf. To do this, ShipThis generates temporary session cookies which it re-uses between the various apple commands.

2. Create an App Store Connect API Key​

ShipThis can create an App Store Connect API key which is used to submit new versions of your game via Apple's App Store Connect API. This API Key is used by all of the iOS games in your ShipThis account. You can create one with the command shipthis apple apiKey create.

3. Create an iOS Distribution Certificate​

ShipThis can create an iOS Distribution Certificate which is used to sign your games before they are uploaded to the App Store. This certificate is used by all of the iOS games in your ShipThis account. You can create one with the command shipthis apple certificate create.

4. Create an App Store App And BundleId​

ShipThis will register a new App Store App and BundleId using the App Store Connect API. It will ask you to confirm the name of the App and the BundleId string which is typically in the form of com.mycompany.mygame. Both of these need to be unique within the Apple ecosystem. ShipThis will suggest values for these.

You can read more about the command here

5. Synchronize Permissions​

ShipThis will read your export_presets.cfg file and determine which capabilities to enable in the Apple Developer Portal.

Currently, only the following permissions are supported:

  • Access WiFi
  • Push Notifications

6. Create a Mobile Provisioning profile​

A Provisioning Profile authorizes your app to run on devices and access Apple services. It is a digitally signed XML file issued by Apple that combines your App ID, developer certificate, entitlements, and device identifiers. It’s essential for development and distribution.

You can view the registered Profiles in the Apple Developer Portal.

7. shipthis game ship 🚀​

You are now ready to ship your game to Testflight with a single command.