PeyangBanServer

概要

Bukkit, Spigot, BungeeCordのプラグインのサーバ機能です。
BANの管理ができます。 プラグイン自体はここから入手可能です。

通信方式

HTTP1.1を採用しています。

使い方

$ java -jar <JARファイル名>

で起動できます。

初期設定

• サーバーを起動します。
  $ java -jar <ファイル> で起動してください。
• /path/to/PeyangBanServer/config.ymlを編集してください。

編集推奨項目

• database
  デフォルトでは、SQLiteが使用可能になっています。
  ですが、MySQLを使用したい場合等もあることでしょう。その場合は、
  適当にggって設定してください。

必須項目

• edit
  editは、設定ファイルを生成し、内容を確認したことを判定するために使用されます。
  必ず、trueにセットしてください。
• con.port
  デフォルトポート番号は、810を使用しているゾ。
  ３桁番号なので、被る可能性があるゾ。
  32768等のキリのいい番号を推奨します。

認証方式

このサーバでは、トークンによる認証をしています。
トークンはtoken.sigファイルに保存されており、データフォルダに作成されます。
リクエストヘッダーにtoken: <Token>を、全ての通信に使用してください。

通信ドキュメント

Swaggerにより自動生成されたドキュメントを公開いたしました。

謝辞

このサーバは、以下のAPI/ライブラリを使用しております。

• brettwooldridge/HikariCP
• P2P-Develop/PeyangSuperLibrary
• xerial/sqlite-jdbc
• FasterXML/jackson
• apache/commons-lang
• mysql/mysql-connector-java