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: Open the Welcome Window

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

Click Open Control Panel to configure your API keys.

Step 3: Configure the Control Panel

The Control Panel (Window > LoreMind > Control Panel) is where you configure the SDK.

Editor API Key

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

1. Go to loremind.peekgames.dev 
2. Navigate to Projects > Your Project > API Keys
3. Create an Editor Key (or use existing)
4. Copy the key (starts with sk_editor_)
5. Paste it in the Control Panel

Server API Key (for Editor Testing)

For testing NPC interactions in the Editor, you need a Server API Key:

1. In the dashboard, create a Server Key (starts with sk_server_)
2. Copy and paste it in the Control Panel

Note: This key is stored locally in Unity’s EditorPrefs and is never included in builds. For production, you’ll configure a backend URL instead. See Backend Integration.

Click Save when done.

Step 4: 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:

• 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

”Invalid API key”

• Editor keys start with sk_editor_
• Server keys start with sk_server_
• Make sure you copied the full key

Control Panel won’t open

Try reimporting the SDK package or restarting Unity.

Next Steps

Your SDK is ready. Now build your first NPC:

• Getting Started - Build a talking NPC
• Backend Integration - Prepare for production