Editor Tools

Editor Tools

The AI NPC Brain package includes several editor-only tools and custom inspectors that automate common setup tasks. All tools are under the Tools > AI NPC Brain menu.

NPC Animation Setup

Menu: Tools > AI NPC Brain > NPC Animation Setup
Script: Editor/NpcAnimationSetupWindow.cs

The full animation pipeline tool. This is the recommended way to set up NPC animations.

What It Does

1. Scans an AnimatorController for Trigger parameters
2. Creates AnimTriggerBinding entries in your NpcAnimationMap asset
3. Auto-generates semantic animId values (lowercased trigger names)
4. Suggests usageHint text so the LLM knows when to use each animation
5. Assigns moodTag categories for filtering and prompt logic
6. Syncs allowed anim_id values into the NpcEventCatalog
7. Syncs default move_id values into the catalog

How to Use

1. Open Tools > AI NPC Brain > NPC Animation Setup.
2. Assign your three assets:
3. Animator Controller — the controller with trigger parameters
4. NPC Animation Map — the map asset to fill
5. NPC Event Catalog — the catalog to sync allowed values into
6. Configure options:
7. Overwrite existing map entries — replaces entries that already exist
8. Overwrite existing usage hints / mood tags — updates hints even if they were manually edited
9. Convert animId to lowercase — Wave becomes wave (recommended)
10. Sort animation map entries — alphabetical ordering
11. Run the steps in order, or click Do Everything to run all three:
12. Step 1: Scan Animator -> Fill Animation Map — reads triggers, creates bindings
13. Step 2: Sync anim.trigger Allowed Values -> Event Catalog — copies all animId values into the anim.trigger event's allowed values
14. Step 3: Sync Default move_id Allowed Values -> Event Catalog — writes default movement IDs into anim.move_to

Default Movement IDs

Step 3 writes these movement IDs into the catalog:

Usage Hint Auto-Generation

The tool suggests usage hints based on trigger name keywords:

Mood Tag Auto-Assignment

Animation Map Auto-Fill

Menu: Tools > AI NPC Brain > Animation Map Auto-Fill
Script: Editor/NpcAnimationMapAutoFillWindow.cs

A simpler version of the NPC Animation Setup tool. Only does Step 1 (scan triggers and fill the animation map). Does not sync to the catalog.

How to Use

1. Open Tools > AI NPC Brain > Animation Map Auto-Fill.
2. Assign:
3. Animator Controller — the controller to scan
4. NpcAnimationMap — the map to fill
5. Options:
6. Overwrite existing entries — replaces entries with the same animator trigger
7. Use lowercase animId — converts trigger names to lowercase
8. Click Add Trigger Parameters to Map.

Use Print Trigger List to Console to see what triggers exist on your controller without modifying anything.

Custom Inspector: NpcUiBindings

Script: Editor/NpcUiBindingsEditor.cs

When you select an NpcUiBindings asset, the Inspector shows two utility buttons:

Auto-Generate IDs from npcId

Fills in shopWindowId, questBoardWindowId, and relationshipWindowId from the npcId field using the pattern:

{npcId}.shop
{npcId}.quest_board
{npcId}.relationship

Example: If npcId = npc_aurelia_alchemist, clicking this button sets: - shopWindowId = npc_aurelia_alchemist.shop - questBoardWindowId = npc_aurelia_alchemist.quest_board - relationshipWindowId = npc_aurelia_alchemist.relationship

Sync Into Selected NpcEventCatalog Asset

1. Select an NpcEventCatalog asset in the Project window.
2. Click this button on the NpcUiBindings Inspector.
3. The tool writes the window IDs into the matching event arg allowedValues:
4. shop.open → shop_id allowed = shopWindowId
5. shop.sell_mode → shop_id allowed = shopWindowId
6. quest.open_board → quest_board_id allowed = questBoardWindowId

This ensures the event catalog's allowed values always match the NPC's actual window IDs.

Custom Inspector: WindowRegistryRuntime

Script: Editor/WindowRegistryRuntimeEditor.cs

When you select a GameObject with WindowRegistryRuntime, the Inspector shows these utility buttons:

Assign Window IDs to 3 Panels from NpcUiBindings

Requires uiBindings, shopPanel, questBoardPanel, and relationshipPanel to be assigned on the component.

1. Auto-generates IDs on the NpcUiBindings if autoGenerateFromNpcId is enabled.
2. Adds a WindowPanelId component to each panel (if not already present).
3. Sets the windowId on each WindowPanelId from the bindings.

Auto-Populate From Scene

Finds every WindowPanelId component in the entire scene and rebuilds the bindings list from them. Each panel's windowId becomes a binding entry.

Auto-Populate ONLY Under searchRoot

Same as above, but only searches under the searchRoot transform (or this GameObject if searchRoot is null). Useful when you have multiple NPC registries in one scene.

Close All (Editor Preview)

Deactivates every panel in the bindings list. Useful for resetting panel states while editing.

NpcCatalogSyncUtility

Script: Editor/NpcCatalogSyncUtility.cs

A static utility class used internally by the NpcUiBindingsEditor. You can also call it from your own editor scripts:

NpcCatalogSyncUtility.Sync(myBindings, myCatalog);

This writes window IDs from NpcUiBindings into the corresponding event arg allowedValues in the NpcEventCatalog.

Typical Setup Workflow

Here is the recommended order of operations when setting up a new NPC:

1. Create assets:
2. Persona Definition (set npcId, displayName, personaJson)
3. Brain Config (set provider, API key, tuning)
4. Event Catalog (add your events with arg schemas)
5. NPC Animation Map (leave empty for now)

6. NPC UI Bindings (set npcId, click Auto-Generate IDs)

7. Set up animations:

8. Open Tools > AI NPC Brain > NPC Animation Setup
9. Assign Animator Controller, Animation Map, and Event Catalog

10. Click Do Everything

11. Sync UI bindings to catalog:

12. Select your NPC UI Bindings asset
13. Select your Event Catalog asset in the Project window

14. Click Sync Into Selected NpcEventCatalog Asset

15. Set up scene panels:

16. Add WindowPanelId to each panel root, or:

17. Use the WindowRegistryRuntime Inspector to assign IDs and auto-populate

18. Wire everything in the scene:

19. Add AiNpcBrain to the NPC, assign all assets
20. Add receivers, wire OnAnyNpcEventPayload
21. Add chat UI, wire to brain
22. Press Play