> For the complete documentation index, see [llms.txt](https://niam.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://niam.gitbook.io/documentation/game-creator-2/uma-integration/getting-started.md).

# Getting Started

Welcome to the introductory guide for the **UMA integration** module for **Game Creator 2**! Here, you'll discover how to install the module and dive into its included examples to get started.

## Prepare your Project

To install the **UMA integration** module, you'll need to either created a new project or opened an existing one beforehand.

## Checking Dependencies

The **UMA integration** module relies on both **Game Creator 2** and **UMA**. Make sure you have these two in place before installing the module, or else you'll encounter errors during script compilation. If you haven't installed them yet, here are the package links for your reference:

* [x] **Game Creator 2 - v2.15.49 or latest**
  * [Unity Asset Store](https://assetstore.unity.com/packages/slug/203069)
* [x] **Unity Multipurpose Avatar (UMA) - v2.12 or latest**
  * [Unity Asset Store](https://assetstore.unity.com/packages/slug/35611)
  * ​[GitHub Repository](https://github.com/umasteeringgroup/UMA/releases)

{% hint style="danger" %}
If you're using UMA version 2.13 or greater, ensure that **`UMA_INSTALLED`** is included in the Scripting Define Symbols under Project Settings > Player > Other Settings > Script Compilation. For UMA version 2.12, ensure it is **NOT** included.
{% endhint %}

## Installing the Module

Firstly, ensure that the Unity Editor console is free from any errors that might prevent the scripts from compiling.

If you haven't bought the **UMA integration** module yet, visit the Asset Store's product page and follow the steps to acquire it.

{% stepper %}
{% step %}
In Unity Editor, go to "**Window**" in the top toolbar.
{% endstep %}

{% step %}
Select "**Package Manager**" from the dropdown.
{% endstep %}

{% step %}
Use the search bar in Package Manager to find **UMA Integration**.
{% endstep %}

{% step %}
Click on the package, then download and import the latest stable version.
{% endstep %}

{% step %}
Let your project finish compilation after installation.
{% endstep %}
{% endstepper %}

<figure><img src="https://348920791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeQ7CIxHuad77enwt80mG%2Fuploads%2FsXypM1ldqBWFY3shfqay%2FUMAModuleInstall.gif?alt=media&amp;token=4bd31df1-9bf4-44ff-9eb7-344f7aec4db8" alt="" width="563"><figcaption></figcaption></figure>

## Installing the Examples

{% stepper %}
{% step %}
Click on "**Game Creator**" in the top toolbar.
{% endstep %}

{% step %}
Choose "**Install**" to open the Installer window.
{% endstep %}

{% step %}
Find and expand the "**UMA**" section.
{% endstep %}

{% step %}
Select "**Examples 1**" within the UMA section.
{% endstep %}

{% step %}
Click the "**Install**" button to start the installation process.
{% endstep %}
{% endstepper %}

<figure><img src="https://348920791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeQ7CIxHuad77enwt80mG%2Fuploads%2F9QFBibnfXL8Dnbg6TiV6%2FInstallUMAExamples.gif?alt=media&amp;token=c718d3d2-b24b-4397-ac56-b07ac642fe94" alt="" width="563"><figcaption></figcaption></figure>

{% hint style="success" %}
Clicking on the Examples **install** button should install all dependencies automatically.&#x20;
{% endhint %}

After installing the examples, click '**Select**' or go to the **Project Window**. Then, navigate to **Plugins/GameCreator/Installs/UMA.Examples1@#.#.#/** to access the UMA examples directory.

<figure><img src="https://348920791-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeQ7CIxHuad77enwt80mG%2Fuploads%2FS5i7V0E6dNJx05kVQkxP%2FUMAExamplesDirectory.png?alt=media&amp;token=b862ad62-a5f4-409f-9350-1de76d6593a5" alt="" width="563"><figcaption></figcaption></figure>