> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goavatown.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unity Client

> Upload your unitypackage to Avatown!

## Prerequisites

### Unity

To ensure compatibility, it is recommended to download and install `Unity 2022.3.22f1`, which can be obtained from the [official Unity website](https://unity.com/releases/editor/whats-new/2022.3.22). This version aligns with the one used by VRChat.

**Important**:
VRChat requires Unity 2022 for its latest SDK. Users still utilizing Unity 2019 are strongly advised to upgrade, as future SDK updates will not be accessible on outdated versions. Additionally, content created in older versions may experience compatibility issues.

### VRchat Creator Companion

The VRChat Creator Companion is required for setting up VRChat projects. Please refer to the [official VRChat documentation](https://vcc.docs.vrchat.com) for installation instructions.

### Avatown Unity Client

Avatown unity client is needed to upload the Unitypackage and asset bundle of the corresponding avatar. To get started first download the Avatown Unity Client as per your language preference.

* [Download latest version of Avatown Unity Client](https://github.com/dolami-inc/avatown-docs/releases/download/official/AvatownUnityClient_v1.3.1.unitypackage)

After downloading, save the Unity package in a directory of your choice.

### Step 1: Create a New Project

For users starting a new project, please follow the steps below. If you are importing the Avatown Unity Client into an existing project, please Proceed to Step 2.

Open VRChat Creator Companion and create a new project.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/vrc_create.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=9983d4e065214afd8da1620e5f5c4821" data-path="images/unityclient/vrc_create.png" />

Enter a project name, specify a directory, and click Create Project. On the subsequent screen, ensure all required VRChat SDKs are selected.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/vrc_package.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=d854b4fb9327672d094934f63fbfb9d5" data-path="images/unityclient/vrc_package.png" />

Once the required packages have been selected, click Open Project to launch Unity.

### Step 2: Importing the Avatown Unity Client

Once the project has been opened in Unity and ready to be used, lets import the Avatown Unity Client. If already have an existing avatar project, follow from this step.
To import, `Assets > Import Package > Custom Package...`

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/import_asset.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=3ce7f7fe05eb58d424fccc592fb45b65" data-path="images/unityclient/import_asset.png" />

Select the previously downloaded Avatown Unity Client Unity package file.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/select_package.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=decd89520c7d1647d5a61e8422a8abc1" data-path="images/unityclient/select_package.png" />

This will show a prompt on Unity about what files are being imported. Click "Import".

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/click_import.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=75ab316e3f52416ae6638823dcb392c8" data-path="images/unityclient/click_import.png" />

A prompt will appear displaying the files that will be imported. Click Import to proceed.
Unity will begin the import process. Please wait for it to complete.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/select_package.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=decd89520c7d1647d5a61e8422a8abc1" data-path="images/unityclient/select_package.png" />

### Step 3: Accessing the Avatown Unity Client

Upon successful import, you will find Avatown in the Unity toolbar. Click on Avatown Client to launch the client interface.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/open_avatown.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=0b5684c9efd6b6fe21dcc11ef7c0a0f0" data-path="images/unityclient/open_avatown.png" />

You will be required to log in using your goavatown.com account credentials.
Once logged in, the Avatown Unity Client is ready for use.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/avatown_login.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=b167e64186cd7a4e13e1997c16df3f48" data-path="images/unityclient/avatown_login.png" />

Once you log in, you will see the list of products that you have created on Avatown.Click on “View” on the top-right of the product card. This will show the details of the product.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/Click%20_View_.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=2ec7be4382dafac4ce8c438c8531e12a" data-path="images/unityclient/Click _View_.png" />

Check the details of the product you want to register for auto-upload, then click "Get Started".

<img height="200" noZoom src="https://mintlify.s3.us-west-1.amazonaws.com/avatown/images/unityclient/Click%20get%20started.png" />

Once you reach this screen, open the dropdown menu and select the avatar you want to register from the avatars in your scene. (If it's a cross-platform avatar, please select the Windows avatar first.)

> The avatar must be in the scene. If there is no avatar in the scene, it will not appear in the dropdown. Also, please note that if the avatar in your scene does not have the VRChat Avatar Descriptor attached, it will not show up in the dropdown.

Click "Select this avatar" and proceed to the next step

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/select_from_scene.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=a80bd3caed149dee89a9edfcab16338e" data-path="images/unityclient/select_from_scene.png" />

Click "Start build". The build will begin and the auto-uploader registration process will start.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/start_build.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=db4d5f38b43cdea828b7518b57aec502" data-path="images/unityclient/start_build.png" />

Wait for the upload to complete.

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/uploading.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=917cdf425c7198168ee3df5105dd3ead" data-path="images/unityclient/uploading.png" />

Once the upload is complete, you'll see this screen. When a "✓" appears next to your uploaded file format, this product is ready for the auto-uploader. (This may take a few minutes after the upload process finishes.)

<img height="200" noZoom src="https://mintcdn.com/avatown/3tjkd2A3UXxH-eZA/images/unityclient/build_scceeded.png?fit=max&auto=format&n=3tjkd2A3UXxH-eZA&q=85&s=a77dbdbdf64e6167cda25bd02edcb5fb" data-path="images/unityclient/build_scceeded.png" />

And that’s it. Your avatar is ready for the users! Thanks for following along! 🎉
For cross-platform avatar registration, click on other platforms such as "Android" shown in the image above, and follow the steps.
