mirror of
https://iceshrimp.dev/Crimekillz/jointrashposs.git
synced 2024-11-24 09:49:06 +01:00
78 lines
2.1 KiB
Markdown
78 lines
2.1 KiB
Markdown
|
# プラグインの作成
|
||
|
|
|
||
|
|
Misskey Webクライアントのプラグイン機能を使うと、クライアントを拡張し、様々な機能を追加できます。
|
||
|
|
このドキュメントではプラグインの作成方法について説明します。
|
||
|
|
|
||
|
|
## AiScript
|
||
|
|
|
||
|
|
プラグインはAiScriptを使って記述されるスクリプトです。
|
||
|
|
|
||
|
|
## メタデータ
|
||
|
|
|
||
|
|
プラグインは、AiScriptのメタデータ埋め込み機能を使って、デフォルトとしてプラグインのメタデータを定義する必要があります。メタデータの例は以下の通りです。
|
||
|
|
|
||
|
|
```js
|
||
|
|
/// @ 0.12.4
|
||
|
|
### {
|
||
|
|
name: "プラグイン名"
|
||
|
|
version: "4.2.1"
|
||
|
|
author: "作者名"
|
||
|
|
description: "説明文"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
メタデータは次のプロパティを含むオブジェクトです。
|
||
|
|
|
||
|
|
### name
|
||
|
|
|
||
|
|
プラグイン名
|
||
|
|
|
||
|
|
### author
|
||
|
|
|
||
|
|
プラグイン作者
|
||
|
|
|
||
|
|
### version
|
||
|
|
|
||
|
|
プラグインバージョン。数値を指定してください。
|
||
|
|
|
||
|
|
### description
|
||
|
|
|
||
|
|
プラグインの説明
|
||
|
|
|
||
|
|
### permissions
|
||
|
|
|
||
|
|
プラグインが要求する権限。MisskeyAPIにリクエストする際に用いられます。
|
||
|
|
|
||
|
|
### config
|
||
|
|
|
||
|
|
プラグインの設定情報を表すオブジェクト。
|
||
|
|
キーに設定名、値に以下のプロパティを含めます。
|
||
|
|
|
||
|
|
#### type
|
||
|
|
|
||
|
|
設定値の種類を表す文字列。以下から選択します。
|
||
|
|
string number boolean
|
||
|
|
|
||
|
|
#### label
|
||
|
|
|
||
|
|
ユーザーに表示する設定名
|
||
|
|
|
||
|
|
#### description
|
||
|
|
|
||
|
|
設定の説明
|
||
|
|
|
||
|
|
#### default
|
||
|
|
|
||
|
|
設定のデフォルト値
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
Misskey Webはプラグインに対してAPIを公開していて、それらを利用することでクライアントの機能を拡張できます。
|
||
|
|
どのようなAPIがあるかは[プラグインAPIリファレンス](./plugin-api-reference/)を参照してください。
|
||
|
|
|
||
|
|
## プラグインを配布する
|
||
|
|
|
||
|
|
v2023.11.0以降では、あなたのウェブサイトからワンクリックでプラグインを直接インストールできるようになっています。
|
||
|
|
|
||
|
|
プラグインのインストール機能を提供する場合は、あなたのサイト上にAPIを実装する必要があります。詳しくは[こちら](./publish-on-your-website.md)をご覧ください。
|