🚀 VRChat 机器人开发文档
这是一个用于开发 VRChat 机器人的开源项目。借助该项目，开发者能够创建自定义机器人，实现诸如自动回复、用户管理等各类功能。
🚀 快速开始
安装依赖
npm install
构建项目
npm run build
运行机器人
node dist/index.js
📦 安装指南
环境变量配置
在运行机器人之前，请确保设置以下环境变量：
VRCHAT_APP_ID：你的应用 IDVRCHAT_APP_SECRET_KEY：你的应用密钥
💻 使用示例
与 Claude Desktop 集成
为了方便调试，你可以将机器人与 Claude Desktop 集成。通过这种方式，你可以在图形界面中查看和控制机器人。
📚 详细文档
VRChat API 端点列表
以下是 VRChat 提供的主要 API 端点及其功能说明：
用户管理
| API 端点 | 功能 |
|---|---|
POST /api/users |
创建新用户 |
GET /api/users/{id} |
获取指定用户的详细信息 |
PUT /api/users/{id} |
更新指定用户的信息 |
DELETE /api/users/{id} |
删除指定用户 |
群组管理
| API 端点 | 功能 |
|---|---|
POST /api/groups |
创建新群组 |
GET /api/groups |
列出所有群组 |
GET /api/groups/{id} |
获取指定群组的详细信息 |
PUT /api/groups/{id} |
更新指定群组的信息 |
DELETE /api/groups/{id} |
删除指定群组 |
消息管理
| API 端点 | 功能 |
|---|---|
POST /api/messages |
发送新消息 |
GET /api/messages |
列出所有消息 |
GET /api/messages/{id} |
获取指定消息的详细信息 |
DELETE /api/messages/{id} |
删除指定消息 |
🔧 技术细节
调试指南
安装调试工具
npm install -g @modelcontextprotocol/inspector
启动调试模式
npx @modelcontextprotocol/inspector "node dist/index.js"
访问控制台
打开浏览器，访问工具提供的 URL 地址。
发布指南
更新版本号
- 补丁版本：
npm version patch - 小版本：
npm version minor - 主版本：
npm version major
构建并发布
npm run build && npm publish
提交代码
git add .
git commit -m "更新至新版本"
git push origin main
贡献指南
欢迎任何人的贡献！请按照以下步骤进行：
克隆仓库
git clone https://github.com/your-repository.git
cd your-repository
创建功能分支
git checkout -b feature/新功能名称 main
提交代码
git add .
git commit -m "实现新功能"
git push origin feature/新功能名称
创建 Pull Request
在 GitHub 上发起合并请求，等待审核。
📄 许可证
本项目遵循 MIT 许可证。请查看 LICENSE 文件以获取详细信息。