# Setup Guide

{% hint style="warning" %}
**HeroBridge** depends on the **Sidekick Tool** and **Starter Pack**. Make sure both are installed **before** installing HeroBridge, since it generates its cache from the tool.\
If needed, you can manually trigger the cache generation by following these [instructions](#automatic-cache-export).
{% endhint %}

## Setup

1. [Setup and install Game Creator 2](https://docs.gamecreator.io/gamecreator/getting-started/installation/)
2. Install [FREE Starter Pack - Sidekick Modular Characters by Synty](https://assetstore.unity.com/packages/3d/characters/free-starter-pack-sidekick-modular-characters-by-synty-336970)
3. Download and install the Sidekick Tool & Database

   > After installing the Sidekick free starter pack, a window should appear prompting you to download and install the **Sidekick Tool.**\
   > If the window doesn’t appear, you can manually open the downloader by navigating to **Synty > Sidekick Tool Downloader** in the Unity toolbar.
   >
   > You can also manually download it from [Synty's Github](https://github.com/SyntyStudios/SidekicksToolRelease/releases/) (Download & Import both Sidekicks.unitypackage and SidekicksDatabase.unitypackage)
4. Download and install HeroBridge Integration of Sidekick for Game Creator 2 from the package manager
5. *(Optional)* You can [install the example content](#installing-the-example-content) and [patch animations.](https://docs.fullscreen.no/info/game-creator-2-assets/herobridge/setup-guide/animation-patcher)

***

## Updating HeroBridge

When a new version of HeroBridge is released, we recommend uninstalling the old version first.

**How to Uninstall**

Go to the Unity toolbar:\
`Game Creator > Uninstall > HeroBridge`

After uninstalling, you can safely install the latest version.

***

#### Installing the Example Content

To install example content for HeroBridge:

1. Open the Game Creator Install Window:\
   `Game Creator > Install…`
2. In the list, locate **HeroBridge** and check the box for **Examples**.
3. Click **Install** to add the examples to your project.

**Important:** It is recommended to **copy any example content you plan to modify,** such as entire scenes, before making changes. This ensures that if you update HeroBridge later, any modifications you made to the demo content will not be overwritten.

***

#### Example Location

Once installed, you can find the example content here:\
`Plugins/GameCreator/Installs/HeroBridge.Examples@1.0.0/`

There are two example scenes included:

* **Dropdowns and Cycle Between Parts:** Demonstrates cycling through parts using dropdown menus.
* **Buttons Preview of Every Part:** Generates buttons with icons for every part at runtime, allowing selection via UI buttons.

  > This second scene is the one available to try on Itch.io.

***

## Automatic Cache Export

When **HeroBridge** is installed through **Package Manager**, HeroBridge automatically attempts to export all cache data during setup.\
It takes parts, presets, colors, bodyshape, species and expressions data directly from the **Sidekick database** (Expressions from demo animation controller).

This process is done for **performance reasons** and **WebGL compatibility**. Using pre-generated cache allows HeroBridge to operate without querying the database at runtime, preventing potential game freezes or hitches caused by live data retrieval. It also ensures **WebGL support**, as **SQLite databases are not compatible with WebGL builds**.

If needed, you can manually generate and view cache status anytime in the Settings window:

`Game Creator > Settings > HeroBridge`