# Setup Guide

{% hint style="warning" %}
**HeroBridge Standalone** 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. 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)
2. 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)
3. Download and install HeroBridge Standalone from the package manager.
4. Cache generation will start automatically once HeroBridge Standalone and all required dependencies are installed.\
   If it does not start, [manually run the cache generation.](#manual-cache-generation)
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)

***

### Installing the Example Content

To install the example/demo content for HeroBridge Standalone:

1. In Unity, go to **`Tools > HeroBridge Standalone > Install Demo Content`**
2. Click the menu item to install the demo content into your project

**Important**

It is recommended to **copy any example content you plan to modify**, such as entire scenes, before making changes.\
If you update HeroBridge Standalone later, demo content may be reinstalled or overwritten, and copying ensures your custom changes are preserved.

#### Example Content Location

Once installed, you can find the example content here:\
\&#xNAN;**`Assets/HeroBridge Examples`**

***

## Updating HeroBridge Standalone

When a new version of HeroBridge Standalone is released, we recommend **uninstalling the previous version before importing the update**.

HeroBridge Standalone updates may **remove, rename, or move scripts and folders**. Importing a new version over an existing one can leave behind obsolete files, which may result in **duplicate classes, missing references, or compilation errors**.

HeroBridge Standalone can be uninstalled via:\
\&#xNAN;**`Tools → HeroBridge Standalone → Uninstall HeroBridge Standalone`**

**Recommended update process:**

1. Remove the existing HeroBridge Standalone from your project
2. Import the new version of HeroBridge Standalone
3. Let Unity recompile and verify everything is working as expected

***

## Automatic Cache Export

When HeroBridge Standalone is installed via the Package Manager, it automatically attempts to **generate all required cache data during initial setup**.

HeroBridge Standalone exports parts, presets, colors, body shapes, species, and expressions directly from the Sidekick database (with expressions sourced from the demo animation controller).

This cache generation is performed for **performance and WebGL compatibility**:

* HeroBridge Standalone uses **pre-generated cache data** instead of querying the database at runtime
* Prevents potential freezes or hitches caused by live database access
* Enables **WebGL support**, as SQLite databases are not compatible with WebGL builds

### Manual Cache Generation

You can manually generate or regenerate the cache at any time via:

**`Tools > HeroBridge Standalone > Generate Cache`**

***

### Sidekick Icon Cache Generation

When generating the cache, HeroBridge Standalone will also prompt you to **generate the Sidekick Icon Cache**.\
This icon cache is required for:

* Parts Overview Tool
* Sidekick Part Applier

If you choose to generate the icon cache, HeroBridge Standalone will:

* Prompt you to save any unsaved scene changes
* Load a temporary scene
* Briefly enter Play Mode to generate editor preview icons
* Exit Play Mode and restore your previous scene automatically

You can postpone this step and generate the icon cache later using the same menu:

**`Tools > HeroBridge Standalone > Generate Cache`**

***

### Sidekick Mesh Read/Write Validation

As part of the setup process, HeroBridge Standalone also **checks all Sidekick meshes to ensure Read/Write is enabled**.

HeroBridge Standalone requires **Read/Write access on all Sidekick meshes**.\
Some Sidekick meshes are known to be **incorrectly configured with Read/Write disabled by default**, which can cause features to behave incorrectly or fail entirely.

If problematic meshes are detected, HeroBridge Standalone will notify you and offer to **fix them automatically**.

You can run this check manually at any time via:

**`Tools > HeroBridge Standalone > Check Meshes`**


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fullscreen.no/info/standalone-assets/herobridge-standalone/setup-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.