jointrashposs/content/ja-JP/docs/advanced/create-plugin.md
kakkokari-gtyih 8e52c51c49 wip
2023-07-08 17:36:02 +09:00

1.6 KiB

プラグインの作成

Misskey Webクライアントのプラグイン機能を使うと、クライアントを拡張し、様々な機能を追加できます。 このドキュメントではプラグインの作成方法について説明します。

AiScript

プラグインはAiScriptを使って記述されるスクリプトです。

メタデータ

プラグインは、AiScriptのメタデータ埋め込み機能を使って、デフォルトとしてプラグインのメタデータを定義する必要があります。 メタデータは次のプロパティを含むオブジェクトです。

name

プラグイン名

author

プラグイン作者

version

プラグインバージョン。数値を指定してください。

description

プラグインの説明

permissions

プラグインが要求する権限。MisskeyAPIにリクエストする際に用いられます。

config

プラグインの設定情報を表すオブジェクト。 キーに設定名、値に以下のプロパティを含めます。

type

設定値の種類を表す文字列。以下から選択します。 string number boolean

label

ユーザーに表示する設定名

description

設定の説明

default

設定のデフォルト値

API

Misskey Webはプラグインに対してAPIを公開していて、それらを利用することでクライアントの機能を拡張できます。 どのようなAPIがあるかはプラグインAPIリファレンスを参照してください。