Minecraft Console Controller - Backend

Overview

Minecraft Console Controller (以下MCC)はブラウザからサーバーを管理するためのコンソールを提供します。

HTTP通信のみ可能なネットワークからでもサーバーを操作したいというニーズに合わせて開発しました。

また、MCCはWeb3層構造に似た構造を持っています。このリポジトリでは、その中間にあたるWebAPIを提供します。

実際にMinecraftサーバーで稼働させるためにはMCC-Plugin が必要になります。

このサーバーを動かすには2つの手段が存在します。

このリポジトリから最新のReleaseを確認してダウンロードしてください。

その後、以下のコマンドから実行します。

$ java -jar ファイル名.jar

まずはこのリポジトリをクローンします。

$ git clone https://github.com/rokuosan/mcc-backend.git

その後、以下のコマンドから起動します。

$ gradlew bootRun

エンドポイント	メソッド	説明
/api/player/list	GET	オンラインのプレイヤーを返します。
/api/player/{uuid}	GET	プレイヤーリストからUUIDをもとにプレイヤーを探します。
/api/player/join	POST	POSTするJSONにあるプレイヤーを追加します。
/api/player/quit	POST	オンラインリストからパラメータのプレイヤーを削除します。
/api/server/memory	GET	サーバーのメモリ状況を取得します。

プレイヤーのリストを返します。

パラメータにはofflineを指定することができ、Bool値を使用します。

以下のように使用することですべてのプレイヤーを表示することができます。

/api/player/list?offline=true

主にプレイヤーに関する内容を扱います。

GET: uuidと一致するUUIDをもつプレイヤーデータを返します。 POST: uuidと一致するUUIDをもつプレイヤー情報を書き換えます。

プラグインが使用します。

プレイヤーが参加した時にPOSTされます。

リクエストボディにはJSON形式のプレイヤーデータがあります。

プラグインが使用します。

プレイヤーが切断したときにPOSTされます。

joinとは異なりリクエストボディには何もありませんが、パラメータにuuidを持ちます。

主にサーバー自体の情報を扱います。

メモリ情報を取得します。