docs/README-ja.md
PeyangSuperbAntiCheat
======
If possible.
<details>
<summary>目次</summary>
- [PeyangSuperbAntiCheat](#peyangsuperbanticheat)
- [概要](#概要)
- [注意](#注意)
- [インストール方法](#インストール方法)
- [コマンド](#コマンド)
- [/wdr](#wdr)
- [エイリアス](#エイリアス)
- [説明](#説明)
- [使用法](#使用法)
- [報告に使用できる理由一覧](#報告に使用できる理由一覧)
- [権限](#権限)
- [/aurabot](#aurabot)
- [エイリアス](#エイリアス-1)
- [説明](#説明-1)
- [使用法](#使用法-1)
- [権限](#権限-1)
- [/acpanic](#acpanic)
- [エイリアス](#エイリアス-2)
- [説明](#説明-2)
- [使用法](#使用法-2)
- [権限](#権限-2)
- [/testkb](#testkb)
- [エイリアス](#エイリアス-3)
- [説明](#説明-3)
- [使用法](#使用法-3)
- [権限](#権限-3)
- [/pull](#pull)
- [エイリアス](#エイリアス-4)
- [説明](#説明-4)
- [使用法](#使用法-4)
- [権限](#権限-4)
- [/target](#target)
- [説明](#説明-5)
- [使用法](#使用法-5)
- [権限](#権限-5)
- [/tracking](#tracking)
- [エイリアス](#エイリアス-5)
- [説明](#説明-6)
- [使用法](#使用法-6)
- [権限](#権限-6)
- [/trust](#trust)
- [エイリアス](#エイリアス-6)
- [説明](#説明-7)
- [使用法](#使用法-7)
- [権限](#権限-7)
- [/silentteleport](#silentteleport)
- [エイリアス](#エイリアス-7)
- [説明](#説明-8)
- [使用法](#使用法-8)
- [権限](#権限-8)
- [/kick](#kick)
- [説明](#説明-9)
- [使用法](#使用法-9)
- [権限](#権限-9)
- [/psac](#psac)
- [エイリアス](#エイリアス-8)
- [説明](#説明-10)
- [サブコマンド一覧](#サブコマンド一覧)
- [権限（上から順に）](#権限上から順に)
- [権限について](#権限について)
- [\<管理ID\>について](#管理idについて)
- [キックについて](#キックについて)
- [ブロードキャストメッセージについて](#ブロードキャストメッセージについて)
- [NPCについて](#npcについて)
- [コンフィグについて](#コンフィグについて)
- [人工知能のようなものについて](#人工知能のようなものについて)
- [言語について](#言語について)
- [英語](#英語)
- [日本語](#日本語)
- [ターゲットアイテムについて](#ターゲットアイテムについて)
- [バグ・要望等](#バグ要望等)
- [担当者](#担当者)
- [謝辞](#謝辞)
</details>
---
## 概要
[**BungeeCordとの連携はこちらをご覧ください。**](BUNGEE.md)
このプラグインは、SpigotもしくはPaperMCサーバー上で動作し、チートテストやチートレポートの管理を手動でするプラグインです。
そのため、運営が常にサーバー内にログインしている場合に適しています。
なお、現時点で1.12.2のみ動作します。
このプロジェクトは、[行動規範](CODE-OF-CONDUCT.md)の下でリリースされていることに注意してください。
プロジェクトに参加することより、あなたは条件に従うことに同意するものとします。
---
## 注意
DetectOPMシステムを2個同時に稼働させることで4つのタイマーが常に動作しています。
NPCがスポーンするたびに、検査に必要なタイマーが12個ほど生成されます。
使用後すぐに停止されますが、停止時間は使用しているJVMによって変わります。
詳しくは[こちら](PluginThreads.txt)をご覧ください。
RAMやCPUを大量に使用するため、リソースに余裕のあるサーバーで実行することをおすすめします。
このプラグインでは初歩的な本の実装方法を使用しています。
---
## インストール方法
1. jarをダウンロード・ビルドする
プラグインの本体であるjarファイルをいくつかの方法で入手することが可能です。
- [GitHub Releases](https://github.com/P2P-Develop/PeyangSuperbAntiCheat/releases)からコンパイル済みのjarをダウンロードする
リリース前に最新のjarがビルドされています。
- 手動でビルドする
ビルドには以下のバイナリが必要です。
- `javac` - JVM付属のJavaコンパイラー
- `mvn` - Mavenプロジェクトマネージャー
以下のコマンドでGitHubからリポジトリをクローンし、安定版をビルドします。
```bash
$ git clone https://github.com/P2P-Develop/PeyangSuperbAntiCheat psac
$ cd psac
$ mvn package
```
開発版をビルドする場合:
```bash
$ git clone https://github.com/P2P-Develop/PeyangSuperbAntiCheat psac
$ cd psac
$ git checkout develop
$ mvn package
```
2. 依存プラグインのインストール
[ProtocolLib](https://github.com/dmulloy2/ProtocolLib)をダウンロードし、サーバーの`plugins`ディレクトリにコピー・移動します。
3. PeyangSuperbAntiCheatのインストール
サーバーの`plugins`ディレクトリにjarをコピー・移動します。
---
## コマンド
### /wdr
このプラグインで主に使用されるコマンドです。
#### エイリアス
- /peyangreport
- /pcr
- /rep
- /report
- /watchdogreport
#### 説明
- プレイヤー側
チートを使用しているプレイヤーをスタッフに報告します。
- スタッフ側
プレイヤーからの報告は以下の2形式で表示されます。
`[CLICK]`をチャット画面からマウスでクリックすることにより、報告の確認ができます。
```tst
[PeyangSuperbAntiCheat] プレイヤーがレポートを提出しました！クリックしてレポートを確認してください！ [CLICK]
```
このメッセージでは前者よりも詳細なメッセージが表示されます。
ただし、クリックは使用できません。
```tst
[STAFF] [ADMIN] Fishy: Report of <プレイヤー名> <理由1>, [理由2]…
```
これらのメッセージはコンフィグを編集することにより変更ができます。
後者のフォーマットは、とある人物によりリークされたHypixelのスタッフ向けModのHypixel Lynxと互換性を持たせる事ができるモードです。
Hypixel Lynxを導入したまま、Hypixelには参加しないでください。
ブラックリストModとして登録されているため、スタッフ以外のプレイヤーは即座にBANされます。
なお、このModを開発したのは既にHypixelを退職したAdminのSpencer Alderman氏だと思われます。
#### 使用法
- /wdr \<PlayerName\>
この状態で実行すると、報告の理由を選択できる本が開きます。
本に表示されている報告理由をクリックすると報告内容として追加されます。
- /wdr \<PlayerName\> \<理由1\> \[理由2\]…
このコマンドは本を使用せずにコマンドのみで報告できますが、コンソールからでも報告できます。
**このコマンドの事由にはエイリアスを使用できます。下記の表をご覧ください。**
#### 報告に使用できる理由一覧
本で表示される順に書き起こします。
| 理由 | エイリアス | 簡単な説明 |
| ------------- | -------------------------- | ------------------------------------------------------------------------------------------ |
| Fly | flight | プレイヤーのゲームモードがクリエイティブモード以外でも、空を飛べるようにできるチートです。 |
| KillAura | killaura, aura, ka | 範囲に入ったプレイヤーを全方向から攻撃できるチートです。 |
| AutoClicker | autoclicker, ac, autoclick | 自動で左クリックを連打するチートです。MacroもAutoClickerに分類されます。 |
| Speed | speed, bhop, timer | 設定した速度で走れるようになるチートです。BunnyHopやTimerもSpeedに分類されます。 |
| AntiKnockback | akb, velocity, antikb | ノックバックを防止するチートです。 |
| Reach | reach | 通常より攻撃できる範囲が長くなるチートです。 |
| Dolphin | dolphin | 沈まないように水を自動で泳ぐチートです。 |
- 報告機能を悪用されることを避けるため、すでに報告をした人への報告はできません。
### 権限
- psac.report
初期では全員が持っている権限です。
この権限を剥奪されたプレイヤーはプレイヤーを報告できなくなります。
---
### /aurabot
#### エイリアス
- /testaura
- /auratest
- /killauratest
#### 説明
このコマンドを実行すると、プレイヤーの周りにプレイヤーの周囲を一定の速度で回るNPCを召喚します。
このNPCに対して一定の回数以上ヒットした場合、そのプレイヤーを自動でキックします。
また、第二引数か第一引数のどちらかに`-r`オプションを付けた場合にはリーチモードとして召喚されます。
リーチモードはNPCをリーチ用の半径上に召喚するため、リーチのチェックも行えます。
#### 使用法
- /aurabot \<PlayerName\>
\<PlayerName\>に指定されたプレイヤーに回転NPCを召喚します。
- /aurabot \<PlayerName\> \[-r\]
\<PlayerName\>に指定されたプレイヤーにリーチモードとして回転NPCを召喚します。
#### 権限
- psac.aurabot
---
### /acpanic
#### エイリアス
- /testpanic
- /panictest
- /aurapanictest
#### 説明
このコマンドを実行すると、プレイヤーの背後にへばりつくようにNPCを指定された秒数召喚します。
また、第二引数か第一引数のどちらかに`-r`オプションを付けた場合、リーチモードとして召喚されます。
#### 使用法
- /acpanic \<PlayerName\>
\<PlayerName\>に指定されたプレイヤーの背後にNPCを召喚します。
- /acpanic \<PlayerName\> \[-r\]
\<PlayerName\>に指定されたプレイヤーの背後にリーチモードとしてNPCを召喚します。
#### 権限
- psac.aurapanic
---
### /testkb
#### エイリアス
- /testknockback
- /kbtest
- /knockbacktest
#### 説明
指定されたプレイヤーに見えない矢を打ちます。
矢を受けた際のノックバックでプレイヤーがVelocityを使用しているかどうかを判定できます。
#### 使用法
- /testkb \<PlayerName\>
\<PlayerName\>に指定されたプレイヤーに矢を打ちます。
#### 権限
- psac.testkb
---
### /pull
指定したプレイヤーを引き寄せます。
#### エイリアス
- /pul
#### 説明
指定したプレイヤーを実行者に引き寄せます。
コンソールからは実行できません。
#### 使用法
- /pull \<PlayerName\>
#### 権限
- psac.pull
---
### /target
指定したプレイヤーをターゲットとして追跡します。
#### 説明
このコマンドを実行すると、いくつかのアイテムが手に入ります。
いずれかのアイテムを持ってクリックすることによりプレイヤーにNPCを出すなど、さまざまな操作ができます。
#### 使用法
- /target \<PlayerName\>
#### 権限
- psac.target
---
### /tracking
指定したプレイヤーをターゲットとして追跡します。
#### エイリアス
- /track
#### 説明
引数に指定したプレイヤーを追跡します。
引数に何も指定しなかった場合は追跡が解除されます。
#### 使用法
- /tracking \[PlayerName\]
#### 権限
- psac.tracking
---
### /trust
指定したプレイヤーを信用します。
#### エイリアス
- /noscan
- /trustplayer
#### 説明
引数に指定したプレイヤーを信用します。
信用されている場合は、信用を解除します。
信用されたプレイヤーに対してはpsac.trust権限を持っているプレイヤーしかスキャンやテストができなくなります。
信用するのにもpsac.trust権限が必要です。
> 警告：この権限を乱用された場合、正しい運営に影響が発生する可能性があります。
> 注意して使用してください。
#### 使用法
- /trust \<PlayerName\>
#### 権限
- psac.trust
---
### /silentteleport
指定したプレイヤーに自分または指定したプレイヤーをテレポートさせます。
#### エイリアス
- /stp
- /tpto
#### 説明
引数に指定したプレイヤーにテレポートします。
2つ引数を指定した場合は第1引数のプレイヤーが第2引数のプレイヤーにテレポートします。
#### 使用法
- /stp \[PlayerName\] \<PlayerName\>
#### 権限
- psac.silentteleport
---
### /kick
指定したプレイヤーをゲームから退出させます。
#### 説明
第1引数に指定したプレイヤーにゲームから退出していただきます。
また、第2引数を指定することにより理由をつけて退出させられます。
#### 使用法
- /kick \<PlayerName\> \[理由\]
#### 権限
- psac.kick
---
### /psac
#### エイリアス
- /peyangsuperbanticheat
- /psr
- /wdadmin
- /anticheat
#### 説明
このプラグインの管理コマンドです。
第一引数にサブコマンドをつけることによって動作します。
#### サブコマンド一覧
- /psac help
このプラグインコマンドのヘルプを表示します。
`psac.mod`または、`psac.admin`権限を持っている人には他のサブコマンドのヘルプも表示されます。
- /psac view \[ページ数\]
プレイヤーが提出したレポートを確認できます。
危険度順に5件ずつ表示されます。
- /psac show \<管理ID\>
プレイヤーが提出したレポートの詳細を表示します。
このコマンドをプレイヤーから実行すると本が開き、報告の詳細を確認できます。
- /psac drop \<管理ID\>
プレイヤーが提出した報告を**完全**に破棄します。
**削除ログは一切記録されません。破棄する場合には十分にご注意ください。**
#### 権限（上から順に）
- psac.help
- psac.view
- psac.show
- psac.drop
- psac.kick
---
### 権限について
権限は最低限コマンドに1つ割り当てられています。
その他細かく調整できます。
> 注意：崩れていたのを無理やり修正したため、内容が正しくない可能性があります。
| 権限 | 割り当てられているコマンド | その他説明 | デフォルト | グループ |
| ----------------- | ---------------------------------------------------- | -------------------------------------------------------- | ---------- | ----------- |
| **psac.member** | | サーバーメンバー用の権限です。 | true | |
| psac.report | /wdr (report) | レポートができます。 | true | psac.member |
| psac.help | /psac help | このプラグインの（メンバー）ヘルプを表示します。 | true | psac.member |
| psac.notification | プレイヤーが対処されたとき通知が飛ばされます。 | | true | psac.member |
| psac.regular | 定期メッセージが流れます。 | | true | psac.member |
| **psac.mod** | プレイヤーのキックやテストをできます。 | | op | |
| psac.kick | /psac kick | プレイヤーをキックします。 | op | psac.mod |
| psac.aurapanic | /aurapanic \<PlayerName\> | プレイヤーに回るNPCを送ります。 | op | psac.mod |
| psac.aurabot | /aurabot \<PlayerName\> | プレイヤーの背後に貼り付くNPCを召喚します。 | op | psac.mod |
| psac.testkb | /testkb \<PlayerName\> | プレイヤーに見えない弓を放ち、ノックバックを確認します。 | op | psac.mod |
| psac.viewnpc | 対象プレイヤー以外にNPCを確認できるようにします。 | | op | psac.mod |
| psac.view | /view | レポートを表示できます。 | op | psac.mod |
| psac.show | /show \<ManagementID\> | レポートを詳細表示します。 | op | psac.mod |
| psac.ntfadmin | PEYANG CHEAT DETECTIONに名前を含みます。 | | op | psac.mod |
| psac.reportntf | プレイヤーがレポートを送信したとき通知が届きます。 | | op | psac.mod |
| psac.pull | プレイヤーを自分に引き寄せます。 | | op | psac.mod |
| psac.chattarget | プレイヤーのチャットの左にマークが付きます。 | | op | psac.mod |
| psac.tracking | プレイヤー追跡に関するコマンドの権限です。 | | op | psac.mod |
| **psac.admin** | レポートの削除や、サーバーの根幹に関わる権限です。 | | false | |
| psac.drop | /psac drop \<ManagementID\> | プレイヤーからのレポートを跡形も残らずに消去します。 | false | psac.admin |
| psac.error | エラーが発生したとき通知されます。 | | false | psac.admin |
| psac.trust | 信用されているプレイヤーでも問答無用で操作できます。 | | false | psac.admin |
### \<管理ID\>について
\<管理ID\>はプレイヤーが報告を提出した際に自動的に割当られる32文字の英数文字列です。
このIDはコンソールから`/psr view`をした際に表示されます。
### キックについて
このプラグインでは、誤検出などのためにプレイヤーが誤BANされることを危惧しています。
そのため、勝手にプレイヤーをBANすることはありません。
### ブロードキャストメッセージについて
プレイヤーが自動でキックされるとき以下のブロードキャストメッセージが流れます。
```tst
[PEYANG CHEAT DETECTION] ハッキング、または不適切な発言によってゲームからプレイヤーが削除されました。
```
```tst
違反行為をしたプレイヤーをゲームから対処しました。ご報告ありがとうございました！
```
このメッセージはチートを自動検出した時のメッセージです。
スタッフによるキックの場合は後者のメッセージのみがブロードキャストされます。
### NPCについて
現NPCは同梱された英単語リストを使用して、 ランダムなユーザー名を持つプレイヤーを召喚しています。
スキンは同梱された1400種類のスキンセットからランダムで選ばれます。
### コンフィグについて
このプラグインでは以下のコンフィグを使用しています。SQLとの連携は、[こちら](SQL.md)を参照してください。
| 設定名 | デフォルト値 | 説明 |
| :------------------: | :-------------: | ---------------------------------------------------------------------------------------------------- |
| database.method | org.sqlite.JDBC | SQLの設定（メソッド） |
| database.url | jdbc:sqlite | SQLの設定（URL） |
| database.logPath | ./log.db | キック情報などを保存するSQLiteデータベースの置き場所です。 |
| database.learnPath | ./learn.json | 学習によって値が変更された「重み」と学習回数を保存するJSONファイルの置き場所です。 |
| database.trustPath | ./trust.db | 信用したプレイヤーを保存するSQLiteデータベースの置き場所です。これを消去すると信用データが消えます。 |
| lang | en | [プラグインのメッセージの表示に使用する言語を設定します。](#言語について) |
| npc.seconds | 3 | NPCがプレイヤーの周りを回る秒数です。 |
| npc.time | 0.35 | NPCが回る速さです。感覚で調整してください。 |
| npc.range | 3.0, 1.5 | NPCが回る半径です。 |
| npc.reachRange | 4.6 | NPCがリーチモードとして回る半径です。`-r`オプションがつくとこの値が使用されます。 |
| npc.wave | true | NPCが波を描くようにして回るかどうかです。 |
| npc.waveMin | 0.3 | NPCが波を描くようにして回る最低ラインです。 |
| npc.panicRange | 1.5 | Panic NPCがプレイヤーの背後をへばりつく相対的な高さでえす。 |
| npc.panicReachRange | 4.6 | Panic NPCがプレイヤーの背後をリーチモードとしてへばりつく相対的な高さです。 |
| npc.speed.wave | true | NPCのスピードをWaveで変更するかどうかです。 |
| npc.speed.waveRange | 0.03 | Waveで変更する範囲です。 |
| npc.learn | 0.3 | NPCの学習機能の学習係数を指定します。値が大きいほど処理は少なくなりますが、精度が下がります。 |
| npc.vlLevel | 17 | NPCが`npc.learnCount`より学習出来ていない場合にこの値を利用してVLを評価します。 |
| npc.learnCount | 15 | 学習機能がこの回数以上学習した場合にキックの評価を学習機能に譲渡します。 |
| npc.kill | 3 | 10秒間プレイヤーをキルしていて、この数を上回った場合はNPCを召喚します。 |
| kick.delay | 2 | プレイヤーをキックするまでの遅延です。ブロードキャストメッセージが流れた瞬間から数えられます。 |
| kick.defaultKick | 25 | NPCがこの値以上殴られた場合にキックします。学習済データが見つからない場合はこの値が優先されます。 |
| decoration.lightning | true | プレイヤーがキックされるときにダメージを受けない雷を落とすかどうかです。 |
| decoration.flame | true | プレイヤーがキックされるときにブレイズのパーティクルでアピールするかどうかです。 |
| decoration.circle | true | プレイヤーがキックされるときに色付きの円でアピールするかどうかです。 |
| message.lynx | true | Lynxと互換性を持たせるかどうかです。 |
| autoMessage.enabled | true | 定期メッセージの有効または無効を切り替えます。 |
| autoMessage.time | 15 | 定期メッセージの時間周期です。分で指定します。 |
### 人工知能のようなものについて
このプラグインでは、英語ドキュメント担当者がメインラインを担当した人工知能が試験的に実装されています。
キック時のデータを教師データとして人工知能に学習させることにより、人工知能を使用した際のキック精度を大きく向上させる試みです。
そのため、この人工知能は教師あり学習として実装されたパーセプトロン・ニューラルネットワーク上に構成されています。
人工知能の実装に依存しているライブラリはほぼありません（マルチデータの実装に`Pair<L, R>`や`Triple<L, M, R>`は使用しています）
### 言語について
英語ドキュメントの担当者がプラグインを多言語化しました。
ほぼすべての言語を扱えるわけではありませんが、英語 \(en\)、日本語 \(ja\)の2種類を扱えます。
[コンフィグについて](#コンフィグについて)に記載されている通り、`lang`プロパティに指定することで簡単に言語の変更ができます。
`lang`プロパティにはある程度曖昧な書き方ができるようにエイリアスも指定されています。
エイリアスは以下の通りです。
#### 英語
- en-US
- en_US
- en-UK
- en_UK
- English
イギリス英語も指定しているのは本プラグインの英語ではあまり違いがないと思われた為です。
#### 日本語
- ja-JP
- ja_JP
- jp
- Japanese
これらのエイリアスは小文字や大文字が混ざっていても認識できます。
無効な言語が選択された場合はフォールバックで自動的に設定されます。
### ターゲットアイテムについて
`/target`コマンドを実行するといくつかのアイテムが手に入ります。
このアイテムは右クリックで実行でき、ドロップで削除されます。
アイテムは以下の通りです。
> 注意：崩れていたのを無理やり修正したため、内容が正しくない可能性があります。
| アイテム | ID | その他説明 | 実行されるコマンド |
| :------------: | :------------------: | :----------------------------------: | :-------------------------: |
| 犬の頭 | AURA_BOT | Aura Botが対象に飛ばされます。 | /aurabot \<Target\> |
| 犬の頭 | AURA_PANIC | Aura Panic NPCが対象に飛ばされます。 | /acpanic \<Target\> |
| 矢 | TEST_KB | 対象に見えない矢が飛んでいきます。 | /testkb \<Target\> |
| コンパス | TRACKER | 対象にテレポートします。 | /tpto \<Target\> |
| 矢 | TO_TARGET_<番号> | ページ2に飛びます。 | /target \<Target\> \<番号\> |
| 時計 | BACK | 戻ります。 | |
| 矢 | BACK_TOTARGET_<番号> | ページ1に戻ります。 | /target \<Target\> \<番号\> |
| | | | |
| リード | PULL | 対象を引き寄せます。 | /pull \<Target\> |
| | | | |
| ブレイズロッド | TARGET_STICK | 目の前のプレイヤーを対象にします。 | /target \<Player\> |
### バグ・要望等
バグや何らかの機能の追加などの要望がある場合は、[こちら](https://github.com/P2P-Develop/PeyangSuperbAntiCheat/issues)にて受け付けております。
要望に関しては、なるべく実装ができるよう善処いたします。
### 担当者
日本語：[Peyang](https://github.com/peyang-Celeron)、[Potato1682](https://github.com/Potato1682)、[CompiledUmaru](https://github.com/CompiledUmaru)
英語：[Potato1682](https://github.com/Potato1682)
### 謝辞
このプラグインは以下のライブラリ・APIを使用しています。
- [brettwooldridge/HikariCP](https://github.com/brettwooldridge/HikariCP)
- [dmulloy2/ProtocolLib](https://github.com/dmulloy2/ProtocolLib)
- [jedk1/BookUtil.java](https://www.spigotmc.org/threads/131549)
- [DarkBlade12/ReflectionUtils.java](https://github.com/DarkBlade12/ParticleEffect/blob/master/src/main/java/com/darkblade12/particleeffect/ReflectionUtils.java)
- [P2P-Develop/PeyangSuperLibrary](https://github.com/P2P-Develop/PeyangSuperLibrary)
- [PhantomUnicorns](https://stackoverflow.com/users/6727559/phantomunicorns)
- [Matrix API](https://matrix.rip/)