メインコンテンツまでスキップ

クイックスタート

metatellプラグインを開発するためのガイドです。 テンプレートを使用して最初のプラグインを作成してみましょう。

前提条件​

  • Node.js 20以上（Volta推奨）
  • npm または yarn
  • Git
  • TypeScriptとReactの基礎知識
  • Metatell管理画面へのアクセス権限
# Node.jsバージョン確認
node --version  # v20.0.0以上

# Voltaを使用する場合
curl https://get.volta.sh | bash
volta install node@20

手順​

1. テンプレートのセットアップ​

# テンプレートリポジトリをクローン
git clone https://github.com/urth-inc/metatell-plugin-template.git
cd metatell-plugin-template

# 使用したいテンプレートを選択（例: CustomOverlay）
cd CustomOverlay

# 依存関係をインストール
npm install

2. 開発サーバーの起動​

# 開発サーバーを起動
npm run dev

デフォルトで http://localhost:3004 で起動します。

3. プラグイン情報の設定​

package.jsonを編集して、プラグインの基本情報を設定：

{
  "name": "my-custom-plugin",
  "version": "0.1.0",
  "description": "My first metatell plugin"
}

4. ビルド​

# プロダクションビルド
npm run build

dist/ディレクトリにプラグインファイルplugin.zip

5. 登録​

管理画面からプラグインの登録が可能です。

リソース管理>プラグイン一覧>プラグイン登録でプラグイン登録画面を開きます。

プラグイン登録画面を開く

ビルドした、plugin.zipを選択、適切なロゴ画像を登録します（後から変更可能）。 公開は自社内で使う場合はOFFのままで問題ありません。 その後新規作成ボタンを押します。

プラグイン登録画面

6. ルームにプラグインを適用​

プラグインが登録されたら、ルームにプラグインを追加できます。

プロジェクト一覧>プロジェクト>ルーム>プラグイン適用タブでプラグインを適用できます。

登録した種類のプラグインとバージョンを選択します。

プラグイン適用画面

あとはルームに入室をして、プラグインが適用されていることを確認します。

に最終更新