鯰の住処

Namazuが真面目な話を書きます

MonoGameを使ってWindows/Androidでソースコードを共有しよう

初めまして、Namazuです。 これはXamarin Advent Calendar2016の14日目の記事です。 今回はMonoGameのお話をしたいと思います。

MonoGameとは?

XNAを移植したゲームフレームワークです。使用する言語はC# XNAMicroSoftが開発したゲームエンジンで、WindowsやWindowsPhone、Xboxにおいてソースコードをほとんど共通にして動作させることが可能なフレームワークです。

ソースコードを共有!

なんか素晴らしい響きですがXNAでは対応するプラットフォームが少なすぎますよね?? そこでMonoGameの出番です。MonoGameの対応するプラットフォームは以下の通り!!

大体ゲームを作ろうとして困ることはないほどの数です。 とくに、AndroidiOSMac OS Xに対応してくれているのがとてもありがたいです。

MonoGameを最大限生かすために

さて、それではMonoGameの利点を最大化するためにはどうするか。 ズバリ、この二つを組み合わせて使うことです!

出ました!!!!Xamarin!!!!!!!!

XamarinでAPI等を提供してもらって、MonoGameの仕組みとVisual StudioのSharedProjectを活かすと…? pico1_03.png pico2_03.png piko3_03.png

複数プラットフォームでソースコードをほとんど共有化!!

やったぜ!!

さらにリソースの読み込みも共有化できちゃう!!

実際に書いてみる

流石にゲーム作るのは大変なので画像表示するだけで許してください。 今回は、WindowsAndroidで同じコードで動かしてみます。

のインストールは各自で行ってください。 (多分これ読んでる人たちプロだから大丈夫だと信じてる)

それでは、VisualStudioを起動して

 File->New->Project->Installed/Templates/Visual C#/MonoGame->MonoGame Windows Project

を作成します。 ProjectNameとSolutionNameは、 Solution ├WindowsProject ├AndroidProject └SharedProject という構造を考えて決めてください。 今回は forAdC ├forWindows ├forAndroid └SharedProject という名前をつけました。

しばらくするとエディタの準備が整うので、右側のSolutionExplorerからSolution'forAdC'を右クリックして

Add->New Project->Installed/Templates/Visual C#/MonoGame->MonoGame Android Project

からAndroid用のプロジェクトを作成して追加してください。 ここでまたプロジェクト名を決めることができます。(デフォルトはGame1) 同様に、

Add->New Project->Installed/Templates/Visual C#/Windows/SharedProject

から共有用プロジェクトを作成して追加してください。

すると、以下のような画面になるかと思います。 image まだ中身は何も弄っていません。

それでは、早速まとめましょうか。 forWindowsでは始めにProgram.csを起動しGame1.csを呼び出す形になっています。 forAndroidでは初めにActivity1.csを起動しGame1.csを呼び出す形になっています。 Game1.csの内容はほぼ同一ですので、これをまとめることができます。

Game1.csをSharedProjectに移動してそれを各プロジェクトから呼び出す形にしましょう。

forWindowsかforAndroidのどちらかからGame1.csをSharedProjectにドラッグ&ドロップでコピーしましょう。 そして、SharedProject以下のGame1.csのnamespaceを「SharedProject」(SharedProjectのプロジェクト名と同一)にします。

その後forWindowsとforAndroidのGame1.csを削除してください。

この時点でforWindowsのProgram.csを見てみると、

new Game1()

の部分でエラーが出ています。参照すべきGame1.csが見つからないからですね。 SolutionExplorerのforWindowsを右クリックし、Add ReferenceからSharedProjectを追加します。 その後SharedProjectをインポートします。

using SharedProject;

ここまで正しく書いてもSharedProjectが見つからないというエラーが出ることもありますが、一度ソリューションを閉じて再度開いてみると直ります。ソリューションファイルを読み込み直さなくても正常にビルドできます。

これで前準備が整いました。ビルドしてみてください。 青い画面が表示されたら勝ちです。

それでは、画像を追加しましょうか。

コードを書く前に、画像を準備しておかなければなりません。 MonoGameではコンテンツ(リソース)は別途ビルドする必要があります。

