🚀 VRChat MCP OSC
VRChat MCP OSC 通过 Model Context Protocol (MCP) 搭建了 AI 助手与 VRChat 之间的桥梁，实现基于人工智能的虚拟化身控制和交互，为虚拟现实环境提供支持。它能让 AI 助手在 VRChat 中精准控制虚拟角色，实现多样化交互，极大丰富了虚拟现实体验。
🚀 快速开始
VRChat MCP OSC 借助 Open Sound Control (OSC) 与 VRChat 进行通信，允许如 Claude 等 AI 助手控制角色参数与表情、发送消息以及执行其他交互操作。
✨ 主要特性
- AI 驱动的虚拟化身控制：通过 MCP 协议实现 AI 对虚拟角色的精细控制。
- 多平台兼容性：支持不同设备和 VR 系统，确保广泛兼容。
- 高效的通信机制：利用 OSC 实现低延迟、高效率的数据传输。
📦 安装指南
系统要求
- Node.js 18 或更高版本
- 具备 OSC 支持的 VRChat
- 配备 MCP 实现的 Claude Desktop
命令行配置
# 创建并导航至项目目录
mkdir -p vrchat-mcp-osc
cd vrchat-mcp-osc
# 克隆仓库
git clone https://github.com/Krekun/vrchat-mcp-osc.git .
# 安装依赖项
pnpm install
# 构建项目
pnpm build
# 启动服务
npm start
📚 详细文档
参数配置
基本参数
--port # 监听端口，默认值为 3000
--host # 监听地址，默认为 localhost
--debug # 启用调试模式
高级选项
--max_connections # 最大连接数，默认为 100
--timeout # 闲置超时时间，单位秒，默认为 3600
功能模块
核心组件
- MCP 服务器：负责处理来自 AI 的指令和数据。
- WebSocket 中继：实现 WebSocket 到 OSC 的协议转换。
- 类型定义：提供统一的 TypeScript 接口规范。
工具集
- 日志记录与监控：实时跟踪系统运行状态。
- 性能优化工具：提升通信效率和稳定性。
项目架构
vrchat-mcp-osc/
├── packages/
│ ├── mcp-server/ # MCP 协议实现的主入口
│ ├── relay-server/ # WebSocket 到 OSC 的协议转换器
│ ├── types/ # 共享的 TypeScript 接口定义
│ └── utils/ # 常用工具函数
└── pnpm-workspace.yaml # 工作区配置文件
开发指南
源码构建
# 克隆仓库
git clone https://github.com/Krekun/vrchat-mcp-osc.git
# 安装依赖项
pnpm install
# 构建所有包
pnpm -r build
# 开发模式启动
pnpm -r dev
📄 许可证
VRChat MCP OSC 采用双授权许可：
- 非商业用途：遵循 MIT 许可证，详情参见 MIT 许可证文件。
- 商业用途：需另行获取商业许可证。
通过本软件的 MIT 许可证用于非商业目的，您须遵守该许可条款。商业用户必须获得相应的商业授权。
致谢
感谢以下团队与项目的贡献：
- VRChat 团队为 OSC 集成所做的工作
- Model Context Protocol 提供标准化 AI 接口
- Anthropic 对 Claude 的 MCP 实现