Requirements
System Requirements
| Component | Version |
|---|---|
| Unity Version | 2022.3 LTS or newer |
| Game Creator 2 | Core (required) |
| GC2 Stats | Optional (for Needs Bridge) |
| GC2 Inventory | Optional (for Inventory Bridge) |
| TextMeshPro | Optional (for UI) |
Important: Game Creator 2 Core must be installed before importing CPS. The system will not compile without it.
Installation Steps
- Install Game Creator 2
Import GC2 Core from the Asset Store if not already installed.
- Import Companion System
Import CPS from the Asset Store via
Window → Package Manager - Wait for Compilation
Unity will compile scripts. This may take a moment.
- Open Settings
Go to
Tools → Companion System → Settingsto 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
- Create a new empty GameObject in your scene
- Click Add Component
- Search for "Companion Manager"
- If it appears in the list, CPS is installed correctly
Visual Scripting: CPS Instructions, Conditions, and Events appear under the
Companion 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:
- Open
Tools → Companion System → Bridges - If the required GC2 module is installed, click Enable Bridge
- 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.