ここでは簡単なプラグインを一緒に開発することで、プラグインの開発手順を説明します。

１．プロジェクトフォルダを作成する

お好きな場所にフォルダを作成してください。ここにプラグインのコードを配置します。フォルダの名前は何でもかまいません。このページでは test-plugin と名付けます。

２．プラグインのマニフェストを記述する

マニフェストとは、作成するプラグインのIDや名前・拡張する機能・ユーザーに提供する設定項目などのメタデータです。

reearth.yml というファイルを作成し、以下のように編集します。

reearth.yml

id: test-plugin
name: Test plugin
version: 1.0.0
extensions:
  - id: test-widget
    type: widget
    name: Test

<aside> ⚠️ 注意

• id は大文字では設定できません
• 改行やスペースなどを間違えないように注意してください </aside>

３．最初の拡張機能を実装する

実はプラグインは「拡張（extension）」と呼ばれる単位の集合体です。プラグインは1つの拡張だけを持つことも、複数の拡張を持つこともできます。

最初の拡張を実装してみましょう。前のステップのマニフェストに記述されているように、私たちが実装する拡張のIDは test-widget です。このIDに .js 拡張子を付けた test-widget.js というファイルを作成します。

<aside> ⚠️ 注意

このファイル名を間違えるとプラグインは動作しませんのでご注意ください。拡張子以外のファイル名は、IDと完全に一致する必要があります。

</aside>

次にJSファイルを編集します。

test-widget.js