DotCraft Documentation Index
Choose a document by goal. First-time users should start with Getting Started, finish Desktop, workspace, and model configuration, then move into daily use, automation, or developer integration.
First-Time Use
| Goal | Recommended doc |
|---|---|
| Download Desktop, initialize a workspace, configure API key, and run once | Getting Started |
| Use the graphical desktop client | Desktop Guide |
| Use the full terminal interface | TUI Guide |
| Configure API key, model, endpoint, and workspace overrides | Configuration Guide |
Daily Use and Troubleshooting
| Goal | Recommended doc |
|---|---|
| Inspect traces, sessions, tool calls, and visual config | Dashboard Guide |
| Understand when settings apply and what requires restart | Settings Lifecycle Guide |
| Install, enable, try, or remove DotCraft plugins | Install and Use Plugins |
| Let Agents create, patch, and maintain workspace skills | Agent Skill Self-Learning |
| Search local skills and install third-party skills from SkillHub / ClawHub | Search and Install Skills |
| Limit file, shell, network, and sandbox capability | Security Configuration |
| Configure SubAgent roles, profiles, and recursion depth | SubAgent Configuration Guide |
Automation and Workflow Extension
| Goal | Recommended doc |
|---|---|
| Local tasks, Cron choice, and human review | Automations Guide |
| Automations fields, template variables, and tools | Automations Reference |
| Lifecycle Hooks and shell extension | Hooks Guide |
| Hook events, payloads, exit codes, and examples | Hooks Reference |
| Prepare local plugin manifests and plugin-contained skills | Build Plugins |
| Use an external coding agent CLI as a subagent | External CLI Subagents Guide |
Clients and Editors
| Goal | Recommended doc |
|---|---|
| Connect JetBrains, Obsidian, Unity, and other editors | ACP Mode Guide |
| Use the Unity editor extension and scene/resource tools | Unity Integration Guide |
| Manage local workspace runtimes and visual entry points with Hub | Hub Local Management Guide |
| Run Wire Protocol service and share a workspace across clients | AppServer Mode Guide |
| Implement a local Hub client that discovers and manages workspace AppServers | Hub Protocol |
| Implement an AppServer JSON-RPC client | AppServer Protocol |
| Expose an OpenAI-compatible HTTP API | API Mode Guide |
| Connect AG-UI / CopilotKit frontends | AG-UI Mode Guide |
Bots, SDKs, and External Adapters
| Goal | Recommended doc |
|---|---|
| Choose Python or TypeScript SDK | SDK Overview |
| Build external channels with Python | Python SDK |
| Reference the Telegram Python adapter | Python Telegram Adapter |
| Build external channel modules with TypeScript | TypeScript SDK |
| Connect QQ / WeCom / Feishu / Telegram / Weixin | QQ · WeCom · Feishu · Telegram · Weixin |
Reference
| Goal | Recommended doc |
|---|---|
| See every configuration field | Full Configuration Reference |
| Read the plugin architecture, manifest, and Plugin Function design | Plugin Architecture Spec |
| Read the Hub local management protocol | Hub Protocol |
| Read the AppServer protocol developer guide | AppServer Protocol |
| See Dashboard API and trace events | Dashboard API |
| Validate features with complete examples | Samples Overview |
| Prepare a workspace template | Workspace Sample |
| Read the complete AppServer protocol spec | AppServer Protocol Spec |
Troubleshooting
Search does not find the Desktop download path
Open Getting Started or Desktop Guide.
You are unsure whether config belongs globally or in the workspace
Put API keys in global ~/.craft/config.json; put project-specific models, tools, entry points, and automation config in <workspace>/.craft/config.json.
You want to contribute docs
Docs must stay bilingual: Chinese pages live under docs/*.md; English pages live under docs/en/*.md. Chinese pages use “快速开始 / 配置 / 使用示例 / 进阶 / 故障排查”; English pages use “Quick Start / Configuration / Usage Examples / Advanced Topics / Troubleshooting”.