快速开始

准备工作

使用AITuberKit需要以下软件：

• Node.js: 24.x
• npm: ^11.6.2

安装步骤

1. 克隆仓库

git clone https://github.com/tegnike/aituber-kit.git
cd aituber-kit

2. 安装依赖包

npm install

3. 设置环境变量（可选）

如有需要，将.env.example文件复制为.env并设置环境变量。

cp .env.example .env

INFO

环境变量中设置的值优先级低于在设置界面输入的值。

启动开发服务器

npm run dev

在浏览器中打开http://localhost:3000即可开始使用AITuberKit。

使用启动脚本启动

如果您不熟悉命令行，可以使用双击即可启动的启动脚本：

• Windows: 双击 LAUNCH.bat
• macOS: 双击 LAUNCH.command

启动脚本会自动执行依赖安装和开发服务器的启动。

使用Docker启动

如果您有Docker环境，也可以使用Docker Compose来启动应用程序。

# 准备环境变量文件
cp .env.example .env

# 使用Docker Compose启动
docker compose up

构建和启动完成后，在浏览器中打开http://localhost:3000。

TIP

Docker Compose启用了热重载功能。源代码的更改会实时反映。

画面说明

• 左上に齿轮图标的设置按钮，可以进行AI角色和语音相关的各种设置
• 设置按钮右侧的对话日志按钮，点击后可以显示与角色的对话历史（可拖动调整宽度）
• 画面中央显示角色，可以拖动调整大小和位置
• 画面下部有麦克风图标的输入框，可以进行文本输入或语音输入与角色对话
• 点击发送按钮（右向箭头）或按Enter键发送消息

基本使用方法

与AI角色互动

1. 在设置界面输入所选LLM的API密钥
2. 可选择编辑角色的设定提示
3. 上传角色的VRM文件、Live2D文件或PNGTuber图片，以及背景文件
4. 选择语音合成引擎并调整声音设置
5. 通过输入表单开始与角色对话

AITuber直播

1. 在设置界面打开Youtube模式
2. 输入Youtube API密钥和Youtube Live ID
3. 其他设置与"与AI角色互动"类似
4. 开始Youtube直播，确认角色能够响应评论
5. 打开对话持续模式，使AI在没有评论时也能主动发言

下一步

• 在基本设置中进行详细设置
• 在角色设置中自定义AI角色
• 在AI设置中调整AI行为
• 在语音设置中配置语音合成
• 在音声入力设置中配置音声输入
• 在Youtube设置中设置AITuber直播
• 在幻灯片设置中配置幻灯片模式
• 在图片设置中配置图片上传和放置