Companion System

v2.0.0

Installation

Setup and requirements for the Companion System

Requirements

System Requirements

ComponentVersion
Unity Version2022.3 LTS or newer
Game Creator 2Core (required)
GC2 StatsOptional (for Needs Bridge)
GC2 InventoryOptional (for Inventory Bridge)
TextMeshProOptional (for UI)
Important: Game Creator 2 Core must be installed before importing CPS. The system will not compile without it.

Installation Steps

  1. Install Game Creator 2

    Import GC2 Core from the Asset Store if not already installed.

  2. Import Companion System

    Import CPS from the Asset Store via Window → Package Manager

  3. Wait for Compilation

    Unity will compile scripts. This may take a moment.

  4. Open Settings

    Go to Tools → Companion System → Settings to verify installation and configure defaults.

Success: If the CPS Settings window opens with the Settings and Bridges pages, installation was successful!

Project Structure

After installation, verify the following folder structure:

Assets/
├── Plugins/
│   ├── GameCreator/
│   └── CompanionSystem/
│       ├── Runtime/
│       │   ├── Core/           CompanionManager, CompanionBrain, CompanionMotor
│       │   ├── Behavior/       FollowBehavior, Formations, OwnerAwareness, Group
│       │   ├── Data/           CompanionDefinition, FollowProfile, Settings
│       │   ├── Idle/           IdleBehavior, IdleBehaviorProfile
│       │   ├── POI/            CompanionInterestPoint
│       │   ├── Abilities/      CompanionAbility, CompanionAbilitySet
│       │   ├── Vitals/         CompanionVitals, VitalsProfile
│       │   ├── Traits/         CompanionTrait, CompanionTraitHolder, TraitPool
│       │   ├── Target/         TargetManager, Targetable
│       │   ├── Reaction/       ReactionBehavior, ReactionProfile
│       │   ├── Enums/          BondTier, TraitRarity, AbilityTargetType, …
│       │   ├── GC2/
│       │   │   ├── Instructions/   Summon, Recall, Vitals, Abilities, Traits, …
│       │   │   ├── Conditions/     Party, State, Proximity, Bonding, Combat, …
│       │   │   └── Events/         Summoned, Recalled, BondTierUp, Death, …
│       │   ├── Bridges/        Optional Stats + Inventory bridges
│       │   ├── UI/             Party frames, Health bars, Ability slots, Tooltip
│       │   └── CompanionRemember.cs
│       ├── Editor/             Settings Window, custom Inspectors
│       └── Tests/

Verify Installation

  1. Create a new empty GameObject in your scene
  2. Click Add Component
  3. Search for "Companion Manager"
  4. If it appears in the list, CPS is installed correctly
Visual Scripting: CPS Instructions, Conditions, and Events appear under theCompanion System category in GC2's Visual Scripting components.

Bridge Setup (Optional)

CPS includes optional bridges for GC2 Stats and Inventory modules. These are disabled by default and can be enabled in the Settings window:

  1. Open Tools → Companion System → Bridges
  2. If the required GC2 module is installed, click Enable Bridge
  3. Unity will recompile with the bridge scripting define active
Auto-Validation: If you remove a GC2 module, CPS automatically disables the corresponding bridge define on the next domain reload to prevent compile errors.