Documentation

Everything you need to build persistent game worlds with MistScale, from identities and relationships to your first AI Character.

Getting Started

World Primitives

AI Characters

World Knowledge

Using the Platform

Creating an NPC

Open your Project, go to NPCs, click Create NPC, and fill three layers: Identity, Cognitive, Knowledge. Save, and the NPC is immediately usable in the Playground.

Editing & Deleting

The NPC editor is the same surface used for creation. Open the NPC, change any field across Identity, Cognitive, or Knowledge, and save. The next conversation reflects the changes. Deletion removes identity, knowledge, and memories and cannot be undone.

Knowledge Files

Open the NPC editor's Knowledge layer to upload text or files (up to 3 per NPC). Each file passes through pending → processing → ready before the NPC uses it. Delete from the file list to remove both the original and all indexed chunks.

Using the Playground

Open a Project's Playground, pick an NPC from the sidebar, type a message, and watch the right-hand inspector show the NPC's emotion, mood, thinking trace, and newly formed memories update live.

Project Settings

Open the Project from the Dashboard, go to Settings in the project navigation, edit the name or other options, and save. Changes propagate to every NPC and Playground session inside the project.

Invites & Team

Open a Project's Settings, go to Members, and invite a collaborator by email. They accept from their Pending invites page and get access to that Project.

Account Settings

Open Settings from the dashboard navigation to update your display name, email, or password. Account settings are scoped to you personally, not to a Project.

Usage & Billing

Two dashboard pages handle it. Usage breaks down consumption by Project and NPC, while Billing shows your plan, payment, and invoices. Plan upgrades take effect immediately; usage figures may lag real-time activity by a few minutes.

Integrations

Unreal Overview

What the Mistscale Unreal plugin gives you and how the pieces fit together.

Installation & Setup

Drop the Mistscale plugin into your Unreal project and configure the subsystem.

Your First NPC

List your NPCs, connect to one, and stream a reply, in C++ and Blueprint.

Voice

Stream captured audio to an NPC and play back its spoken reply.

Spatial Context in Unreal

Make NPCs react to where they are: location, time of day, and weather from your game state.

Unity Overview

What the Mistscale Unity SDK gives you and how the pieces fit together.

Installation & Login

Add the Mistscale package to Unity, authenticate with your API key, and browse your NPCs in the editor.

Your First NPC

Put a talking Mistscale NPC in your scene with one component and a few lines of code.

Voice Conversations

Push-to-talk NPC conversations with voice detection and automatic reply playback.

Spatial Context in Unity

Make NPCs react to where they are: location, time of day, and weather from your game state.

Godot Overview

What the Mistscale Godot addon gives you and how the pieces fit together.

Installation & Setup

Copy the Mistscale addon into your Godot project and configure the singleton.

Your First NPC

List your NPCs, connect to one, and stream a reply.

Voice

Stream captured audio to an NPC and play back its spoken reply.

Spatial Context in Godot

Make NPCs react to where they are: location, time of day, and weather from your game state.

Web SDK Overview

What the Mistscale Web SDK gives you and how the pieces fit together.

Installation & Setup

Install the Mistscale Web SDK and create your first client.

Your First NPC

List your NPCs, connect to one, and stream a reply — in about fifteen lines.

Voice

Stream captured audio to an NPC and play back its spoken reply.

Spatial Context in the Web SDK

Make NPCs react to where they are: location, time of day, and weather from your game state.

REST & WebSocket API

Integrate directly over HTTP and WebSocket, without installing any SDK.

Reference