Introduction

The App Center Unity SDK enables you to use App Center Analytics, Crash and Distribution within your Unity games.

Getting Started

1. Prerequisites

Before you begin, make sure that your project is set up in Unity 5.6 or later.

The App Center SDK for Unity supports the following platforms:

• iOS (9.0 or later)
• Android (5.0/API 21 or later)
• UWP (Build 10240 or later)

[!NOTE] For versions of Unity with UWP lower than 2017.4, only a .NET scripting backend is supported. IL2CPP as a backend is not supported.

[!NOTE] For versions of Unity with iOS lower than 2017.4, it is required to enable Push notifications capability in XCode manually.

Also note that the App Center SDK for Unity is only available in C#.

2. Create your app in the App Center Portal to obtain the App Secret

If you have already created your app in the App Center portal, you can skip this step.

1. Head over to appcenter.ms.
2. Sign up or log in and click the blue button on the top right corner of the portal that says Add new and select Add new app from the dropdown menu.
3. Enter a name and an optional description for your app.
4. Select the appropriate OS and platform depending on your project as described above.
5. Click the Add new app button in the bottom-right of the page.

Once you have created an app, you can obtain its App Secret on the Getting Started or Manage App sections of the App Center Portal.

3. Add the App Center SDK to your project

The App Center SDK is integrated by importing Unity Packages into your project.

The easist way to get started is to use our Editor Extensions plugin. This plugin provides a clean UI for automatically downloading, installing and upgrading the App Center SDK.

Alternatively you can install the latest Asset Packages directly. Please follow instructions below if you would like to install packages manually:

3.1 Download the package(s)

The App Center Unity packages are downloaded from the releases tab. Download the package(s) that you want to use, from the latest release.

3.2 Import the package

Open your Unity project, then double-click each of the Unity packages you downloaded. A pop-up window should appear in your Unity project containing a list of files. Select Import, and the SDK will be added to your project. Do this for each package you downloaded and plan to use with your project.

4. Enable the SDK

4.1 Create an empty Game Object

App Center works as a component that you attach to a game object in the scene that your game launches into. Navigate to this scene and add an empty game object. Give it a descriptive name, such as "App Center".

4.2 Attach the App Center script

In the Project window, navigate to the "AppCenter" folder that was added to your project. Locate the script whose icon is the App Center logo, named AppCenterBehavior, and drag it onto your newly created game object in the Hierarchy window.

Note: You do not need to add App Center to every scene in which you wish to use it. Adding it to the first loaded scene is enough.

4.3 Configure App Center settings

Click on the new "App Center" object and add your app secrets to the corresponding fields in the Inspector window. Make sure to also check the "Use {service}" boxes for each App Center service you intend to use

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.