Installation

Get the LoreMind Unity SDK running in your project.

Requirements

• Unity 2021.3 or later
• A LoreMind account - Sign up at loremind.peekgames.dev  (includes free starter credits)

Step 1: Import the SDK

Download the LoreMind Unity SDK from the Unity Asset Store and import it into your project.

After importing, you’ll see these folders:

• Assets/LoreMind/Scripts/ - Core SDK
• Assets/LoreMind/Examples/ - Sample scenes
• Assets/LoreMind/Settings/ - Configuration

Step 2: Run the Setup Wizard

A Welcome window should appear automatically. If not, open it via Window > LoreMind > Welcome.

Click Open Setup Wizard to configure:

Authentication Mode

Start with Direct Client - you can switch later.

Project ID

1. Go to the LoreMind Dashboard 
2. Navigate to Project Settings
3. Copy your Project ID
4. Paste it in the wizard

Editor API Key

Your Editor API Key lets Unity fetch your Entity Minds from the dashboard.

1. In the dashboard, go to API Keys
2. Create an Editor Key (or use existing)
3. Copy the key (starts with sk_editor_)
4. Paste it in the wizard

Click Finish Setup when done.

Step 3: Create Your First Entity Mind

Before your NPCs can talk, they need a personality. Create one in the dashboard:

1. Go to loremind.peekgames.dev 
2. Navigate to Entity Minds > Create
3. Fill in:
   • Name: Test NPC
   • Personality: Friendly and helpful. Eager to answer questions.
4. Click Create

See Entity Minds documentation for detailed configuration.

Verify Installation

Open the Control Panel (Window > LoreMind > Control Panel) and check:

• Project ID shows your project name
• Entity Minds dropdown shows your NPCs
• Credits remaining shows your balance

Troubleshooting

Welcome window doesn’t appear

Open it manually: Window > LoreMind > Welcome

Entity Mind dropdown is empty

1. Check your Editor API Key is set (starts with sk_editor_)
2. Verify internet connection
3. Click the Refresh button next to the dropdown
4. Ensure you’ve created at least one Entity Mind in the dashboard

”Project ID not configured”

Open Window > LoreMind > Control Panel and paste your Project ID from the dashboard.

”Invalid API key”

• Editor keys start with sk_editor_
• Server keys start with sk_server_ (don’t use these in the Unity Editor)
• Make sure you copied the full key

Next Steps

Your SDK is ready. Now build your first NPC:

• Getting Started - Build a talking NPC in 10 minutes