Skip to content

Commit 5680c61

Browse files
CoderGamesterCoderGamester
committed
Added simplefied chinese and japanese readme files for international users
1 parent 762b38c commit 5680c61

File tree

3 files changed

+554
-1
lines changed

3 files changed

+554
-1
lines changed

‎README-ja.md‎

Lines changed: 271 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,271 @@
1+
# MCP Unity エディター (ゲームエンジン)
2+
3+
[![](https://badge.mcpx.dev?status=on 'MCP 有効')](https://modelcontextprotocol.io/introduction)
4+
[![](https://img.shields.io/badge/Unity-000000?style=flat&logo=unity&logoColor=white 'Unity')](https://unity.com/releases/editor/archive)
5+
[![](https://img.shields.io/badge/Node.js-339933?style=flat&logo=nodedotjs&logoColor=white 'Node.js')](https://nodejs.org/en/download/)
6+
7+
[![smithery badge](https://smithery.ai/badge/@CoderGamester/mcp-unity)](https://smithery.ai/server/@CoderGamester/mcp-unity)
8+
[![](https://img.shields.io/github/stars/CoderGamester/mcp-unity 'Stars')](https://github.com/CoderGamester/mcp-unity/stargazers)
9+
[![](https://img.shields.io/github/last-commit/CoderGamester/mcp-unity 'Last Commit')](https://github.com/CoderGamester/mcp-unity/commits/main)
10+
[![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
11+
12+
| [English](README.md) | [🇨🇳简体中文](README_zh-CN.md) | [🇯🇵日本語](README-ja.md) |
13+
|----------------------|---------------------------------|----------------------|
14+
15+
```
16+
,/(/. *(/,
17+
*/(((((/. *((((((*.
18+
.*((((((((((/. *((((((((((/.
19+
./((((((((((((((/ *((((((((((((((/,
20+
,/(((((((((((((/*. */(((((((((((((/*.
21+
,%%#((/((((((* ,/(((((/(#&@@(
22+
,%%##%%##((((((/*. ,/((((/(#&@@@@@@(
23+
,%%######%%##((/(((/*. .*/(((//(%@@@@@@@@@@@(
24+
,%%####%#(%%#%%##((/((((((((//#&@@@@@@&@@@@@@@@(
25+
,%%####%( /#%#%%%##(//(#@@@@@@@%, #@@@@@@@(
26+
,%%####%( *#%###%@@@@@@( #@@@@@@@(
27+
,%%####%( #%#%@@@@, #@@@@@@@(
28+
,%%##%%%( #%#%@@@@, #@@@@@@@(
29+
,%%%#* #%#%@@@@, *%@@@(
30+
., ,/##*. #%#%@@@@, ./&@#* *`
31+
,/#%#####%%#/, #%#%@@@@, ,/&@@@@@@@@@&\.
32+
`*#########%%%%###%@@@@@@@@@@@@@@@@@@&*´
33+
`*%%###########%@@@@@@@@@@@@@@&*´
34+
`*%%%######%@@@@@@@@@@&*´
35+
`*#%%##%@@@@@&*´
36+
`*%#%@&*´
37+
38+
███╗ ███╗ ██████╗██████╗ ██╗ ██╗███╗ ██╗██╗████████╗██╗ ██╗
39+
████╗ ████║██╔════╝██╔══██╗ ██║ ██║████╗ ██║██║╚══██╔══╝╚██╗ ██╔╝
40+
██╔████╔██║██║ ██████╔╝ ██║ ██║██╔██╗ ██║██║ ██║ ╚████╔╝
41+
██║╚██╔╝██║██║ ██╔═══╝ ██║ ██║██║╚██╗██║██║ ██║ ╚██╔╝
42+
██║ ╚═╝ ██║╚██████╗██║ ╚██████╔╝██║ ╚████║██║ ██║ ██║
43+
╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═╝
44+
```
45+
46+
MCP Unityは、Unityエディター向けのModel Context Protocolの実装であり、AIアシスタントがUnityプロジェクトと対話できるようにします。このパッケージは、UnityとMCPプロトコルを実装するNode.jsサーバー間のブリッジを提供し、Claude、Windsurf、CursorなどのAIエージェントがUnityエディター内で操作を実行できるようにします。
47+
48+
## 機能
49+
50+
<a href="https://glama.ai/mcp/servers/@CoderGamester/mcp-unity">
51+
<img width="400" height="200" src="https://glama.ai/mcp/servers/@CoderGamester/mcp-unity/badge" alt="Unity MCPサーバー" />
52+
</a>
53+
54+
### IDE統合 - パッケージキャッシュアクセス
55+
56+
MCP Unityは、Unityの`Library/PackedCache`フォルダーをワークスペースに追加することで、VSCode系IDE（Visual Studio Code、Cursor、Windsurf）との自動統合を提供します。この機能により：
57+
58+
- Unityパッケージのコードインテリジェンスが向上
59+
- Unityパッケージのより良いオートコンプリートと型情報が有効化
60+
- AIコーディングアシスタントがプロジェクトの依存関係を理解するのに役立つ
61+
62+
### MCPサーバーツール
63+
64+
- `execute_menu_item`: Unityメニュー項目（MenuItem属性でタグ付けされた関数）を実行
65+
> **例:** "新しい空のGameObjectを作成するためにメニュー項目'GameObject/Create Empty'を実行"
66+
67+
- `select_gameobject`: パスまたはインスタンスIDでUnity階層内のゲームオブジェクトを選択
68+
> **例:** "シーン内のMain Cameraオブジェクトを選択"
69+
70+
- `update_component`: GameObject上のコンポーネントフィールドを更新、またはGameObjectに含まれていない場合は追加
71+
> **例:** "PlayerオブジェクトにRigidbodyコンポーネントを追加し、その質量を5に設定"
72+
73+
- `add_package`: Unityパッケージマネージャーに新しいパッケージをインストール
74+
> **例:** "プロジェクトにTextMeshProパッケージを追加"
75+
76+
- `run_tests`: Unityテストランナーを使用してテストを実行
77+
> **例:** "プロジェクト内のすべてのEditModeテストを実行"
78+
79+
- `notify_message`: Unityエディターにメッセージを表示
80+
> **例:** "タスクが完了したことをUnityに通知"
81+
82+
- `add_asset_to_scene`: AssetDatabaseからアセットをUnityシーンに追加
83+
> **例:** "プロジェクトからPlayerプレハブを現在のシーンに追加"
84+
85+
### MCPサーバーリソース
86+
87+
- `unity://menu-items`: `execute_menu_item`ツールを容易にするために、Unityエディターで利用可能なすべてのメニュー項目のリストを取得
88+
> **例:** "GameObject作成に関連する利用可能なすべてのメニュー項目を表示"
89+
90+
- `unity://hierarchy`: Unity階層内のすべてのゲームオブジェクトのリストを取得
91+
> **例:** "現在のシーンの階層構造を表示"
92+
93+
- `unity://gameobject/{id}`: シーン階層内のインスタンスIDまたはオブジェクトパスで特定のGameObjectに関する詳細情報を取得
94+
> **例:** "Player GameObjectに関する詳細情報を取得"
95+
96+
- `unity://logs`: Unityコンソールからのすべてのログのリストを取得
97+
> **例:** "Unityコンソールからの最近のエラーメッセージを表示"
98+
99+
- `unity://packages`: Unityパッケージマネージャーからインストール済みおよび利用可能なパッケージに関する情報を取得
100+
> **例:** "Unityプロジェクトに現在インストールされているすべてのパッケージをリスト"
101+
102+
- `unity://assets`: Unityアセットデータベース内のアセットに関する情報を取得
103+
> **例:** "プロジェクト内のすべてのテクスチャアセットを検索"
104+
105+
- `unity://tests/{testMode}`: Unityテストランナー内のテストに関する情報を取得
106+
> **例:** "Unityプロジェクトで利用可能なすべてのテストをリスト"
107+
108+
## 要件
109+
- Unity 2022.3以降 - [サーバーをインストール](#install-server)するため
110+
- Node.js 18以降 - [サーバーを起動](#start-server)するため
111+
- npm 9以降 - [サーバーをデバッグ](#debug-server)するため
112+
113+
## <a name="install-server"></a>インストール
114+
115+
このMCP Unityサーバーのインストールは複数ステップのプロセスです：
116+
117+
### ステップ1: Unityパッケージマネージャー経由でUnity MCPサーバーパッケージをインストール
118+
1. Unityパッケージマネージャーを開く（Window > Package Manager）
119+
2. 左上隅の"+"ボタンをクリック
120+
3. "Add package from git URL..."を選択
121+
4. 入力: `https://github.com/CoderGamester/mcp-unity.git`
122+
5. "Add"をクリック
123+
124+
![package manager](https://github.com/user-attachments/assets/a72bfca4-ae52-48e7-a876-e99c701b0497)
125+
126+
127+
### ステップ2: Node.jsをインストール
128+
> MCP Unityサーバーを実行するには、コンピューターにNode.js 18以降がインストールされている必要があります：
129+
130+
<details>
131+
<summary><span style="font-size: 1.1em; font-weight: bold;">Windows</span></summary>
132+
133+
1. [Node.jsダウンロードページ](https://nodejs.org/en/download/)にアクセス
134+
2. LTSバージョンのWindowsインストーラー（.msi）をダウンロード（推奨）
135+
3. インストーラーを実行し、インストールウィザードに従う
136+
4. PowerShellを開いて以下を実行してインストールを確認：
137+
```bash
138+
node --version
139+
```
140+
</details>
141+
142+
<details>
143+
<summary><span style="font-size: 1.1em; font-weight: bold;">macOS</span></summary>
144+
145+
1. [Node.jsダウンロードページ](https://nodejs.org/en/download/)にアクセス
146+
2. LTSバージョンのmacOSインストーラー（.pkg）をダウンロード（推奨）
147+
3. インストーラーを実行し、インストールウィザードに従う
148+
4. または、Homebrewがインストールされている場合は以下を実行：
149+
```bash
150+
brew install node@18
151+
```
152+
5. ターミナルを開いて以下を実行してインストールを確認：
153+
```bash
154+
node --version
155+
```
156+
</details>
157+
158+
### ステップ3: AI LLMクライアントを設定
159+
160+
<details open>
161+
<summary><span style="font-size: 1.1em; font-weight: bold;">オプション1: Unityエディターを使用して設定</span></summary>
162+
163+
1. Unityエディターを開く
164+
2. Tools > MCP Unity > Server Windowに移動
165+
3. 以下の画像のようにAI LLMクライアントの"Configure"ボタンをクリック
166+
167+
![image](https://github.com/user-attachments/assets/8d286e83-da60-40fa-bd6c-5de9a77c1820)
168+
169+
4. 表示されるポップアップで設定インストールを確認
170+
171+
![image](https://github.com/user-attachments/assets/b1f05d33-3694-4256-a57b-8556005021ba)
172+
173+
</details>
174+
175+
<details>
176+
<summary><span style="font-size: 1.1em; font-weight: bold;">オプション2: Smithery経由で設定</span></summary>
177+
178+
[Smithery](https://smithery.ai/server/@CoderGamester/mcp-unity)経由でMCP Unityをインストール：
179+
180+
```
181+
現在利用不可
182+
```
183+
</details>
184+
185+
<details>
186+
<summary><span style="font-size: 1.1em; font-weight: bold;">オプション3: 手動設定</span></summary>
187+
188+
AIクライアントのMCP設定ファイル（例：Claude Desktopのclaude_desktop_config.json）を開き、以下のテキストをコピー：
189+
190+
> `ABSOLUTE/PATH/TO`をMCP Unityインストールの絶対パスに置き換えるか、UnityエディターMCPサーバーウィンドウ（Tools > MCP Unity > Server Window）からテキストをコピー
191+
192+
```json
193+
{
194+
"mcpServers": {
195+
"mcp-unity": {
196+
"command": "node",
197+
"args": [
198+
"ABSOLUTE/PATH/TO/mcp-unity/Server/build/index.js"
199+
],
200+
"env": {
201+
"UNITY_PORT": "8090"
202+
}
203+
}
204+
```
205+
206+
</details>
207+
208+
## <a name="start-server"></a>サーバーの起動
209+
210+
MCP Unityサーバーを起動するには2つの方法があります：
211+
212+
### オプション1: Unityエディター経由で起動
213+
1. Unityエディターを開く
214+
2. Tools > MCP Unity > Server Windowに移動
215+
3. "Start Server"ボタンをクリック
216+
217+
### オプション2: コマンドラインから起動
218+
1. ターミナルまたはコマンドプロンプトを開く
219+
2. MCP Unityサーバーディレクトリに移動
220+
3. 以下のコマンドを実行：
221+
```bash
222+
node Server/build/index.js
223+
```
224+
225+
## <a name="debug-server"></a>サーバーのデバッグ
226+
227+
MCP Unityサーバーをデバッグするには、以下の方法を使用できます：
228+
229+
### オプション1: Unityエディターを使用してデバッグ
230+
1. Unityエディターを開く
231+
2. Tools > MCP Unity > Server Windowに移動
232+
3. "Debug Server"ボタンをクリック
233+
234+
### オプション2: コマンドラインを使用してデバッグ
235+
1. ターミナルまたはコマンドプロンプトを開く
236+
2. MCP Unityサーバーディレクトリに移動
237+
3. 以下のコマンドを実行：
238+
```bash
239+
npm run debug
240+
```
241+
242+
## トラブルシューティング
243+
244+
### <a name="common-issues"></a>よくある問題
245+
246+
#### サーバーが起動しない
247+
248+
- Node.js 18以降がインストールされていることを確認
249+
- npm 9以降がインストールされていることを確認
250+
- MCP Unityサーバーディレクトリが正しいことを確認
251+
252+
#### メニュー項目が実行されない
253+
254+
- メニュー項目のパスが正しいことを確認（大文字小文字を区別）
255+
- メニュー項目が確認を必要とするかどうかを確認
256+
- メニュー項目が現在のコンテキストで利用可能であることを確認
257+
258+
## 貢献
259+
260+
貢献は大歓迎です！詳細については[貢献ガイド](CONTRIBUTING.md)をお読みください。
261+
262+
## ライセンス
263+
264+
このプロジェクトはMITライセンスの下でライセンスされています - 詳細は[LICENSE](LICENSE)ファイルを参照してください。
265+
266+
## 謝辞
267+
268+
- [Model Context Protocol](https://modelcontextprotocol.io)
269+
- [Unity Technologies](https://unity.com)
270+
- [Node.js](https://nodejs.org)
271+
- [WebSocket-Sharp](https://github.com/sta/websocket-sharp)

‎README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66

77
[![smithery badge](https://smithery.ai/badge/@CoderGamester/mcp-unity)](https://smithery.ai/server/@CoderGamester/mcp-unity)
88
[![](https://img.shields.io/github/stars/CoderGamester/mcp-unity 'Stars')](https://github.com/CoderGamester/mcp-unity/stargazers)
9-
[![](https://img.shields.io/github/forks/CoderGamester/mcp-unity 'Forks')](https://github.com/CoderGamester/mcp-unity/network/members)
109
[![](https://img.shields.io/github/last-commit/CoderGamester/mcp-unity 'Last Commit')](https://github.com/CoderGamester/mcp-unity/commits/main)
1110
[![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
1211

12+
| [English](README.md) | [🇨🇳简体中文](README_zh-CN.md) | [🇯🇵日本語](README-ja.md) |
13+
|----------------------|---------------------------------|----------------------|
14+
1315
```
1416
,/(/. *(/,
1517
*/(((((/. *((((((*.
@@ -356,3 +358,10 @@ Contributions are welcome! Please feel free to submit a Pull Request or open an
356358
## License
357359

358360
This project is under [MIT License](License.md)
361+
362+
## Acknowledgements
363+
364+
- [Model Context Protocol](https://modelcontextprotocol.io)
365+
- [Unity Technologies](https://unity.com)
366+
- [Node.js](https://nodejs.org)
367+
- [WebSocket-Sharp](https://github.com/sta/websocket-sharp)

0 commit comments

Comments
 (0)