Vrchat OSC

🚀 VRChat MCP OSC 中文版

VRChat MCP OSC 藉助 Model Context Protocol (MCP)，在 AI 助手和 VRChat 之間搭建了一座橋樑，實現了基於人工智能的頭像控制以及虛擬現實環境中的交互，讓用戶在 VRChat 中擁有更智能、更豐富的體驗。

🚀 快速開始

VRChat MCP OSC 利用 OSC（開放聲音控制）與 VRChat 進行通信。它允許像 Claude 這樣的 AI 助手，通過 MCP 提供的高級別 API，實現控制頭像參數和表情、向 VRChat 聊天框發送消息、響應各種 VR 事件等功能。

✨ 主要特性

• 頭像控制：能夠靈活調節頭像的參數與表情，讓頭像展現出豐富的情感和姿態。
• 運動控制：可以指揮頭像進行移動和改變方向，使頭像在虛擬世界中自由行動。
• 通信功能：方便地向 VRChat 聊天框發送消息，實現與其他用戶的交流。
• 菜單訪問：輕鬆切換 VRChat 的菜單及界面元素，提升操作的便捷性。
• 頭像信息：支持查詢頭像的屬性和參數，讓用戶更好地瞭解和管理頭像。
• 無縫集成：可以自動檢測頭像配置，確保系統與頭像的完美適配。

📦 安裝指南

安裝依賴

# 克隆倉庫
git clone https://github.com/Krekun/vrchat-mcp-osc
cd vrchat-mcp-osc

# 創建 npm 鏈接
npm link packages/mcp-server
npm link packages/relay-server

修改配置文件

複製 config.json 到項目根目錄，並根據需求調整以下參數：

{
  "mcpPort": 12345,
  "wsPort": 12346,
  "debugMode": true
}

💻 使用示例

啟動 MCP 服務器

啟動 MCP 服務器並指定自定義端口：

node index.js --mcp-port 12345 --ws-port 12346

📚 詳細文檔

命令行選項

參數說明

• --mcp-port：MCP 服務器監聽端口，缺省值為 12345。
• --ws-port：WebSocket 相關服務端口，默認是 12346。
• --debug：啟用調試模式，提供詳細日誌輸出。

可用工具

以下是 AI 助手可用的 MCP 工具及其描述：

故障排除

常見問題

• 無法連接到 VRChat：檢查 OSC 支持是否開啟，確認目標地址和端口正確。
• MCP 服務未響應：確保 Node.js 版本符合要求，並且所有依賴已安裝。

項目結構

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
cd vrchat-mcp-osc

# 安裝依賴項
pnpm install

# 構建所有包
pnpm -r build

# 開發模式運行
pnpm -r dev

📄 許可證

VRChat MCP OSC 採用雙許可協議：

• 非商業用途：按照 MIT 許可證使用、修改和分發軟件。
• 商業用途：商業用途需獲得單獨的商業許可證。

通過非商業用途下的 MIT 許可證使用本軟件，您需遵守該許可條款。商業用戶必須獲取相應的商業許可。

致謝

感謝以下團隊與協議：

• VRChat 團隊為 OSC 集成
• Model Context Protocol 提供標準化 AI 接口
• Anthropic 實現 Claude 的 MCP 技術