forWindowsのContent->Content.mgcbをエクスプローラで開きダブルクリックし、MonoGame Pipelineを起動します。 File->Newから新しいmgcbファイルを作成します。 場所は実はどこでも良いのですが、共有化してる感じを出すためにエクスプローラーでforAdCフォルダ直下にContentフォルダを作り、その下にContent.mgcbを新しく作成してください。 image その後、MonoGame Pipelineの画面が少しおかしいので引っ張って直します。 直したあとはこんな感じになります。 image その後、Add Existing Itemから追加したい画像ファイルを選択してください。 追加する際はCopy the file to the directoryを選択してください。

そしてBuildからビルドします。 ※Add Existing Item(ファイルのアイコン)、Build(歯車のアイコン)はツールバーから選択できます。 こんな感じになれば成功です。 image 成功したらMonoGame Pipelineは閉じてしまって構いません。

それでは新しく作成したContent.mgcbをforWindows,forAndroidで読み込めるようにしましょう。 まずはforWindowsについて、Content以下にあるContent.mgcbを削除してください。 そして、SourceExplorer上でContentフォルダを右クリックしてAdd->Add Existing Itemから先ほど作成したContent.mgcbを追加してください。その際、「Add」ではなく「Add as a link」を選択するようにしてください。 するとSourceExplorerにリンクとしてのContent.mgcbが表示されますので、右クリックしてPropertyのBuild ActionをMonoGameContentReferenceに設定してください。 forAndroidでも同様の作業を行ってください。

それではコードを書き換えます。 Game1.csを以下のように書き換えてください。(コピペで構いません) なお、Namazuとあるところは追加した画像のファイル名(拡張子なし)としてください。

using Microsoft.Xna.Framework;
using Microsoft.Xna.Framework.Graphics;
using Microsoft.Xna.Framework.Input;

namespace SharedProject
{
    public class Game1 : Game
    {
        GraphicsDeviceManager graphics;
        SpriteBatch spriteBatch;
        Texture2D texture;
        public Game1()
        {
            graphics = new GraphicsDeviceManager(this);
            Content.RootDirectory = "Content";

            graphics.IsFullScreen = false;
            graphics.PreferredBackBufferWidth = 800;
            graphics.PreferredBackBufferHeight = 480;
            graphics.SupportedOrientations = DisplayOrientation.LandscapeLeft | DisplayOrientation.LandscapeRight;
        }

        protected override void Initialize()
        {
            // TODO: Add your initialization logic here

            base.Initialize();
        }

        protected override void LoadContent()
        {
            // Create a new SpriteBatch, which can be used to draw textures.
            spriteBatch = new SpriteBatch(GraphicsDevice);
            texture = Content.Load<Texture2D>("Namazu");

            // TODO: use this.Content to load your game content here
        }

        protected override void UnloadContent()
        {
            // TODO: Unload any non ContentManager content here
        }

        protected override void Update(GameTime gameTime)
        {
            if (GamePad.GetState(PlayerIndex.One).Buttons.Back == ButtonState.Pressed)
                Exit();

            // TODO: Add your update logic here

            base.Update(gameTime);
        }

        protected override void Draw(GameTime gameTime)
        {
            GraphicsDevice.Clear(Color.CornflowerBlue);

            // TODO: Add your drawing code here

            spriteBatch.Begin();
            spriteBatch.Draw(texture, new Rectangle(0, 0, 400, 400), Color.White);
            spriteBatch.End();

            base.Draw(gameTime);
        }
    }
}

さて、ここまでで必要な作業は終了です。 実際に表示してみましょう。 forWindows image

forAndroid 5662.png

できたー!!!!!!

ということで今回やることは以上です。 お付き合いありがとうございました。

MonoGameの抱える問題

  • 日本語文献が少ない
  • Androidの文献が少ない

くらいでしょうか? XNAのdocumentを読んでも具体的な実装方法が分からず試行錯誤、なんてこともしょっちゅうです。 もう少し日本語で分かりやすくしてくれれば日本でも普及していくと思うのですが… 私も日本語文献の一助になればと思いブログを書いておりますのでよろしければそちらもご覧ください。

参考文献