プラグイン
プラグインは、Studio に新しいツールを追加します。このページでは、プラグインの探し方とインストールの方法、そして信頼できるかどうかの判断のしかたを説明します。
プラグインでは、パネルの追加、シーンの生成、リソースの処理、オブジェクトへの新しい種類のコンポーネントの追加などができます。プラグインはエディタの中でそのまま動き、何かをビルドし直す必要はありません。
プラグインは、公開したプロジェクトにコードを持ち込むこともできます。ひとりでに動くもの、イベントの新しいトリガーとステップ、Project settings の専用のセクションなどです。
自分でつくりたい場合は、プラグインをつくるを見てください。
Plugins パネル
パネルには 2 つのタブがあります。
- My uploads — 自分のものがすべて 1 つのリストにまとまっています。作業中のプラグインのフォルダー、公開したプラグイン、インストールしたプラグインです。ここでプラグインの作成、フォルダーを開く、ディスクからの再読み込み、公開と公開の取り消し、削除ができます。
- Creator Hub — みんなが共有しているプラグインです。検索、タグでの絞り込みができ、スクリーンショット、作者、評価、インストール数、お気に入りの数を確認できます。自分のプラグインとインストール済みのプラグインは、結果の上のほうに表示されます。
検索ボックスに入力すると、2 つのタブが 1 つのリストにまとまり、自分のプラグインが先に表示されます。
プラグインをインストールする
インストールすると、プラグインはあなたのエディタだけに追加されます。ツールバーにプラグインのアイコンが表示されます。
チーム全員でプラグインを使うには、プロジェクトに追加します。すると、そのプロジェクトを開いた全員にプラグインが表示されます。スタイルチェッカーや共有のシーンジェネレーターなど、チーム全体で使うツールはこうしておきましょう。
公開したプロジェクトで動くコードを持つプラグイン
一部のプラグインは、公開したプロジェクトでも、それを開いた全員の環境で動きます。このコードが動くのは、プラグインが追加されているプロジェクトだけです。
このようなプラグインをプロジェクトに追加すると、プロジェクトはそのときのバージョンのコードを保持します。作者が新しいバージョンを公開したあとも、プレビュー、プレイテスト、公開ではそのコードが動きます。新しいコードがあるときは、プラグインに update available と表示されます。Update in project を押すと、プロジェクトが新しいコードに切り替わります。
あなたがプラグインの作者で、自分でプロジェクトに追加した場合は、保存するたびにそのバージョンがプロジェクトで動きます。公開したプロジェクトでは、もう一度公開するまで、公開したときのコードが動きます。
公開が取り消されたプラグイン
作者が Unpublish を押すと、プラグインはライブラリから削除されます。全員のエディタからも、追加されていたすべてのプロジェクトからも消えます。評価とお気に入りも削除されます。
信頼と検証
プラグインは、シーンやリソースを読んだり変更したりできます。そのため、ほかの人のプラグインを初めて開くとき、Studio は確認を求めます。Don't ask again for this plugin を選ぶと、そのプラグインについての答えが記憶されます。
ブラウザの拡張機能と同じように、信頼できる理由があるプラグインだけをインストールしてください。
プラグインは必要な権限をマニフェストに列挙しますが、Studio はプラグインをその範囲に制限しません。どのプラグインも、何を列挙していても、プロジェクト全体にアクセスできます。
検証済みのプラグイン
Reviewed(検証済み)は、そのプラグインのまさにこのバージョンのコードを、誰かが読んだという意味です。プラグインの良し悪しを評価したものではありません。
作者が新しいコードを公開すると、プラグインは再びレビューされるまで pending(確認待ち)に戻ります。説明、タグ、スクリーンショットの変更ではバッジは外れません。これらは実行されるものではないからです。
検証によって、一部の確認メッセージをオフにすることもできます。それぞれ個別に設定されます。
| 設定 | オフになるもの |
|---|---|
open | プラグインのパネルを開くときの確認 |
autorun | 自動で起動する部分が動く前の確認。下を参照 |
warnings | プラグインのコードは運営がレビューしていない、という注意書き |
どの設定もオフにしないまま検証されることもあります。その場合、バッジはつきますが、確認メッセージはすべて残ります。コードを読むことと、確認をなくすことは、別々の判断です。
パネルは、開いたときにだけ動きます。一方、カスタムコンポーネントやビューポートのオーバーレイは、誰かがプロジェクトを開くたびに動きます。autorun が別の設定になっているのはそのためです。
自動で起動する部分が動くのは、あなたのブラウザで信頼されているプラグインだけです。
- 自分のパソコン上のフォルダーから開いたプラグイン
- 以前に許可したプラグイン。開いたときに Allow を押したか、Don't ask again for this plugin を選んだもの
- 検証に
autorunが含まれているプラグイン
それ以外のプラグインでは、これらの部分は待機します。カスタムコンポーネントは実行されず、代わりに Allow ボタン付きのメッセージが表示されます。オーバーレイは非表示のままです。プラグインに表示するものがあると、小さなバーが表示され、許可するかどうかを尋ねます。答えはこのブラウザにだけ保存されるので、別のブラウザではもう一度尋ねられます。
このコードは、プロジェクト自身のスクリプトと同じように、プロジェクトを開いた全員の環境で動きます。そのため、チームとしての判断は、プラグインを追加する人がすることになります。バージョンがプラグインの追加時に固定されるのはそのためです。新しいコードがプロジェクトに届くのは、誰かが Update in project を押したときだけです。
プラグインの検証ステータスは、none、pending、verified、rejected、revoked のいずれかです。検証が取り消されると、そのプラグインについての Don't ask again for this plugin の選択もリセットされます。あなたが同意したのとは違うコードになっているからです。
評価と有料プラグイン
プラグインは、星 1〜5 で 1 回だけ評価できます。
プラグインをインストールできる人は、作者が決めます。
| アクセス | インストールできる人 |
|---|---|
| Free | 誰でも |
| Premium | 有料プランの人 |
| Subscribers only | 作者の公開プロフィールの有料サブスクリプションに登録している人 |
プロジェクトの中では、そのプロジェクトの組織のサブスクリプションが基準になります。自分のプラグインは、いつでも使えます。
Subscribers only のプラグインのランタイムコードは、公開したプロジェクトを開いた全員に届き、誰でもブラウザで読めます。サブスクリプションで決まるのは、プラグインをプロジェクトに追加し、更新し、それを使って公開できる人です。
サブスクリプションが終わると、そのプラグインを使っているプロジェクトはもう一度公開できなくなります。サブスクリプションを更新するか、プラグインを外してください。すでに公開されているプロジェクトは、そのまま動き続けます。
必要な環境
- ライブラリのプラグインを使う場合: どのブラウザでもかまいません。
- パソコン上のフォルダーからプラグインをつくる場合: Chrome や Edge など、Chromium ベースのブラウザが必要です。
次へ: プラグインをつくる — 自分のプラグインをつくって公開します。