> For the complete documentation index, see [llms.txt](https://dynamicpixels.gitbook.io/dynamicpixels-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dynamicpixels.gitbook.io/dynamicpixels-docs/unity-sdk/editor.md).

# Installation

<figure><img src="/files/QcwApihC5If1LDQs2d4L" alt=""><figcaption><p>DynamicPixels Unity SDK</p></figcaption></figure>

This page will guide you through installing, setting up, and connecting the DynamicPixels plugin within your Unity project.

### Installation

{% stepper %}
{% step %}

### Download

You can obtain the latest version of the DynamicPixels Unity plugin by:

* Visiting the [DynamicPixels GitHub Repository](https://github.com/DynamicPixels/GameService-UnitySDK).
* Download the repository as a `.zip` file and extract it locally.
  {% endstep %}

{% step %}

### Import into Unity

1. Open your existing Unity project.
2. Navigate to **`Window -> Package Manager -> + Drop Down -> Add Package From Git Url`**
3. Enter the URL of the SDK git repository.
4. You can also add the package with `.zip` .
5. Confirm that all assets are selected, then click **Import**.

Upon successful import, the `DynamicPixels` folder will appear inside your `Assets/` directory.
{% endstep %}

{% step %}

### Configure DynamicPixels

After installing SDK a setup dialog will be shown, enter the Client ID and Secret that is provided in the project settings. After the submit dialog, An Empty Object will be created in the hierarchy that contains `DynamicPixels Initializer`. You can always change the SDK configuration in this component:

* **Game ID:** This value is a constant ID when you create your project in the dashboard.
* **Game Secret:** The project's secret is an important value that should be kept very private but you can change it later.
* **Debug Mode:** During game development, you need to see the errors and warnings and use this message to debug your game. This toggle enables showing these messages. Make sure to disable it whenever you want to publish your game.
* **Verbose Mode:** If you need to see more and deeper log messages enable this toggle.

This component works as the Singleton pattern and keeps plugin data between scenes.
{% endstep %}

{% step %}

### Verify Connection

After configuration:

* Add `ServiceHub.Authentication.RegisterWithEmail(RegisterWithEmailParams input);` with fulfilled parameters to check your connection and register your first player.
* Play your scene in Unity.
* Check the Users tab in your game dashboard and check if the player is registered successfully.
  {% endstep %}
  {% endstepper %}

***

### Requirements

| Item                  | Requirement                                                              |
| --------------------- | ------------------------------------------------------------------------ |
| Unity Version         | 2020.3 LTS or newer                                                      |
| Internet Access       | Required for backend API                                                 |
| DynamicPixels Account | Required (Sign up on [**dynamicpixels.dev**](https://dynamicpixels.dev)) |

### Best Practices

* Keep your DynamicPixels plugin updated to benefit from the latest features and security improvements.
* Regularly check the Release Notes for updates.