Skip to content
Merged
Changes from 1 commit
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
Next Next commit
fix(docs): remove remaining pnpm references from README.ja.md
Complete the pnpm to npm migration by removing all pnpm references
from the Japanese README. This fixes the incomplete migration in PR #104.

Changes:
- Remove pnpm from requirements section
- Replace all pnpm install commands with npm ci
- Remove pnpm-specific build approval instructions
- Update Docker/Linux container instructions
- Update all environment-specific setup instructions

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
  • Loading branch information
akiojin and claude committed Nov 18, 2025
commit 95fef1e1f24590f7757ae8709dd2b4203a577f4d
15 changes: 7 additions & 8 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ sequenceDiagram
```

## セットアップ
- 対応バージョン: Unity 2020.3 LTS以降 / Node.js 18.x・20.x・22.x LTS(23 以上のメジャーバージョンでは起動を拒否) / pnpm(Corepack経由で提供)
- 対応バージョン: Unity 2020.3 LTS以降 / Node.js 18.x・20.x・22.x LTS(23 以上のメジャーバージョンでは起動を拒否)
- 推奨は Node.js 20.x または 22.x(`better-sqlite3` の prebuilt バイナリが利用可能)。Node 18.x も動作しますが、23 以上は起動時に拒否されます。
- MCPクライアント: Claude Desktop など

Expand All @@ -195,33 +195,32 @@ sequenceDiagram

ネイティブ拡張(`better-sqlite3` など)は **MCPサーバーを動かすOS上で依存関係をインストールしたとき** にのみ正しく構築されます。以下を必ず実施してください。

- **基本ルール**: `.mcp.json` で `"command": "node"`(例: `node bin/unity-mcp-server serve`)を使う場合は、MCPサーバーを動かすマシン/コンテナ内で本パッケージが展開されているディレクトリで `pnpm install`(または `pnpm install --frozen-lockfile`)を実行してから MCP クライアントを起動します。
- **pnpmでのビルド許可**: pnpm v10以降は依存のインストールスクリプトを許可制にしています。`better-sqlite3` がビルドできるよう、初回セットアップ時に `pnpm approve-builds better-sqlite3` を実行し、対話メニューで承認してください。citeturn1view0
- **基本ルール**: `.mcp.json` で `"command": "node"`(例: `node bin/unity-mcp-server serve`)を使う場合は、MCPサーバーを動かすマシン/コンテナ内で本パッケージが展開されているディレクトリで `npm ci` を実行してから MCP クライアントを起動します。

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Fix npm ci path in workspace setup instructions

README.ja.md:198 now tells users to run npm ci from the mcp-server package directory, but this workspace only has package-lock.json at the repo root. Running npm ci inside mcp-server fails with npm ERR! ENOLOCK, so the documented setup steps for Windows/WSL/macOS and the Docker fallback will break. Update the instructions to run the install from the workspace root (e.g., npm ci --workspace=mcp-server in the repo root) or otherwise point users at the correct path.

Useful? React with 👍 / 👎.

- **`npx` 実行**: README の例(`npx @akiojin/unity-mcp-server@latest`)は起動時に依存をダウンロードします。サポート対象の Node.js(18.x / 20.x / 22.x)では追加作業なしで利用できます。Node.js 23 以上はサポート外であり、サーバー起動時に拒否されます。
- **`node_modules` の共有禁止**: Windows と Linux/macOS など異なるOS間で `node_modules` を共有するとネイティブバイナリが一致せず動作しません。

環境別の注意点:

- **Windows (PowerShell / コマンドプロンプト)**
- Node.js 20.x または 22.x LTS(18.x も利用可)を利用してください。23 以上のメジャーバージョンはサポート外です。
- パッケージが配置されているディレクトリ(リポジトリを clone した場合: `C:\path\to\unity-mcp-server\mcp-server`)で `pnpm install --frozen-lockfile` を実行します。
- パッケージが配置されているディレクトリ(リポジトリを clone した場合: `C:\path\to\unity-mcp-server\mcp-server`)で `npm ci` を実行します。
- `.mcp.json` で `node` を指す場合でも、依存を入れた後であれば `npx` に切り替えても構いません。

- **Windows Subsystem for Linux (WSL)**
- リポジトリは Linux ファイルシステム上(例: `/home/<user>/unity-mcp-server`)に配置してください。
- Node.js 20.x または 22.x(18.x も利用可)を WSL 内に導入します。
- パッケージが展開されているディレクトリ(リポジトリ clone 時: `/home/<user>/unity-mcp-server/mcp-server`)で `pnpm install --frozen-lockfile` を実行します。
- パッケージが展開されているディレクトリ(リポジトリ clone 時: `/home/<user>/unity-mcp-server/mcp-server`)で `npm ci` を実行します。

- **Docker / Linux コンテナ**
- Node.js 20.x または 22.x(18.x も利用可)ベースのイメージを使用してください。23 以上のメジャーバージョンは起動時に拒否されます。
- イメージ構築時に `pnpm install --filter mcp-server --frozen-lockfile`(またはパッケージ展開ディレクトリで `pnpm install --frozen-lockfile`)を実行し、コンテナ内にプラットフォーム適合済みの依存を用意します。
- イメージ構築時に `npm ci --workspace=mcp-server`(またはパッケージ展開ディレクトリで `npm ci`)を実行し、コンテナ内にプラットフォーム適合済みの依存を用意します。
- ホスト側の `node_modules` を bind mount しないでください。

- **macOS**
- `brew install node@22` または `node@20` などで Node.js 22.x / 20.x を導入し、`PATH` に追加します(18.x も利用可)。23 以上のメジャーバージョンはサポートしません。
- パッケージが配置されているディレクトリ(リポジトリ clone 時: `~/unity-mcp-server/mcp-server`)で `pnpm install --frozen-lockfile` を実行します。
- パッケージが配置されているディレクトリ(リポジトリ clone 時: `~/unity-mcp-server/mcp-server`)で `npm ci` を実行します。

セットアップ後、`node mcp-server/bin/unity-mcp-server --version` で起動確認ができます。`better-sqlite3` の読み込みエラーが出る場合は、対象環境内で依存を再インストールするか、ツールチェーンが揃った状態で `pnpm rebuild better-sqlite3 --filter mcp-server --build-from-source` を実行してください。
セットアップ後、`node mcp-server/bin/unity-mcp-server --version` で起動確認ができます。`better-sqlite3` の読み込みエラーが出る場合は、対象環境内で依存を再インストールするか、ツールチェーンが揃った状態で `npm rebuild better-sqlite3 --workspace=mcp-server` を実行してください。

## 使い方ワークフロー

Expand Down
Loading