# 福舞鯖｜生活基幹システム「Koala」
## 概要
- [ ] 土地の保護
- [ ] 定期請求機能
- [ ] 個人ショップ
- [ ] 運営買取ショップ
- [x] 死亡時に所持金から割合で差引（※別のプラグインに移植しました）

## 開発時の留意事項
- GUIを作成する場合は、[InvUI](https://github.com/NichtStudioCode/InvUI)を使用してください
- AnvilGUIを作成する場合は、[AnvilGUI](https://github.com/WesJD/AnvilGUI)を使用してください
- データベースを使用する場合は、ExposedにてSQLiteを使用してください

※その他のライブラリを使用したい場合は、連絡してください。

## 土地の保護
### コマンド：`/protect`
土地の保護をするコマンド（Aliases: `/p`）

1. コマンド `/protect` を実行
2. 赤羊毛（始点位置）と青羊毛（終点位置）を付与
3. それぞれのポイントを設定（設置）
4. チャットにて請求額を提示（※Dailyで請求）
5. 承諾した場合は、契約締結。承諾しなかった場合は、キャンセル

請求額は毎日午前3時に一斉に全プレイヤーから徴収（Vault）
また、保護の範囲はY軸（0~ワールド最大値）とし、平面の広さにおおじて価格を設定する。
※同コマンドを再度実行した場合、強制的に処理をキャンセル

オーナーが複数いる場合は、オーナーの人数に応じて支払金額を分割して徴収
また、一人でも支払えないプレイヤーがいた場合は、その土地を滞納扱いとし、次回請求に上乗せ。

### コマンド：`/plist`
所有している土地の一覧を表示するコマンド

選択された土地は、下記のコマンドと同じ動作をする。

### コマンド： `/plist <保護ID>`
プレイヤーが保護している土地の詳細設定ができるGUIを表示するコマンド

設定項目：
- 土地の保護ID
- AnvilGUIにて、保護IDを入力
- メンバーの一覧
- プレイヤーヘッドで表示
- DisplayName: MCID
- 削除する場合は、プレイヤーヘッドをクリック
- 本当に削除するかどうか確認する画面を表示
- 追加する場合は、「画像1」の「金床」をクリックでAnvilGUIを表示、MCIDの入力
- オーナーの一覧
- 全て同上
- フラグの設定
- コンフィグ（listOfFlags）から取得し、一覧を表示（「画像2」を参照）
- クリックでオン（緑色の染料LIME_DYE）オフ（灰色の染料GRAY_DYE）を変更

画像1

画像2

## 定期請求機能

__毎日深夜3:00に処理を実行する__
運営側で削除できるように内部の請求IDを __5桁のアルファベット+数字__ で管理

### コマンド：`/invoice add {player} {amount} {days}`
定期請求をするのを追加するコマンド

実行されたら指定したユーザー名に指定された間隔(日)と金額が送信され、相手が承認するとその指定した間隔事に指定した金額が朝3時に請求される。

### コマンド: `/invoice accept {player}`
支払う側が承認するコマンド
承認したら請求した側に通知が行くようにする

### コマンド：`/invoice list`
本に表示、複数ある場合別ページに表示
請求した側（請求）、請求された側（支払い）どっちとも見れてタイプというところで請求した側か請求された側か確認できる。

表示例:

タイプ§a: §d[支払い or 請求]

プレイヤー§a: §6[playerid]
請求間隔§a: §c[請求間隔]
料金§a: §c[money]
次回の請求日§a: §c[次回の請求日]

請求ID§a: §0[請求ID]

（請求IDだけ若干違います）

### コマンド：`/invoice remove {請求ID}`
※請求側からのみ消せる
IDはリストの横に書いてある番号で、IDを指定して実行すると請求を削除できる

### コマンド: `/invoice admin add {player(請求元)} {player（請求先）} {amount} {days}`
運営側から

### コマンド：`/invoice admin list {player} {page}`
表示方法などは一般の人と同じだが、指定したプレイヤー請求を表示をする

### コマンド：`/invoice admin remove {請求ID}`
運営側から強制的に請求を削除できる

### その他
お金が引かれた、お金を請求してその分が付与された場合入った際にどのくらい支払ったか、だれに支払ったか含めメッセージを出す
相手のお金が足りず、請求できなった場合、その場合も請求者に通知して、次の支払いに上乗せする

## コンフィグ（config.yml）

#########################################################
# Koala Configuration File
# Created by M1n1don
# - GitHub: https://github.com/McFukumaisaba/Koala
##

# prefix:
#   サーバー上のユーザーに対する本プラグインのメッセージに使用されるプレフィックス
#   DEFAULT: ""
prefix: ""

# mainWorld:
#   サーバーのメインワールド
#   DEFAULT: "world"
mainWorld: "world"

# priceOfLand:
#   1平方メートルあたりの1日の土地単価（円）
priceOfLand: 5

# taskOfLand:
#   1日の中で土地の保護料金を徴収する時間（時間）
#   EXAMPLE: "00:00" - 0時
#            "03:00" - 3時
#            "04:05: - 4時5分
taskOfLand: "03:00"

# listOfFlags:
#   保護している土地でのフラグ設定
#    ※グループがない場合は、グループを設定しない
#   EXAMPLE: "フラグID|フラグ名|デフォルト状態,グループ"
listOfFlags:

  - "ENTRY|プレイヤーの侵入を許可|DENY"
  - "BUILD|ブロックの設置及び破壊|ALLOW,MEMBERS"
  - "PVP|プレイヤー同士のPvP|DENY"
  - "TNT|TNTの爆破|DENY"

# errorMessage:
#   エラー時に表示されるメッセージ
#   PlaceHolders ->
#     %ERROR_CODE% : エラーコード
errorMessage: "&c予期せぬエラーが発生しました。管理者へお問い合わせください。[%ERROR_CODE%]"