README

マインクラフト専用のコンテンツに特化したプロジェクト環境です。

運用ポリシー

この環境はWebsocketサーバーを使った運用を前提としています。
スコアボードやコマンドを駆使して四苦八苦しながらイベントを判定したりするのを避け、サーバープログラミングを使って極力運用の負担を減らそうというのが狙いです。
基本的にはファミリー向けに楽しく遊べるものを目指しているので、グローバルコンテンツや商用利用は今のところ考えていません。

※この環境はデモ環境（"demo-project"）をベースに構築していますので、サーバーやクライアントの起動方法はデモ環境と全く同じです。また、チャット機能もそのまま引き継いでいます。

サーバーの起動

マインクラフトを含めたチャットサーバーの場合は、プロジェクトルートディレクトリで以下のコマンドを実行すれば起動できます。

> php worker app:minecraft-chat-server [<ポート番号>]

クライアントの起動

ブラウザの場合

以下のディレクトリにjQuery/React版のHTMLファイルが入っていますのでお好きな方をブラウザにドラッグ＆ドロップしてください（Webサーバーを起動する必要はありません）。

/app/client/jquery/chat.html（jQuery版）
/app/client/react/chat.html（React版）

マインクラフトの場合

マインクラフトのチャット画面で以下のコマンドを実行すれば接続できます。

> /wsserver localhost:10000/<ユーザー名>

サーバーへ接続後は普通にチャットできます。
以下のフォーマットで入力すれば特定のユーザーへプライベートコメントが送信できます。

> <メッセージ>#<宛先ユーザー名>

※マインクラフトはUWPアプリのため以下のコマンドを実行してループバックアドレスへのアクセスを許可しておく必要があります。

> CheckNetIsolation.exe LoopbackExempt -a -n="Microsoft.MinecraftUWP_8wekyb3d8bbwe"

補足

詳しい実装内容やコンテンツの詳細はこちらをご覧ください。

このプロジェクトにはデモ環境と同じ６種類のサーバーをご用意しています。
詳しい使い方はこちらをご覧ください。

このプロジェクトはLaravelと連携できます。
詳しい連携方法はこちらをご覧ください。

Contact Us

バグ報告やご要望などはこちらから受け付けております。

License

MIT, see LICENSE file.

socket-manager / contents-project

Maintainers

Details