Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ venv/

# Build artifacts
*.log

# Claude Code
.claude/
28 changes: 28 additions & 0 deletions SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,34 @@ bash auto_setup.sh --path unity # Force Unity Official MCP
- `--force` / `-Force` — Remove existing config before re-adding
- `--timeout <ms>` / `-Timeout <ms>` — Custom timeout (default: 720000)

### Verify Prerequisites

Before running setup (or when troubleshooting), use the verification scripts to
check that all required tools are installed and configured:

**macOS / Linux:**

```bash
bash verify_setup.sh
```

**Windows (PowerShell):**

```powershell
.\verify_setup.ps1
```

These scripts check:

- **Claude Code** is installed and reachable
- **Git** is available (Windows only — required for Claude Code)
- **Python >= 3.11** is installed (required for Coplay MCP / Path B)
- **uvx** is installed (required for Coplay MCP / Path B)
- **Unity relay binary** exists at `~/.unity/relay` (required for Unity Official MCP / Path A)
- **Configured MCP servers** via `claude mcp list`

Each check reports PASS, WARN, or FAIL with actionable install instructions.

### Path A vs Path B

| | Path A — Unity Official MCP | Path B — Coplay MCP |
Expand Down
113 changes: 81 additions & 32 deletions i18n/ja/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,51 @@

# unity-claude-code-skill

Unity Editor を MCP(Model Context Protocol)経由で Claude Code に接続するための **Claude Code カスタムスキル** です。
Claude Code を Unity AI 開発アシスタントに変える **Claude Code カスタムスキル** です
— ワンクリック MCP セットアップ、自動診断、自然言語による直接的な
Unity Editor 操作をサポートします。

