System Requirements
| Component | Version |
|---|---|
| Unity Editor | 2021.3 or higher |
| Game Creator 2 Core | Latest version |
| TextMeshPro | 3.0.6 or higher (for UI) |
Installation Steps
Follow these steps to install Relationship System in your project:
- Download the Package
Download the Relationship System package from your source (Unity Asset Store or direct download)
- Import into Unity
Assets → Import Package → Custom Package → Select the downloaded .unitypackage file
- Wait for Compilation
Unity will import all files and compile scripts. This may take 1-2 minutes.
- Verify Installation
Check that the folder structure exists and components are available (see below)
- Install the Examples
Five example scenes ship with the package but are not unpacked on import. Install them via either Game Creator → Install... → Relationship / Examples, or by selecting
Relationship.Examples.assetand pressing Open in Install in the Inspector. They unpack toAssets/Plugins/GameCreator/Installs/Relationship.Examples@1.0.0/.
Assemblies Installed
The package adds six assemblies. RelationshipSystem.Tests is editor/test-only and excluded from player builds, which also fixes builds that previously failed to compile when test code shipped inside the runtime assembly.
RelationshipSystem.Common— shared constants, all platformsRelationshipSystem.Common.Editor— editor-only menu items (new)RelationshipSystem.Runtime— core system + GC2 integration, all platformsRelationshipSystem.UI— UI components + UI Instructions, all platformsRelationshipSystem.Editor— inspectors, settings window, editor-onlyRelationshipSystem.Tests— editor/test-only, excluded from player builds
Project Structure
Verify that the following folder structure exists in your project:
Assets/
├── Plugins/
│ └── GameCreator/
│ └── RelationshipSystem/
│ ├── Runtime/
│ │ ├── Core/
│ │ │ ├── Interfaces/ (IRelationshipEntity, IRelationshipStore, ...)
│ │ │ ├── Relationship/ (RelationshipManager, RelationshipState, RelationshipKey)
│ │ │ │ └── History/ (HistoryTracker, RelationshipHistory)
│ │ │ ├── Subsystem/ (EntityRegistry, RelationshipStore, RelationshipResolver,
│ │ │ │ DecayProcessor, ModifierProcessor, InheritancePropagator,
│ │ │ │ CapProcessor, RelationshipEventBus)
│ │ │ └── Faction/
│ │ │ └── RuntimeFaction/ (RuntimeFaction, RuntimeFactionRegistry)
│ │ ├── Components/ (CharacterRelationship, AutoHostility, ...)
│ │ ├── Diplomacy/ (DiplomacyManager, DiplomacyState)
│ │ ├── UI/ (IRelationshipUI, RelationshipViewBase, ...)
│ │ └── VisualScripting/
│ │ ├── Instructions/ (~23 files)
│ │ ├── Conditions/ (~13 files)
│ │ └── Events/ (~9 files)
│ ├── Editor/
│ │ ├── Relationships/ (RelationshipDefinitionEditor, FactionEditor)
│ │ ├── Events/ (RelationshipEventListenerEditor)
│ │ └── Windows/ (RelationshipManagerWindow)
│ └── Tests/
│ └── Runtime/
│ ├── Subsystem/ (Unit tests per subsystem)
│ └── Integration/ (GC2 integration tests)
└── (Your project files)Verify Installation
Test that everything works correctly:
- Create a new empty scene
- Create empty GameObject → Add Component:
Relationship Manager - Check Inspector — component should show Settings, Logging, Decay, and Pending Queue headers
- Open Relationship Editor window:
Window → Relationship System → Relationship Editor - Window should open successfully with 5 tabs
Troubleshooting
Component not found in Add Component menu
Wait for Unity to finish compiling (check bottom-right spinner). If still missing, check Console for compilation errors and ensure GC2 Core is installed.
Compilation errors after import
Ensure Game Creator 2 Core is installed and up to date. The Relationship System depends on GC2's base classes for Instructions, Conditions, and Events.
Entity ID migration warning
Select the CharacterRelationship component in the Inspector and set the ID Mode to "Manual" with a stable identifier, or use "AssetBased" with an EntityIdAsset for prefab entities.