モノビット MO エンジン for Unity セットアップガイド 2015 月 7 月 27 日株式会社モノビットセットアップガイド更新履歴版数日付改定履歴 0.4 2015 年 7 月 27 日提供パッケージのフォルダ構成の誤り備考を修正 0.3 2015 年 6 月 12 日 0.2 2015 年 6 月 9 日 Redis の誤記を修正。クライアントのインストールで［Master］フォルダを追加する項目を追記。 0.1 2015 年 5 月 29 日初版。 2015 年 5 月 1 日版オフィシャルドキュメントから分冊化。 2 セットアップガイド目次 1. はじめに ...................................................................................................................... 4 1.1. 概要 ...................................................................................................................... 4 1.2. 提供パッケージ ........................................................................................................ 4 2. 環境設定 ...................................................................................................................... 5 2.1. サーバ ................................................................................................................... 5 2.1.1. Mono の導入 (Mac、Linux) .................................................................................. 5 2.1.2. Web サーバの導入 .............................................................................................. 6 2.1.3. Redis の導入...................................................................................................... 7 2.2. 3. クライアント ........................................................................................................... 7 MO エンジンのインストール ............................................................................................. 9 3.1. サーバのインストール ............................................................................................... 9 3.1.1. MO エンジンサーバ ............................................................................................. 9 3.1.2. MatchingServer ................................................................................................. 9 3.1.3. BattleServer ..................................................................................................... 9 3.2. クライアントのインストール ..................................................................................... 10 3 セットアップガイド 1. はじめに本資料で MO エンジンの開発を行うために必要な環境を説明します。 1.1. 概要 MO エンジンは MO エンジンサーバと MO エンジンクライアントから成り立ちます。サーバ、及びクライアントはマルチプラットフォーム対応しています。各プラットフォームの導入手順を説明します。 1.2. 提供パッケージ MO エンジン Ver.1.0 のパッケージ構成は以下の通りとなります。 root ├─ │ │ ├─ │ ├─ │ │ │ │ │ │ └─ client......................................................... クライアント └ MOengineForUnity.unitypackage ............... MOengine クライアント用パッケージ document .................................................. ドキュメント server ....................................................... サーバ ├─ BattleInformationServer ....................... バトルインフォメーションサーバー ├─ BattleServer ....................................... バトルサーバー ├─ MatchingServer ................................... マッチングサーバー ├─ moweb............................................... MO ウェブサーバー └─ sync .................................................. sync サーバー tool ........................................................... ツール ├─ Mono 環境インストール shForCentOS ....... Mono 環境インストールについて ├─ MOScriptConverter .............................. MOScript コンバータとサンプルスクリプト └─ MOScriptConverterForMac .................... MOScript コンバータとサンプルスクリプト for Mac 4 セットアップガイド 2. 環境設定以下に MO エンジンの環境設定を説明します。 2.1. サーバ MO エンジンサーバ本体は、Windows、及び Linux 上で動作します。【必要環境】 Windows   Windows ７以上  .NET Framework 4.0 以降 ※ .NET Framework は、Windows に標準でインストールされています。 Mac, Linux   OS X 以上  コンパイラ gcc4.4.7-4 推奨  Mono 2.12 以降全プラットフォーム共通   Redis 1.0 以上 2.1.1. Mono の導入 (Mac、Linux) ※ Windows を使用する際は、.NET Framework の環境用使用するため Mono の導入は不要です。 Mono は、.NET Framework 互換の環境を実現するためのオープンソースのソフトウェア群です。 MO エンジンでは.NET Framework を使用しているため、Mac 及び Linux には Mono を実装する必要があります。 ① Mac に導入 Mac への Mono 導入の手順です。 Mac 用 Mono インストーラを以下の URL よりダウンロードしてください。［Download | Mono］ http://www.mono-project.com/download/ ② Linux に導入 Linux への Mono の導入手順です。 monoinstall.sh #!/bin/bash #TAG="タグ名" 5 セットアップガイド TAG=mono-3.12.0.77 DIR=`dirname "${0}"` cd ${DIR} mkdir monotemp cd monotemp yum install autoconf libtool automake gcc gcc-c++ gettext wget git -y git clone https://github.com/mono/mono.git cd mono/ sh autogen.sh git checkout ${TAG} make get-monolite-latest make make install mono –V インストールの確認インストール終了でバージョンを表示します。 Mono JIT compiler version 3.12.0 ((no/de2f33f 2015 年 2 月 27 日金曜日 21:20:59 JST) Copyright (C) 2002-2014 Novell, Inc, Xamarin Inc and Contributors. www.monoproject.com TLS: __thread SIGSEGV: altstack Notifications: epoll Architecture: amd64 Disabled: none Misc: softdebug LLVM: supported, not enabled. GC: sgen コンパイルと実行 mcs qiita.cs mono qiita.exe 2.1.2. Web サーバの導入 MO エンジンとゲームのデータベース間でデータのやり取りを仲介には Redis を使用します。 MO エンジンから Redis へ、php でデータの参照・書き込みを行うため Web サーバの導入を行います。 6 セットアップガイド 2.1.3. Redis の導入 MO エンジンと外部の DB 間でデータの受け渡しの仲介を KVS で行うため Redis を導入します。適宜環境に応じて Redis を導入してください。 2.2. クライアントクライアント側の MO エンジン本体、また併せて提供される各種ツール類は、Windows 上で動作します。【必要環境】 Windows 7 以降 ① .NET Framework 4.0 以降 ② Unity5 以降 ③ Cygwin ① .NET Framework 4.0 Windows 7 以降では、.NET Framework 4.0 は標準でインストールされています。 ② Unity5 以下のサイトの「Unity を手に入れる」項を参照の上インストールしてください。［Unity - Developer - はじめての Unity - 第 1 回世界の「骨格」をつくろう］ http://japan.unity3d.com/developer/document/tutorial/my-first-unity/01 ※ MO エンジンのツール類は、無料版 Unity で動作します。 ③ Cygwin MO エンジンでは、スクリプトを高速に処理するため、MO-Script をバイナリファイルへコンバートしてゲームに実装します。 Windows 環境で MO-Script をバイナリファイルへコンバートするために Cygwin をインストールし、環境設定を行う必要があります。インストール、及び環境設定の方法は、以下の通りです。 (1) Cygwin のインストール以下の URL からセットアッププログラムをダウンロードする https://www.cygwin.com/ トップーページにある左側のメニューより 7 セットアップガイド［Cygwin］ → ［Install Cygwin］とリンクを辿り、ページの指示に従いインストールを行います。  32bit OS の場合 https://cygwin.com/setup-x86.exe をインストールします。  64bit OS の場合 http://cygwin.com/setup-x86_64.exe をインストールします。上記リンクよりダウンロードしたファイルをダブルクリックします。 Cygwin のインストールについては下記ページをご参照くださ。［How to install Cygwin -Cygwin インストールの方法-］（外部サイト） http://www.sw.it.aoyama.ac.jp/2011/CP1/cygwin/ (2) Cygwin のパッケージ選択インストールで選択するパッケージは以下の通りです。 ※ 正しく選択されていない場合、コンバータが正常に動作しないのでご注意ください。 A) ［Perl］項目全て B) ［Devel］項目で［gcc］と名前が付くもの全てと［make］以上を［Install］に変更します。インストールが完了したら環境変数にパスを通します。 (3) 環境変数を設定 ※ Windows 8.1 の場合 ① デスクトップの PC アイコンを右クリックし、プロパティを選択、「システムの詳細設定」をクリックします。（または画面右下にマウスカーソルを移動して表示されるチャームの「検索」から「システムの詳細設定の表示」を検索してクリックします） ② 環境変数をクリックし、システム環境変数の項目から Path を選択し、編集をクリックします。 8 セットアップガイド ③ 一番右の部分に下記を追加します。 ;c:\cygwin64\bin ※ 先頭のセミコロンは必須です。 3. MO エンジンのインストール MO エンジンのインストール方法を説明します。 3.1. サーバのインストールサーバには MO エンジン本体とモノビット開発のリアルタイム通信ミドルウェアをインストールします。 3.1.1. MO エンジンサーバ <server>フォルダ内のすべてのファイルをサーバの任意のフォルダに配置します。なお、<server> 以下のフォルダ構成は変更しないでください。 <serever>直下の<data>以下にトール類で作成した各種データを置きます。 3.1.2. MatchingServer MatchingServer は、モノビット開発のリアルタイム通信を用いたゲームに特化した通信ミドルウェア M.L.N.（Monobit Lightning Network）の一機能です。設定された条件でネットワークにつながっているプレイヤーのマッチング処理を行います。 ※ ゲームのバトルパートのみを試す場合は、本機能を使用せずゲームにログインできるバトルモードがご利用いただけます。 ※ 2015 年 5 月 31 日現在、本項は記述中です。技術者向けの導入情報については M.L.N.の MatchingServer のドキュメントを参照してください。 3.1.3. BattleServer BattleServer は、モノビット開発のリアルタイム通信を用いたゲームに特化した通信ミドルウェア M.L.N. の一機能です。マッチングされたプレイヤーに対してバトルルームのインスタンスを作成します。 ※ ゲームのバトルパートのみを試す場合は、本機能を使用せずゲームにログインできるバトルモードがご利用いただけます。 ※ 2015 年 5 月 31 日現在、本項は記述中です。技術者向けの導入情報については M.L.N.の BattleServer のドキュメントを参照してください。 9 セットアップガイド 3.2. クライアントのインストールクライアントは Unity パッケージとして提供されます。 (1) プロジェクトを作成する Unity パッケージをインポートするために空のプロジェクトを作成します。 ① Unity の起動画面から、［New Project］をクリックします。 ② 「Project name」欄に任意のプロジェクト名を入力します。例) MOengineSample ※ プロジェクト名は半角英数文字を使用してください。 ③ 「Location」欄にパッケージを展開するパスを指定します。例) c:\Unity\MOengine ※ パスに含まれるフォルダ名に日本語 (マルチバイト文字) が含まれているとインポート時にエラーが発生する場合があります。フォルダ名には半角英数文字を使用してください。 ④ 上記操作完了後、［Create project］をクリックします。 ⑤ Unity エディタ上に空のプロジェクトが開きます。 (2) パッケージのインポート前項で作成した空のプロジェクト MO エンジンクライアント本体とサンプルアセットをインポートします。 ① MO エンジンクライアントのインストール MO エンジンクライアント本体をインストールします。各種エディタ、MO-Script・マスタ出力の機能のみをインポートします。 Unity メニューから［Assets］ → ［Import Packaeg］ → ［Custom Package］を選択し、開いたウィンドウ上で、提供されたパッケージの中で以下のファイルを選択して［開く］ボタンをクリックします。パス：ファイル名： moe_for_unity\client MOengineForUnity.unitypackage .............. MO エンジンクライント本体 10 セットアップガイド［Inporting package］のウィンドウが開きます。インポート元が［MOEngineForUnity］となっており、すべての項目が選ばれていることを確認して、［Import］ボタンをクリックします。インポートが終了した後、メニューに［MoEngine］と表示されていれば、MO エンジンクライアントのインストールは終了です。 11 セットアップガイド ※ MO エンジンインストール後は、Unity の起動画面に作成したプロジェクト名が表示されます。このプロジェクト名をクリックすることで、MOengine クライアント用パッケージが開きます。 ② サンプルアセットのインポートサンプル用のプレイヤー/エネミーユニットのアセットをインポートします。項番➀と同様に Unity メニューから［Assets］ → ［Import Packaeg］ → ［Custom Package］を選択し、開いたウィンドウ上で、以下のファイルを選択して［開く］ボタンをクリックします。パス：ファイル名： moe_for_unity\client MOengineForUnitySample.unitypackage ... サンプル用アセット［Inporting package］のウィンドウが開きます。インポート元が［MOengineForUnitySample］となっており、すべての項目が選ばれていることを確認して、［Import］ボタンをクリックします。 12 セットアップガイド Unity のメニューから［File］→［Open Scene］と選択し、ファイル選択ダイアログが表示されるので、以下のフォルダに移動してください。 C:\Unity\MoEngine\MoEngine\Sample\Assets\MOengine\Sample\Scenes 13 セットアップガイド開いたフォルダ内から “Title.unity” を選択し、［開く］をクリックします。［Scene］タブの画面にサンプルゲームのタイトル画面が表示されていればインポートは成功しています。 14 セットアップガイド (3) ［Master］フォルダのコピー MO エンジン専用の各種エディタで作成したゲームデータを保存する［Master］フォルダを Unity のプロジェクト内にコピーします。 Unity のデータではないため、このフォルダ内のデータは Unity のインポート操作でインポートすることができません。そのため、インポートとは別［Master］に Unity のプロジェクトフォルダ内にコピーします。コピー元： moe_for_unity\client\Master コピー先： C:\Unity\MOengine\Master C:\UnityMOengine\Master 内に以下のファイルが存在することを確認しましょう。 BulletMaster.json EnemyMaster.json EventMaster.json MasterDragonAI.xml MasterDragon_root.xml PlayerMaster.json simple_player_root.xml simple_spider_ai.xml simple_spider_root.xml spider_ai.xml spider_root.xml StageEditData.xml StageMaster.json UnitMaster.json (4) ゲーム画面サイズの設定 MOengine クライアント用サンプルパッケージの画面サイズはスマートフォン用に調整しています。 Unity のデフォルトの設定の場合 PC 用（PC, Mac & Linux Standalone）の画面表示設定になっているため、画面サイズの設定を行います。メニューの［File］ → ［Build Setting］を選択するとビルド設定ウィンドウが開きます。 15 セットアップガイド［Platform］で［Android］を選択し、［Switch Platform］をクリックします。設定が終了した後、ウィンドウ右上の［×］ボタンをクリックし、ウィンドウを閉じます。 16 セットアップガイド画面上部のタブを［Scene］から［Game］に切り替えます。ゲーム画面サイズのプルダウンリストから［16:10 Portrait (10:16)］を選択します。画面のアスペクト比がスマートフォンの比率になり、ゲームの全画面が表示されます。以上で、MO エンジンクライアント、及びサンプルゲームのアセットの導入は完了です。 17