プラグインの使用

プラグインの有効化

このため、すべてのプロジェクトでプラグインの実行はデフォルトで無効になっています。Views > Pluginsで「このプロジェクトのプラグインを有効にする」をチェックしてプラグインを有効にします。

信頼できるプロジェクトに対してのみプラグインを有効にしてください。プロジェクトを移動したり名前を変更した場合は、再度プラグインを有効にする必要があります。

プラグインのインストール

プラグインをインストールする方法は2つあります。プロジェクト依存関係を通じて、またはpluginsフォルダ内にファイルとしてインストールする方法です。インストール後、Views > Pluginsを開き、プロジェクトごとに有効/無効を設定します。

NPMを通じて

プラグインはNodeパッケージマネージャー（NPM）でインストールできます。以下のコマンドでプラグインをインストールします：

1npm i --save-dev @wonderlandengine/not-a-real-plugin

@wonderlandengine/not-a-real-pluginをインストールしたい任意のプラグインに置き換えてください。このコマンドを実行すると、package.jsonファイルのdevDependenciesセクションに新しいエントリが作成されます。

その後、プラグインはPluginsビューに表示されます。

プラグインの管理

UIの散らかりを減らしたり、エディタのパフォーマンスを回復させるためにプラグインを無効にしたい場合があります。

Views > Pluginsを開いて、すべての利用可能なプラグインを確認し、管理します：

プロジェクトに対してプラグインを有効にするために上部のチェックボックス「このプロジェクトのプラグインを有効にする」を使用します。
タブを使って「エディタスコープ」（エディタ自体を拡張するプラグイン）と「プロジェクトスコープ」（devDependenciesやplugins/フォルダを通じてプロジェクトがインストールしたプラグイン）を切り替えます。
チェックボックスで個々のプラグインをオン/オフに切り替えます。変更は即座に有効になりますが、一部のプラグインはプロジェクトの再読み込みを要求する場合があります。

開発

プラグインの作成は簡単です。以下の3つの方法があります：

プラグインスクリプト

単一のスクリプトで、メインプロジェクトのpackage.jsonと依存関係を共有できます。プラグイン関連の依存関係はdevDependenciesとしてインストールすることをお勧めします（--save-devを使用）。

プロジェクトのルートにpluginsフォルダを作成し、右クリックしてNew Pluginを選択すると新しいプラグインを作成できます。

プロジェクトルートに@wonderlandengine/editor-apiパッケージをインストールしてください：

1npm i --save-dev @wonderlandengine/editor-api

プラグインディレクトリ

Plugin Scriptと同様に、最初にpluginsサブフォルダを作成し、次にプラグインに応じて名前を付けたサブフォルダをさらに作成します。

このフォルダ内で新しいpackage.jsonファイルを作成できます（例：npm initを使用）。

そのディレクトリに@wonderlandengine/editor-apiパッケージをインストールしてください：

1npm i --save @wonderlandengine/editor-api

注意：--save-devではなく--saveを使用します。これはWonderland Engineプロジェクトではなく、別のプラグインプロジェクトにインストールしているためです。

プラグインパッケージ

プラグインを共有および配布したい場合は、別のフォルダでnpm initを行い、package.jsonに"wonderlandengine"キーを追加します：

 1{
 2    // ...
 3    "wonderlandengine": {
 4        "plugins": [
 5            {
 6                "name": "My Plugin A",
 7                "main": "src/plugin-a.mjs"
 8            },
 9            {
10                "name": "My Plugin B",
11                "main": "src/plugin-b.mjs"
12            }
13        ]
14    },
15    // ...
16}

そのディレクトリに@wonderlandengine/editor-apiパッケージをインストールしてください：

1npm i --save-peer @wonderlandengine/editor-api

このローカルプラグインをプロジェクトで使用するには、npm i --save-dev <path-to-the-directory>を使用するか、準備ができたら公開してパッケージを経由してインストールする方法があります。詳しくはInstallingを参照してください。