Installation Detailed

Complete installation guide for ChatAI Plugin.

Prerequisites

Dependency	Version	Check Command
Node.js	≥ 18.0	node -v
pnpm	≥ 8.0	pnpm -v
Yunzai-Bot	V3	-
Build Tools	Latest	See below

Step 1: Clone Repository

HTTPS

cd Yunzai-Bot
git clone https://github.com/XxxXTeam/chatai-plugin.git ./plugins/chatai-plugin

SSH

cd Yunzai-Bot
git clone git@github.com:XxxXTeam/chatai-plugin.git ./plugins/chatai-plugin

Step 2: Install Dependencies

pnpm install

Step 3: Build Native Module

pnpm rebuild better-sqlite3

Build Tools Required

Install build tools if rebuild fails:

Windows

npm install -g windows-build-tools

Linux

sudo apt install build-essential python3

macOS

xcode-select --install

Step 4: Start

pnpm start

Verify Installation

Send to bot:

#ai状态

Success

If you see plugin version and status info, installation is complete!

Directory Structure

plugins/chatai-plugin/
├── apps/           # Yunzai plugin modules
├── config/         # Configuration
├── data/           # Runtime data
├── src/            # Source code
│   ├── core/       # Core layer
│   ├── mcp/        # MCP system
│   └── services/   # Service layer
├── frontend/       # Web panel source
└── resources/      # Static resources

Next Steps

• Quick Start - Basic setup
• Basic Config - Configuration options
• Troubleshooting - Common issues