Get started with Platform Toolkit for GameKit

Use the following steps to set up your Unity project for GameKit with the Platform Toolkit package.

Note

At the time of release, Platform Toolkit was tested for compatibility with iOS 15.0.

1. Install the required packages

Install the following required packages:

  • com.unity.platformtoolkit
  • com.unity.platformtoolkit.gamekit

For information on installing packages with Unity, refer to Package management with the Package Manager window.

2. Install the iOS platform module

The iOS platform module is required to build your project for iOS devices. For information on how to install the iOS platform module, refer to Add modules.

3. Install Xcode build tools

Install XCode with build tools for iOS on your development machine. Ensure you use the development account that you want to associate with the application.

4. Create and configure an application

Create an application on App Store Connect. For more information, refer to App Store Connect workflow.

5. Configure Player settings in the Unity Editor

Configure Unity Player settings in the Unity Editor to automatically set up your XCode project.

In the Editor, navigate to Edit > Project Settings > Player > iOS settings > Other Settings to view and configure the settings.

It's important to set the following settings:

  • Automatically add capabilities: Enable Automatically add capabilities to generate an entitlements.plist and add capabilities for Game Center. Platform Toolkit for GameKit requires the Game Center capability to be added to the XCode project to communicate with Game Center. Alternatively, add the capability manually to your Xcode project. For more information, refer to Adding capabilities to your app.
Note

If you're using a custom Bundle Identifier, ensure that it's overridden. For more information, refer to Code sign your application.

6. Add the iCloud capability

Once the Xcode project is generated, manually add the iCloud capability and enable all required services.

7. Add Achievements

Achievements must be configured in App Store Connect before you can use them use in your project. For more information, refer to Rewarding players with achievements.

Use the App Store Connect Achievement ID's and add them into the Achievement Editor in Unity.

  1. In the Unity Editor, navigate to Window > Platform Toolkit > Achievement Editor.
  2. Under the GameKit column, add the Achievement ID for each achievement you have configured in App Store Connect.

Additional resources