Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/youichi-uda/rmmz-dev-tools

VS Code extension for RPG Maker MZ plugin development — annotation highlighting, IntelliSense, validation, debugging, and 28 features for MZ plugin developers
https://github.com/youichi-uda/rmmz-dev-tools

game-development javascript plugin-development rmmz rpg-maker rpg-maker-mz typescript vscode-extension

Last synced: 18 days ago
JSON representation

VS Code extension for RPG Maker MZ plugin development — annotation highlighting, IntelliSense, validation, debugging, and 28 features for MZ plugin developers

Awesome Lists containing this project

README 

          
[English](README.md)



# RMMZ Dev Tools — RPGツクールMZプラグイン開発用 VS Code 拡張機能



RPGツクールMZプラグイン開発者のための、初の本格的なVS Code拡張機能です。無料14機能 + Pro 17機能で、アノテーション補完、テストプレイデバッグ、競合検出、TypeScriptワークフローなどをカバーします。



> 2010年代のJavaScript開発のような環境でMZプラグインを書くのはもう終わり。シンタックスハイライト、バリデーション、IntelliSense、デバッグ環境 — すべてMZのプラグインアノテーションシステムに特化して設計されています。



[![VS Marketplace](https://img.shields.io/visual-studio-marketplace/v/abyo-software.rmmz-dev-tools)](https://marketplace.visualstudio.com/items?itemName=abyo-software.rmmz-dev-tools)

[![Discord](https://img.shields.io/discord/1234567890?label=Discord)](https://discord.gg/CDFmWGkfDC)



## なぜ RMMZ Dev Tools？



RPGツクールMZのプラグイン開発には、ほとんど専用ツールが存在しませんでした。既存の拡張機能はメンテナンス終了済み、MV専用、またはスニペットのみ。この拡張機能は完全な開発環境を提供します：



- **高速に書く** — アノテーション補完、@type候補、プラグインテンプレート

- **バグを早期発見** — リアルタイムバリデーション、競合検出、素材参照チェック

- **デバッグを楽に** — ワンクリックデバッガー設定、変数編集、ライブゲームプレビュー

- **プロジェクトを把握** — 依存関係グラフ、クラス階層、データベースブラウザ



## 無料機能（14個）



### アノテーション支援



| 機能 | 説明 |

|------|------|

| **シンタックスハイライト** | `/*:`, `/*:ja`, `/*~struct~` ブロックをカラーコード表示。スコープタグ、型タグ、依存タグ、メタデータを色分け |

| **スマートタグ補完** | コンテキスト対応の `@tag` 補完。`@param` 内: `@text`, `@desc`, `@type`, `@min` 等。トップレベル: `@param`, `@command`, `@base` 等 |

| **@type 補完** | MZの24種以上の型値（`string`, `actor`, `struct<>`, `switch[]` 等）を説明付きで表示 |

| **バリデーション** | タイプミス検出（`@commnd`）、不正な型（`@type numbre`）、スコープ違反（`@command` 内の `@min`）、`@plugindesc` 不足 |

| **ホバードキュメント** | `@tag` や `@type` にホバーすると説明を表示 |

| **フォーマッター** | アノテーションブロック内のタグを正規順序に並べ替え |

| **カラープロバイダー** | `@default` タグ内の16進カラーにインラインカラーピッカーを表示 |



### プロジェクトツール



| 機能 | 説明 |

|------|------|

| **プラグイン競合検出** | 同一プロトタイプメソッドを複数プラグインが上書きしていることを静的解析で検出。CodeLensで警告表示 |

| **素材参照チェック** | `@dir` と `@require` タグをプロジェクトファイルと照合。不足素材を検出 |

| **IntelliSense セットアップ** | ワンクリックで `jsconfig.json` を生成。`$gameParty`, `Window_Base` 等の補完を有効化 |

| **プラグインテンプレート** | 正しいアノテーションブロックとボイラープレートコード付きの新規プラグインを生成 |

| **クイックアクションパネル** | 全コマンドをサイドバーパネルに整理して表示 |

| **データベースブラウザ** | アクター、アイテム、武器など全データベースファイルをサイドバーツリーで閲覧 |

| **ノートタグインデックス** | `data/*.json` をスキャンしてプロジェクト内の全ノートタグを一覧表示 |



## Pro機能（17個）— $12 買い切り



Gumroadライセンスキーで有効化。サブスクリプション不要。オフラインで動作。



### TypeScript ワークフロー（v1.1.0 新機能）



| 機能 | 説明 |

|------|------|

| **TypeScript セットアップ** | ワンクリックで `tsconfig.json`、`ts/plugins/`、RMMZ型定義（72+クラス、250+インターフェース）をセットアップ。`$gameParty`, `Window_Base`, `Scene_Map` 等の完全なIntelliSenseが有効に。 |

| **TypeScript 自動ビルド** | ファイル監視で `ts/plugins/*.ts` → `js/plugins/*.js` を保存時に自動コンパイル。ステータスバーにビルド状態を表示。エラーはProblemsパネルに表示。`.ts` 削除時に対応する `.js`/`.js.map` も自動削除。 |

| **TypeScript テンプレート＆スニペット** | プラグインテンプレートウィザードがTypeScript出力に対応。TS専用スニペット5種（`this:` 型付き `rmmz-alias`、`rmmz-command`、`rmmz-plugin` 等）。デバッガーはソースマップ対応で `.ts` にブレークポイント設定可能。 |



### テストプレイ＆デバッグ



| 機能 | 説明 |

|------|------|

| **デバッガーセットアップ** | ワンクリックで `launch.json` を生成。VS Code内蔵JSデバッガを使用。F5で起動、ブレークポイント、ステップ実行、**Variablesパネルで変数編集**。デバッグポート自動修復。 |

| **クイックシーンリロード** | プラグインを保存 → 現在のシーンが新しいコードでリロード。タイトルからの再起動不要。 |

| **ライブゲームプレビュー** | 実行中のゲームのスクリーンショットをVS Codeウェブビューにリアルタイム表示 |

| **テストプレイコンソール** | ゲーム内のconsole.log/warn/errorをVS Codeに取り込み |

| **ゲーム状態インスペクター** | マップ、パーティ、所持金、スイッチ、変数をサイドバーにライブ表示。自動更新対応 |



### コード分析＆リファクタリング



| 機能 | 説明 |

|------|------|

| **アノテーションプレビュー** | RPGツクールのプラグインマネージャでの表示をライブウェブビューで確認 |

| **依存関係グラフ** | `@base`/`@orderAfter`/`@orderBefore` をインタラクティブに可視化。循環依存を検出。 |

| **パラメータリネーム** | `@param`/`@arg` タグのリネーム — `@parent` 参照やコード内の `parameters["name"]` も自動更新 |

| **多言語同期チェック** | `/*:` と `/*:ja` ブロックの構造一致を検証。不一致をCodeLensで警告。 |



### データ＆プロジェクト管理



| 機能 | 説明 |

|------|------|

| **データホバー（Pro）** | `$dataActors[3]` にホバー → アクター名/ステータス表示。`$gameVariables.value(5)` → 変数名表示 |

| **計算式評価** | ダメージ/回復計算式にホバー → 評価結果をインライン表示 |

| **ノートタグエディター** | アクター、職業、アイテム、敵キャラのノートタグをビジュアルWYSIWYGエディターで編集 |

| **クラス階層ブラウザ** | RMMZクラス継承ツリーを検索可能なサイドバーで表示 — Scene, Window, Sprite, Gameオブジェクト |

| **プラグインレジストリ** | プラグインの更新チェックと互換性情報の表示 |



## ゲームのリリース前に



> **重要:** ゲームを配布する前に、コマンドパレット（またはサイドバー）から `RMMZ: リリース準備` を実行してください。`package.json` からデバッグポート（`--remote-debugging-port`）を削除し、プレイヤーにデバッグ用エンドポイントが公開されるのを防ぎます。



## はじめに



1. [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=abyo-software.rmmz-dev-tools) からインストール

2. VS Code で RPGツクールMZ のプロジェクトフォルダを開く

3. `js/plugins/` または `data/System.json` を検出すると自動的に有効化



### クイックスタートコマンド



| コマンド | 説明 |

|---------|------|

| `RMMZ: Setup IntelliSense` | コアスクリプト補完用の `jsconfig.json` を生成 |

| `RMMZ: Setup Debugger` | F5デバッグ用の `launch.json` を生成 |

| `RMMZ: New Plugin` | 新規プラグインファイルを生成（JS / TS 選択可） |

| `RMMZ: Setup TypeScript` | TypeScriptプラグイン開発環境をセットアップ（Pro） |

| `RMMZ: Activate Pro License` | Gumroadライセンスキーを入力 |



## 動作要件



- VS Code 1.75.0以上

- RPGツクールMZプロジェクト（`js/plugins/` と `data/` ディレクトリを含む）



## Proライセンス



[Gumroad](https://y1uda.gumroad.com/l/rmmz?wanted=true) で $12〜 の買い切りライセンスを購入できます。



- 買い切り、サブスクリプションなし

- 有効化後はオフラインで動作

- 17個の追加機能が即座にアンロック



## サポート



- [Discord](https://discord.gg/CDFmWGkfDC)

- [GitHub Issues](https://github.com/youichi-uda/rmmz-dev-tools/issues)



## ライセンス



本拡張機能はプロプライエタリソフトウェアです。無料機能は制限なく使用できます。Pro機能にはライセンスキーが必要です。詳細は [LICENSE.md](LICENSE.md) をご覧ください。