User Guides Index

Navigation hub for AI Assistant user documentation.

---

Reading Order by Role

First-Time Users

Start here if you're new to the AI Assistant:

1. User-Guide-01-Getting-Started (~10 min)

   • What the AI Assistant is and does
   • Prerequisites and setup
   • Your first working assistant

2. User-Guide-04-Troubleshooting (reference)

   • Bookmark for when things go wrong
   • Common problems and solutions

Game Developers

For developers customizing assistant behavior:

1. User-Guide-01-Getting-Started - Setup basics
2. User-Guide-02-Configuration-and-Customization (~15 min)
   • Configuration layers
   • Memory systems
   • LLM provider options
3. Configuration-Reference - All settings

Advanced Developers

For building sophisticated AI systems:

1. User-Guide-02-Configuration-and-Customization - Foundation
2. User-Guide-03-Advanced-Capabilities (~20 min)
   • Multi-agent systems
   • Custom tools
   • RAG integration
3. Architecture-Overview - System design

Operations / DevOps

For running assistants in production:

1. User-Guide-01-Getting-Started - Basic setup
2. User-Guide-04-Troubleshooting - Problem solving
3. Architecture-Resilience-System - Circuit breakers
4. Architecture-Safety-System - Emergency stop

---

Document Summary

Guide	Audience	Topics
Getting Started	Beginners	Setup, first assistant, basic usage
Configuration	Intermediate	Settings, memory, providers
Advanced	Advanced	Sub-agents, tools, RAG
Troubleshooting	All	Problems and solutions

---

Prerequisites Chain

Getting Started ─────────────────────┐
                                     │
Configuration and Customization ─────┤
                                     │
           ┌─────────────────────────┘
           │
           ▼
Advanced Capabilities
           │
           ▼
Architecture Documentation

Getting Started is the only document with no prerequisites.

Configuration and Customization assumes you've completed Getting Started.

Advanced Capabilities assumes familiarity with configuration concepts.

Architecture Documentation provides deep technical detail for any level.

---

Quick Links

Commands

Command	Purpose
aisetup/init <name>	Create assistant
aisetup/start <name>	Start assistant
aisetup/stop <name>	Stop assistant
aisetup <name>	Check status
aisetup/config <name>	View configuration
aihistory <name>	View history
<name> <message>	Send message

Configuration

Task	Command
Set LLM provider	aisetup/config mybot set llm_provider openrouter
Set API key	aisetup/config mybot set llm_auth_token sk-...
Set model	aisetup/config mybot set llm_model openai/gpt-4o-mini
Change tick rate	aisetup/config mybot set tick_rate 10
Enable multi-action	aisetup/config mybot set multi_action_enabled true
Clear emergency stop	aisetup/reset mybot

Troubleshooting

Symptom	Solution
Not responding	Check aisetup mybot for status
Emergency stopped	aisetup/reset mybot
Rate limited	Increase tick rate or upgrade API tier
Auth error	Verify llm_auth_token is correct

---

Related Documentation

Architecture (Technical)

• Architecture-Overview - Five-layer design
• Architecture-Core-Engine - Tick loop, ReAct
• Architecture-Tool-System - Tool categories
• Architecture-Memory-and-Sleep - Memory tiers

Data Flows (Execution)

• Data-Flow-02-ReAct-Loop - Multi-action execution
• Data-Flow-05-Entity-Profile-System - Entity memory
• Data-Flow-07-Sleep-Mode-Transitions - Sleep phases

Reference

• Configuration-Reference - All configurable attributes
• Research-Foundations - Academic influences

---

Last updated: 2025-12-09