diff --git a/README.md b/README.md index 7c85ba5..78f16cb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,45 @@ -# SimplePluginTemplate +# Notice Box a.k.a 詫び石配りプラグイン -howard127がKotlinで開発したい気分の時に使う用のテンプレート +コマンドとインベントリGUIを用いてユーザーにお知らせを送信することが出来ます -`settings.gradle`と`src/main/resources/plugin.yml`を変更してね +## ⚔ 特徴 -mainブランチが変更されると自動でビルドされてくっつけてくれます +- [x] 使いづらく非直感的なGUI +- [x] 非効率で低速なデータアクセス +- [x] 信頼性の低く拡張不可能な機能性 +- [x] バージョン1.20以上のみをサポート + +## 🐄 前提プラグイン + +- Vault +- Vaultに対応した経済プラグイン + +## 💡 使い方 + +### 💬 コマンド + +| コマンド | 引数 | 説明 | パーミッション | +| --- | --- | --- | --- | +| /noticebox add | | お知らせを作成するための本を取得します | `noticebox.add` | +| /noticebox remove | | お知らせを削除するためのGUIを表示します | `noticebox.remove` | +| /noticebox open | | お知らせ一覧のGUIを表示します | `noticebox.open` | +| /noticebox open | `` | ``に対してお知らせ一覧のGUIを表示します | `noticebox.open-other` | + +### 👦 お知らせ作成の流れ + +1. `/noticebox add`を実行し本を取得する +2. 本を開きお知らせの本文を入力する +3. 本のタイトル部分にお知らせのタイトルを入力し署名する +4. 表示されたGUIで報酬等の設定を行い右下の作成ボタンをクリックする + +## 🖋 備考 + +- 本の署名時に入力可能なタイトルは15文字までです。より長いタイトルを入力したい場合は署名後に表示されるGUIの「タイトルを設定」をご利用ください。 + +## このプロジェクトは以下を使用して開発されています + +- [CommandAPI](https://github.com/JorelAli/CommandAPI) by Jorel Ali + +- [InventoryGui](https://github.com/Phoenix616/InventoryGui) by Max Lee + +- [AnvilGUI](https://github.com/WesJD/AnvilGUI) by Wesley Smith