> **Claude Code スキルとは?**
> スキルとは、関連するタスクが発生した際に Claude Code が自動的に読み込む、ファイルシステムベースの指示セットです。`SKILL.md` ファイルと、オプションのスクリプトや参照資料を含むフォルダとして構成されます。詳細は
> スキルとは、関連するタスクが発生した際に Claude Code が自動的に読み込む、
> ファイルシステムベースの指示セットです。`SKILL.md` ファイルと、オプションの
> スクリプトや参照資料を含むフォルダとして構成されます。詳細は
> [Claude Code Custom Skills ドキュメント](https://code.claude.com/docs/en/skills)
> をご覧ください。

## このスキルの機能

ユーザーが Claude Code と Unity の接続に関する質問をすると、このスキルが以下の手順をステップバイステップでガイドします:
| 機能 | 説明 |
|---------|-------------|
| **ワンクリックセットアップ** | 自動セットアップスクリプトが1つのコマンドで MCP を設定 |
| **自動診断** | 接続の問題を検出し、修正を提案 |
| **Unity 操作** | MCP ツールを使った Unity 制御のテンプレートとワークフロー |
| **ラピッドプロトタイピング** | 一般的なゲームタイプのステップバイステップワークフロー |
| **スクリプト生成** | PlayerController、GameManager、UI などの C# テンプレート |

- **Path A – Unity Official MCP**(`com.unity.ai.assistant`)— Unity 6+ 向け
- **Path B – Coplay MCP**(コミュニティ)— Unity 2022+ 向け
### サポートされる MCP パス

**Windows** と **macOS** の両方について、インストール、設定、接続の承認、動作確認、トラブルシューティングをカバーしています。
- **Path A — Unity Official MCP**(`com.unity.ai.assistant`)— Unity 6+ 向け
- **Path B — Coplay MCP**(コミュニティ)— Unity 2022+ 向け

## リポジトリ構成

```text
unity-claude-code-skill/
├── SKILL.md # コアスキル指示(Claude Code が自動読み込み)
├── SKILL.md # コアスキル: セットアップ + 操作 + ワークフロー
├── README.md # このファイル
├── LICENSE # MIT
├── scripts/
│ ├── verify_setup.sh # macOS/Linux 前提条件チェッカー
│ └── verify_setup.ps1 # Windows 前提条件チェッカー
└── references/
└── troubleshooting.md # よくある問題と解決策
├── auto_setup.sh # ワンクリック MCP セットアップ (macOS/Linux)
├── auto_setup.ps1 # ワンクリック MCP セットアップ (Windows)
├── unity_operations.md # 詳細な MCP ツールリファレンス & コードテンプレート
├── verify_setup.sh # 前提条件チェッカー (macOS/Linux)
├── verify_setup.ps1 # 前提条件チェッカー (Windows)
├── troubleshooting.md # よくある問題と解決策
├── .github/workflows/ci.yml # CI: マークダウンリント、shellcheck、リンクチェック
└── i18n/ # 翻訳
├── ko/ # 한국어 (Korean)
├── ja/ # 日本語 (Japanese)
├── zh-TW/ # 繁體中文 (Traditional Chinese)
└── zh-CN/ # 简体中文 (Simplified Chinese)
```

## クイックインストール
Expand All @@ -38,11 +55,11 @@ unity-claude-code-skill/

```bash
# ユーザーレベルのスキル(すべてのプロジェクトで利用可能)
git clone https://github.com/<your-username>/unity-claude-code-skill.git \
git clone https://github.com/ryan-focus/unity-claude-code-skill.git \
~/.claude/skills/unity-claude-code-setup

# またはプロジェクトレベルのスキル(このプロジェクトのみで利用可能)
git clone https://github.com/<your-username>/unity-claude-code-skill.git \
git clone https://github.com/ryan-focus/unity-claude-code-skill.git \
.claude/skills/unity-claude-code-setup
```

Expand All @@ -53,35 +70,65 @@ git clone https://github.com/<your-username>/unity-claude-code-skill.git \
```bash
mkdir -p ~/.claude/skills/unity-claude-code-setup
curl -o ~/.claude/skills/unity-claude-code-setup/SKILL.md \
https://raw.githubusercontent.com/<your-username>/unity-claude-code-skill/main/SKILL.md
https://raw.githubusercontent.com/ryan-focus/unity-claude-code-skill/main/SKILL.md
```

## ワンクリック MCP セットアップ

スキルのインストール後、自動セットアップスクリプトを実行して MCP
接続を設定します:

**macOS / Linux:**

```bash
cd ~/.claude/skills/unity-claude-code-setup
bash auto_setup.sh --auto # 最適なパスを自動検出
bash auto_setup.sh --path coplay # Coplay MCP を強制指定
bash auto_setup.sh --path unity # Unity Official MCP を強制指定
```

**Windows (PowerShell):**

```powershell
cd "$env:USERPROFILE\.claude\skills\unity-claude-code-setup"
.\auto_setup.ps1 -Auto # 最適なパスを自動検出
.\auto_setup.ps1 -Path coplay # Coplay MCP を強制指定
.\auto_setup.ps1 -Path unity # Unity Official MCP を強制指定
```

**オプション:**

- `--force` / `-Force` — 既存の MCP 設定を削除してから再追加
- `--timeout <ms>` / `-Timeout <ms>` — カスタムタイムアウト(デフォルト: 720000ms)
- `--coplay-version <ver>` / `-CoplayVersion <ver>` — Coplay サーバーバージョン

## 使い方

インストール後は、Claude Code に自然に話しかけるだけです:
インストールして接続が完了したら、Claude Code に自然に話しかけるだけです:

**セットアップ:**

- *「Claude Code と Unity の連携を設定して」*
- *「Unity プロジェクトを MCP 経由で Claude Code に接続したい」*
- *「Unity 用の Coplay MCP をインストールするには?」*
- *「Windows で Unity MCP をセットアップして」*

Claude Code がこのスキルを自動的に読み込み、手順を案内します。

### 検証スクリプトの実行
**操作:**

セットアップ後、すべてが正しく配置されているか確認できます:
- *「GameLevel という新しいシーンを作って」*
- *「位置 (0, 2, 0) に赤いキューブを追加して」*
- *「WASD 移動の PlayerController スクリプトを作成して」*
- *「標準的なプロジェクトフォルダ構成をセットアップして」*
- *「Unity コンソールのエラーを確認して」*

**macOS/Linux:**
**ラピッドプロトタイピング:**

```bash
bash ~/.claude/skills/unity-claude-code-setup/scripts/verify_setup.sh
```
- *「ボール転がしゲームのプロトタイプを作って」*
- *「基本的な 2D プラットフォーマーを作って」*
- *「メインメニュー UI システムを構築して」*

**Windows (PowerShell):**
**診断:**

```powershell
. "$env:USERPROFILE\.claude\skills\unity-claude-code-setup\scripts\verify_setup.ps1"
```
- *「MCP 接続がうまくいかない、修正して」*
- *「Unity のセットアップを診断して」*

## 前提条件

Expand All @@ -90,7 +137,7 @@ bash ~/.claude/skills/unity-claude-code-setup/scripts/verify_setup.sh
| Claude Code | 両方のパス | `curl -fsSL https://claude.ai/install.sh \| bash`(macOS/Linux)または `irm https://claude.ai/install.ps1 \| iex`(Windows) |
| Unity 6+ | Path A | [unity.com](https://unity.com/download) |
| Unity 2022+ | Path B | [unity.com](https://unity.com/download) |
| Python 3.11 | Path B のみ | [python.org](https://www.python.org/downloads/) |
| Python >= 3.11 | Path B のみ | [python.org](https://www.python.org/downloads/) |
| Git for Windows | Windows のみ | [git-scm.com](https://git-scm.com/download/win) |

## 主要リソース
Expand All @@ -102,7 +149,9 @@ bash ~/.claude/skills/unity-claude-code-setup/scripts/verify_setup.sh

## コントリビューション

プルリクエスト歓迎です! 手順が古くなっている箇所を見つけたり、Linux や他の MCP クライアント(Cursor、Windsurf など)のサポートを追加したい場合は、Issue を作成するかプルリクエストを送ってください。
プルリクエスト歓迎です!手順が古くなっている箇所を見つけたり、Linux や
他の MCP クライアント(Cursor、Windsurf など)のサポートを追加したい場合は、
Issue を作成するかプルリクエストを送ってください。

## ライセンス

Expand Down
Loading
Loading