Docs/Getting Started

HeroBridge

Getting Started

Install Sidekick, set up HeroBridge, update safely, and add the optional demo content.

Install HeroBridge

HeroBridge needs the Sidekick Tool and Sidekick Database before it can build character cache data.

  1. Install the Sidekick FREE Starter Pack, Sidekick Tool, and Sidekick Database.
  2. Open Window > Package Manager and install HeroBridge Standalone.
  3. Let HeroBridge generate its cache, or run Tools > HeroBridge Standalone > Generate Cache.

Requirements

HeroBridge Standalone requires Sidekick Modular Characters, the Sidekick Tool, and the Sidekick Database.

Setup

Install Sidekick Dependencies

  1. Install FREE Starter Pack - Sidekick Modular Characters by Synty.
  2. Install the Sidekick Tool and Sidekick Database.

After you install the Sidekick Free Starter Pack, Unity should offer to download the Sidekick Tool. If it does not, open Synty > Sidekick Tool Downloader from the Unity toolbar.

You can also download and import both packages from Synty's GitHub:

  • Sidekicks.unitypackage
  • SidekicksDatabase.unitypackage

Install HeroBridge Standalone

Open Window > Package Manager and install HeroBridge Standalone. Wait for Unity to finish compiling before opening the HeroBridge tools.

You can also install the optional demo content and patch animations after setup.

Update HeroBridge Standalone

When a new HeroBridge version is available, remove the old package before importing the update. Updates can remove, rename, or move scripts and folders. Importing over an old version can leave obsolete files behind and cause duplicate classes, missing references, or compilation errors.

  1. Remove the existing HeroBridge Standalone package.
  2. Install the new HeroBridge Standalone version.
  3. Let Unity compile and check that the project works as expected.

Install Demo Content

  1. Open Tools > HeroBridge Standalone > Install Demo Content.
  2. Select the menu item to add the demo content to your project.

Copy any demo scenes or other content you plan to change before editing them. A later HeroBridge update can reinstall or overwrite demo content.

Installed demo content is located at:

text
Assets/Plugins/Fullscreen/HeroBridgeStandalone/Examples