プラグイン構成

Re:Earth Visualizer のプラグインは、1 つの reearth.yml 設定ファイルと、拡張ごとに 1 つ用意する JavaScript ファイルで構成される .zip ファイルです。reearth.yml はプラグインの情報と拡張を定義し、各 JavaScript ファイルには対応する拡張のロジックを記述します。Visualizer は、これらのファイルを使ってプラグインを読み込み、実行します。

reearth.yml

すべてのプラグインは、.zip のルートに reearth.yml という名前のファイルを含める必要があります。この YAML ファイルには、名前、バージョン、説明、拡張など、プラグインのメタデータを記述します。

reearth.yml

id: demo-plugin
name: Demo Plugin
version: 1.0.0
extensions:
  - id: demo-widget
    type: widget
    name: Demo Widget

注意

id フィールドで使用できる文字は、英字（a-zA-Z）、数字（0-9）、ハイフン（-）、アンダースコア（_）のみで、最大 100 文字です。reearth は予約されているため、ID として使用できません。

サポートされているフィールドの一覧については、プラグインマニフェストのスキーマを参照してください。

拡張の JavaScript

reearth.yml で宣言した各拡張には、対応する JavaScript ファイルが必要です。ファイル名は拡張の id と完全に一致させてください。たとえば、id: demo-widget の拡張には demo-widget.js というファイルが必要です。

注意

拡張の id と JavaScript のファイル名は、完全に一致させてください。どちらにも空白や特殊文字を使用しないでください。

JavaScript ファイルには、その拡張のロジックを記述します。コードは WebAssembly 側で実行され、グローバルに公開されたプラグインAPIを利用できます。

demo-widget.js

reearth.ui.show(`<h1>Hello, World!</h1>`);

ノート

拡張の JavaScript は QuickJS で実行されます。ECMAScript 2020 と互換性のあるコードを使用してください。

パッケージ化とインストール

reearth.yml とすべての拡張の JavaScript ファイルを用意したら、1 つの .zip ファイルにまとめます。この .zip は、任意の Re:Earth Visualizer プロジェクトにインストールできます。

my-plugin.zip
├── reearth.yml
└── demo-widget.js

複数の拡張がある場合は、それぞれに対応する JavaScript ファイルを含めます。

my-plugin.zip
├── reearth.yml
├── demo-widget.js
└── demo-infobox-block.js

ノート

プラグインのサイズは 10 MB 以下である必要があります。画像や CSS など、JavaScript 以外のファイルを .zip に含めることはできません。詳しくは制約事項を参照してください。

.zip を繰り返し作成してインストールする手間を省き、効率よく開発する方法については、ローカル開発環境をセットアップするを参照してください。