Installation

This guide covers installing Wayfinder in your Unity project and setting up the required scene structure.

Requirements

• Unity 2021.3 LTS or later
• TextMeshPro (imported automatically by Unity)
• 2D Tilemap package (usually included in Unity)

Installation Steps

1. Import Wayfinder Package

Wayfinder is distributed as a Unity package. Import it into your project:

1. Download the Wayfinder package
2. Open your Unity project
3. Assets > Import Package > Custom Package
4. Select the Wayfinder .unitypackage file
5. Click Import in the Import dialog

2. Verify Installation

After importing, you should see:

Assets/
└── Wayfinder/
    ├── Scripts/
    │   ├── AI/
    │   ├── Combat/
    │   ├── Map Components/
    │   ├── Managers/
    │   ├── State Machines/
    │   └── ...
    ├── ScriptableObjects/
    │   ├── Scripts & Templates/
    │   └── Enums/
    └── Prefabs/ (if included)

3. Layer Setup

Wayfinder uses Unity layers for raycasting. Create these layers:

1. Edit > Project Settings > Tags and Layers
2. Add these layers:
   • Tile - for grid tiles
   • Unit - for battle units
   • UI - for battle UI elements

4. Create Battle Scene

Create a new scene for your first battle:

1. File > New Scene (use 2D template)
2. Save as Assets/Scenes/Battle.unity

Scene Setup

Required Components

Every battle scene needs these core components:

1. Battle Manager

Create an empty GameObject named Battle Manager with these components:

• BattleStateManager - Controls battle flow
• CombatCalculator - Handles damage calculations
• AIManager - Manages AI decision-making

Battle Manager (GameObject)
├── BattleStateManager
├── CombatCalculator
└── AIManager

2. Tilemap Setup

Create the grid tilemap:

1. Right-click in Hierarchy > 2D Object > Tilemap > Rectangular
2. This creates a Grid GameObject with Tilemap child
3. Add TileManager component to a new GameObject

Grid (GameObject)
└── Tilemap (GameObject)
    ├── Tilemap component
    └── TilemapRenderer component

Tile Manager (GameObject)
└── TileManager component

3. UI Manager

Create an empty GameObject named UI Manager:

• Add UIStateManager component
• This handles battle UI state changes

4. Input Manager

Create an empty GameObject named Input Manager:

• Add InputStateManager component
• This handles player input during battle

Configuration Assets

Wayfinder uses ScriptableObject assets for configuration. Create these in your project:

Combat Configuration

Right-click in Project > Create > Wayfinder > Combat > Combat Configuration

This defines damage formulas, hit chance, and combat modifiers.

Example values:

Base Hit Chance: 0.90 (90%)
Min Hit Chance: 0.10
Max Hit Chance: 0.99
Defense Formula: Percentage
Strength Scaling: 2.0
Intelligence Scaling: 2.5

Assign to CombatCalculator > Config in the inspector.

AI Configuration

Right-click in Project > Create > Wayfinder > Configuration > AI

This defines all AI scoring values and behavior parameters.

Assign to AIManager > Config in the inspector.

Debug Configuration

Right-click in Project > Create > Wayfinder > Debug > Debug Configuration

Controls which debug logs are shown (AI, Combat, State Machine, etc.).

Inspector Setup

BattleStateManager

In Battle Manager GameObject:

1. Assign Tile Manager reference
2. Assign UI State Manager reference
3. Assign Battle Cursor Controller (if you have one)
4. Leave Units list empty for now (we’ll add units in Getting Started)

CombatCalculator

Assign your Combat Configuration asset to the Config field.

AIManager

Assign your AI Configuration asset to the Config field.

TileManager

1. Assign Tilemap reference (the Tilemap component)
2. Assign TilemapRenderer reference
3. Assign Tile Prefab (provided in Wayfinder package)
4. Create an empty GameObject named Tiles - assign as container

Verify Setup

Press Play. You should see these in the Console:

• No critical errors
• Warning: “No units assigned” (expected - we’ll add units next)

If you see errors, check the error messages - Wayfinder provides detailed setup guidance.

Next Steps

Your battle scene is now configured! Continue to Getting Started to create your first tactical battle.