プラグインの使用
プラグインの有効化
このため、Project Settings > Enable plugins
でプラグインの実行を確認するまで、すべてのプロジェクトでデフォルトでプラグインの実行が無効になっています。
信頼できるプロジェクトに対してのみプラグインを有効にしてください。プロジェクトを移動したり名前を変更したりすると、再度プラグインを有効にする必要があります。
プラグインのインストール
プラグインをインストールする方法は2つあります。プロジェクトの依存関係を通じて、またはplugins
フォルダにファイルとしてインストールする方法です。
NPMを通じて
プラグインはNodeパッケージマネージャー(NPM)を通じてインストールできます。以下のコマンドでプラグインをインストールします:
1npm i --save-dev @wonderlandengine/not-a-real-plugin
@wonderlandengine/not-a-real-plugin
をインストールしたい任意のプラグインに置き換えてください。このコマンドを実行すると、package.json
ファイルのdevDependencies
セクションに新しいエントリが作成されます。
その後、プラグインはProject Settings > Plugins
に表示されます。
プラグインの管理
時々、UIの雑然さを減らしたり、エディタのパフォーマンスを回復させるためにプラグインを無効にしたいことがあります。
Project Settings > Plugins
のリストには、インストールされているプラグインと有効にできるプラグインが表示されます。
開発
プラグインの作成は簡単です。以下の3つの方法があります:
プラグインスクリプト
単一スクリプトは、メインプロジェクトのpackage.json
と依存関係を共有できます。プラグイン関連の依存関係をdevDependencies
としてインストールする(--save-dev
を使用)ことをお勧めします。
プロジェクトのルートにplugins
フォルダを作成し、右クリックしてNew Plugin
を選択すると、新しいプラグインを作成できます。
プロジェクトルートに@wonderlandengine/editor-api
パッケージをインストールしてください:
1npm i --save-dev @wonderlandengine/editor-api
プラグインディレクトリ
Plugin Scriptsと同様に、最初にplugins
サブフォルダを作成し、その後、プラグインに応じて名前を付けたサブフォルダをさらに作成します。
このフォルダ内で新しいpackage.json
ファイルを作成できます(例:npm init
を使用)。
そのディレクトリに@wonderlandengine/editor-api
パッケージをインストールしてください:
1npm i --save @wonderlandengine/editor-api
注意:--save-dev
ではなく--save
を使用します。これはWonderland Engineプロジェクトではなく、別のプラグインプロジェクトにインストールしているためです。
プラグインパッケージ
プラグインを共有および配布したい場合は、別のフォルダでnpm init
を行い、package.json
に"wonderlandengine"
キーを追加します。
そのディレクトリに@wonderlandengine/editor-api
パッケージをインストールしてください:
1npm i --save @wonderlandengine/editor-api
このローカルプラグインをプロジェクトで使用するには、npm i --save-dev <path-to-the-directory>
を使用するか、準備ができたら公開してパッケージを経由してインストールする方法があります。Installingを参照してください。