AndEngineドキュメント 日本語訳

AndEngine にはドキュメントがありません - これは紛れもない事実です。 しかしニコラス・グラムリッチ氏はAndEngine の機能を網羅したアプリケーションと拡張クラスを作成しています。 Google Play storeのアプリを確認して、すぐに各機能を見ることができます。 またニコラス氏の' GitHubからこのアプリのソースコードをダウンロードすることもできます。 それでも足りない場合は、このAndEngineの本で基本的なことが全てよく説明されています。

このサンプルをコンパイルして実行するには、サンプル内で参照している拡張クラスをダウンロードして設定する必要があります。 ニコラス氏のGitHub にはサンプルで参照されている以外の拡張クラスもあり、AndEngine関連以外のプロジェクトも含まれているので注意してください。 To make it easier, let's work only with the extensions needed for AndEngine examples project.

Physics Box2D 拡張やLive Wallpaper拡張のような、便利なAndEngine 用の拡張クラスが多数あります。 これらはAndroid ライブラリプロジェクトとは分かれて存在しています。 このチュートリアルでは、サンプルプロジェクトで最も人気のある拡張クラスを設定する方法を説明します。 このチュートリアルは2013年の9月9日に書かれており、GitHub リポジトリに何らかの変更があった場合は情報が古いかもしれないので注意してください。 何かあれば、android@kul.isへメールを送ってお知らせください。

重要: 前回のチュートリアル入門編の内容を修正しました。 9月8日以前に上記チュートリアルを参照していた場合は、インポートするプロジェクト名をAndEngine-GLES2-AnchorCenterからAndEngineに変更しているので注意してください。 It's the correct way and it makes things easier later. チュートリアルを確認して、インポートの手順を再実行してください。

AndEngine Tutorial - Extensions and Examples This tutorial is part of AndEngine basics. Getting Started - How to set up your environment to work with AndEngine Extensions and Examples - AndEngine has very little documentation but great examples Using Git and GitHub - Alternative way how to download AndEngine sources Android Logging - Effective use of Android logging AndEngine has no documentation - that's a fact. However Nicolas Gramlich created an AndEngine application covering most of the AndEngine features and extensions as well. You can check the app in Google Play store to see the capabilities right now. And you can also download source codes of this app from Nicolas' GitHub. If it won't be enough, this book about AndEngine covers all of the basics as well. To compile and run the examples yourself, you need to download and setup the extensions referenced in the examples. Notice that there are more extensions than those referenced by examples and also Nicolas' GitHub contains more of his projects that relate to AndEngine. To make it easier, let's work only with the extensions needed for AndEngine examples project. There are many useful extensions for AndEngine like Physics Box2D extension or Live Wallpaper extension. These exists as separate Android Library projects. This tutorial is about how to setup the most popular extensions along with the Examples project. Note that this tutorial was written on 9th September 2013 and if something changes in the GitHub repositories, it might get outdated. Please let me know if that happens by sending mail to android@kul.is. Important: I have changed the previous tutorial Getting Started. If you have followed it before 8th September, please note that I have renamed the AndEngine-GLES2-AnchorCenter imported project to simply AndEngine. It's the correct way and it makes things easier later. Check the tutorial and recreate the import step.

必要な全てのAndEngine プロジェクトをダウンロードしてインポートする

基本的なAndEngineの設定をまだしていない場合は、最初のチュートリアル: 入門編から始めてください。 次にDownload Zipボタンをクリックしてプロジェクトをダウンロードしてください。 GLES2 - AnchorCenter ブランチを正しくダウンロードしていることを確認してください。 Git を直接使用すると良いかもしれませんが、それだと少し高度な話になります。

このチュートリアルでは、オリジナルのニコラス氏のGithub リポジトリから全てをダウンロードするやり方を説明します。 後で出てくるコード上のバグ修正部分のチュートリアルを飛ばしたい場合は、私が既に修正済みの特別バージョンをGitHubからダウンロードできます。 URLの"nicolasgramlich"を"sm4"に変更するだけです。: https://github.com/sm4/AndEngine/tree/GLES2-AnchorCenter

GitHubについて記載した別のチュートリアルでは、ソースをダウンロードする別の方法を説明しているので確認してください。

ダウンロードするプロジェクト:

• https://github.com/nicolasgramlich/AndEngineExamples/tree/GLES2-AnchorCenter
• https://github.com/nicolasgramlich/AndEngineAugmentedRealityExtension/tree/GLES2-AnchorCenter
• https://github.com/nicolasgramlich/AndEngineMODPlayerExtension - AnchorCenter版はありません (or GLES2 for that matter, it's about music)
• https://github.com/nicolasgramlich/AndEngineSVGTextureRegionExtension - AnchorCenter版はありません
• https://github.com/nicolasgramlich/AndEnginePhysicsBox2DExtension/tree/GLES2-AnchorCenter
• https://github.com/nicolasgramlich/AndEngineMultiplayerExtension/tree/GLES2-AnchorCenter
• https://github.com/nicolasgramlich/AndEngineTMXTiledMapExtension/tree/GLES2-AnchorCenter
• https://github.com/nicolasgramlich/AndEngineScriptingExtension - AnchorCenter版はありません
• https://github.com/nicolasgramlich/AndEngineCocosBuilderExtension/tree/GLES2-AnchorCenter
• https://github.com/sm4/AndEngineLiveWallpaperExtension/tree/GLES2-AnchorCenter
• https://github.com/nicolasgramlich/AndEngineCocosBuilderExtensionCCRotatingSpriteExtension/tree/GLES2-AnchorCenter
• https://github.com/sm4/AndEngineCocosBuilderExtensionCCRotatingSpriteExtension/tree/GLES2-AnchorCenter

上記全てのプロジェクトを、既にAndEngine プロジェクトを解凍してインポートしてあるワークスペースに解凍してください。 フォルダ名の語尾についている"-master", "-GLES2" , "-GLES2-AnchorCenter"を削るために、全てのフォルダ名を変更してください。 これらのフォルダ名はGitHubによって自動的に付けられます。  - Gitを使用した場合は、"GLES2-AnchorCenter"という名前のフォルダにならないでしょう。 全てのプロジェクトをインポートする方法については次の"GitHub"のチュートリアルで説明します。

Eclipseを起動して、ファイル -> インポート... -> Existing Projects into Workspaceの順に選択します。 「参照」をクリックして、「ルート･ディレクトリー」の項目でワークスペースのディレクトリを指定します。 以下のような画面が表示されるでしょう。もちろん、基本となる AndEngine プロジェクトは既にインポート済みでなければなりません。

完了 を押すと、コンソールビューに以下のようなメッセージが表示されるでしょう:

[2013-09-08 22:48:16 - AndEngineAugmentedRealityExtension] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEngineScriptingExtension] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEngineSVGTextureRegionExtension] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEnginePhysicsBox2DExtension] Unable to resolve target 'android-17'
[2013-09-08 22:48:16 - AndEngineMultiplayerExtension] Unable to resolve target 'android-17'
[2013-09-08 22:48:16 - AndEngineExamples] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEngineTMXTiledMapExtension] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEngineMODPlayerExtension] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEngineLiveWallpaperExtension] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEngineCocosBuilderExtensionCCRotatingSpriteExtension] Unable to resolve target 'android-15'
[2013-09-08 22:48:16 - AndEngineCocosBuilderExtension] Unable to resolve target 'android-15'

これは想定通りのものです。各プロジェクトでAndroid SDKの設定を修正する必要があります。

Download and import all required AndEngine projects Please start with my first tutorial: Getting Started, if you haven't already setup basic AndEngine. Next download the following projects by clicking on Download Zip button. Make sure you are downloading GLES2 - AnchorCenter branch where applicable. Using Git directly is better, but it's a more advanced topic. The tutorial shows you how to download everything from original Nicolas' Github repositories. If you want to skip the later part of the tutorial, where you fix bugs in the code, you can download my own version from GitHub. Simple change "nicolasgramlich" to "sm4" in the url: https://github.com/sm4/AndEngine/tree/GLES2-AnchorCenter Check my other tutorial on GitHub to see the alternative way to download the sources. Projects to download: https://github.com/nicolasgramlich/AndEngineExamples/tree/GLES2-AnchorCenter https://github.com/nicolasgramlich/AndEngineAugmentedRealityExtension/tree/GLES2-AnchorCenter https://github.com/nicolasgramlich/AndEngineMODPlayerExtension - doesn't have AnchorCenter version (or GLES2 for that matter, it's about music) https://github.com/nicolasgramlich/AndEngineSVGTextureRegionExtension - doesn't have AnchorCenter version https://github.com/nicolasgramlich/AndEnginePhysicsBox2DExtension/tree/GLES2-AnchorCenter https://github.com/nicolasgramlich/AndEngineMultiplayerExtension/tree/GLES2-AnchorCenter https://github.com/nicolasgramlich/AndEngineTMXTiledMapExtension/tree/GLES2-AnchorCenter https://github.com/nicolasgramlich/AndEngineScriptingExtension - doesn't have AnchorCenter version https://github.com/nicolasgramlich/AndEngineCocosBuilderExtension/tree/GLES2-AnchorCenter https://github.com/sm4/AndEngineLiveWallpaperExtension/tree/GLES2-AnchorCenter https://github.com/nicolasgramlich/AndEngineCocosBuilderExtensionCCRotatingSpriteExtension/tree/GLES2-AnchorCenter https://github.com/sm4/AndEngineCocosBuilderExtensionCCRotatingSpriteExtension/tree/GLES2-AnchorCenter Unpack all the projects in your workspace where you have already unpacked and imported AndEngine project. Rename all directories in order to remove the "-master", "-GLES2" or "-GLES2-AnchorCenter" suffix. These are created by GitHub  - if you use Git, you won't see directories named "GLES2-AnchorCenter". I will explain in the next tutorial the "GitHub" way of importing all projects Start Eclipse and select: File -> Import... -> Existing Projects into Workspace. Click Browse to select your workspace directory for Select root directory. This is what you should see now. Of course the AndEngine base project must be there already imported. Press Finish and you should get a message similar to this in console view: [2013-09-08 22:48:16 - AndEngineAugmentedRealityExtension] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEngineScriptingExtension] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEngineSVGTextureRegionExtension] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEnginePhysicsBox2DExtension] Unable to resolve target 'android-17' [2013-09-08 22:48:16 - AndEngineMultiplayerExtension] Unable to resolve target 'android-17' [2013-09-08 22:48:16 - AndEngineExamples] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEngineTMXTiledMapExtension] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEngineMODPlayerExtension] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEngineLiveWallpaperExtension] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEngineCocosBuilderExtensionCCRotatingSpriteExtension] Unable to resolve target 'android-15' [2013-09-08 22:48:16 - AndEngineCocosBuilderExtension] Unable to resolve target 'android-15' Now that was expected. You have to fix the Android SDK settings for each of the projects.

プロジェクトの設定を修正する

各プロジェクトで右クリックし、プロパティ→Androidの順に進みます。 そこに選択可能なオプションが一つ(Android 4.3)あるでしょう。Android 4.3のオプションをチェックしてください。 全ての拡張クラスとサンプルのプロジェクトでこの操作をしてください。 このチュートリアルを手順通りに進めた場合、サンプルプロジェクトのプロパティは以下のようになります:

Eclipseのメインメニュー上でプロジェクト -> クリーン -> すべてのプロジェクトをクリーンを選びます。 いくつかのプロジェクトはまだバグが残ったままなので、それらを修正しないとAndEngineExamples プロジェクトをコンパイルできません。

Fix the projects setup For each project, right click on it, select Properties and choose Android. There should be just one option to select (Android 4.3). Check the Android 4.3 option. Do this for all the extension and the Examples project. If you have followed the tutorial step-by-step this is what you should see in the Examples project properties: Select Project -> Clean -> Clean all projects from Eclipse main menu. You will notice that some projects still contain bugs and you are not able to compile the AndEngineExamples project before fixing them.

SVG 拡張クラスの問題

他の誰かが作成したプロジェクト、特にオープンソースを使用する場合は、そうした問題に対応しなければなりません。では、修正しましょう:

VGBaseBitmapTextureAtlasSource.java内に記述されている SVGBaseBitmapTextureAtlasSourceでは、抽象メソッドIBitmapTextureAtlasSource.onLoadBitmap(Bitmap$Config, boolean)を実装しなければなりません。

SVGBaseBitmapTextureAtlasSource.javaを開いて (Ctrl+Shift+R)、Eclipse のクイックフィックス機能を使います: 未実装のメソッドを追加します。 これで完了です。この問題は、SVG 拡張クラスにAnchorCenter 版がないために発生します。

SVG Extension problem When using somebody's projects, especially open source and free, you must count with such issues. Let's fix it: The type SVGBaseBitmapTextureAtlasSource must implement the inherited abstract method IBitmapTextureAtlasSource.onLoadBitmap(Bitmap$Config, boolean) in SVGBaseBitmapTextureAtlasSource.java Open SVGBaseBitmapTextureAtlasSource.java (Ctrl+Shift+R) and  use the Eclipse quick fix: Add unimplemented methods. That's it. The problem exists, because SVG extension doesn't have the AnchorCenter version.

Scripting 拡張クラスの問題

これに対処するにはいくつかの方法があります - サンプルから参照を削除して、それが原因で発生する問題を修正します。 もしくは、拡張クラスないの各問題を個別に修正できます。:

1. Eclipse のメインメニュ上で 検索 -> ファイルを使い、
   
   import org.andengine.util.color.Color;
   
   を
   
   
   import org.andengine.util.adt.color.Color;
   
   に置換します
2. RectangularShapeProxy クラスを削除します。- このクラスは AnchorCenter 版では使いません。

Scripting Extension problems There are few ways how to deal with this - you can remove the reference from Examples and then fix the problem that arise from there. Or you can try to fix each problem in this extension: 1) Use Search -> File in Eclipse main menu and replace import org.andengine.util.color.Color; with import org.andengine.util.adt.color.Color; 2) remove class RectangularShapeProxy - it's not used in AnchorCenter version.

AndEngine サンプルの問題

最後に、AndEngine サンプルプロジェクトの問題を解決します - 作業のほとんどは単にパッケージ名の変更だけです。 ファイル内で一括検索・置換を使い、サンプルプロジェクト内で以下のように置換を行います。

どの行で何を置換するのか必ず確認するようにしてください。この作業を完了した後も、まだエラーは残っています。 誤った例外処理が発生しているクラスをEclipse が教えてくれます。 ワークスペース内の全てのプロジェクトの全エラーを参照するには"問題"ビューを使います。

これらは大雑把なやり方で簡単に修正できます: 単に、問題が発生している全てのtry-catchのcatchブロックを、"Exception"のみに変更します。 これで完了です。このパターンの場合は簡単に検索・置換はできません。

まだエラーが残っている場合は、全ファイルを保存して全てのプロジェクトをクリーンします。 このチュートリアルどおりに作業したのであれは、Eclipseはエラーのない状態になります。 そうならなかった場合は、何かをやり忘れたのかもしれません。 自分で解決できない場合は、私宛のandroid@kul.isにメールを送ることができます。

AndEngine Examples problems Finally you can solve the AndEngine examples project problems - most of them are just renamed packages. Use the mass search & replace in files and replace the following in the examples project. Search Replace import org.andengine.extension.multiplayer.protocol import org.andengine.extension.multiplayer import org.andengine.extension.multiplayer.exception.BluetoothException; import org.andengine.util.exception.BluetoothException; import org.andengine.entity.particle.modifier.ExpireParticleInitializer; import org.andengine.entity.particle.initializer.ExpireParticleInitializer; import org.andengine.extension.multiplayer.util.IPUtils; import org.andengine.util.IPUtils; import org.andengine.extension.multiplayer.util.WifiUtils; import org.andengine.util.WifiUtils; if(!AndEngine.isDeviceSupported()) { if(!AndEngine.isDeviceSupported(this)) { Make sure you check where and what are you replacing. After you finish this, there will still be errors left. Eclipse will point you to the classes where wrong Exception handling occurs. Use "Problems" view to see all errors in all your projects in the workspace. These are easy to correct using this dirty fix: Simply change all catches in the problematic try-catch blocks to "Exception" only. And that's it. There is no easy search and replace pattern for this. Save all files and clean all projects if there are still any errors. If you followed this tutorial, you should have error free setup in your Eclipse. If not, maybe you forgot something. If you can't resolve it yourself, you can try sending me an email to android@kul.is.

サンプルを実行する

AndroidExamples プロジェクトを右クリックし、 実行 -> Android アプリケーションをクリックします。デバイス選択画面がポップアップ表示されたら、あなた Android 端末を選んでください。 楽しみましょう!

Run the examples Right click on the AndroidExamples project and select Run As -> Android Application. If the device selector pops up, select your Android device. Enjoy!

GitHub リポジトリの代用

AndEngine コミュニティメンバーの何人かは、既にこれらの問題を修正して独自のリポジトリで管理しています。 通常はいくつかエラーが修正されていますが、場合によっては最新版ではないこともあります。 フォーラムへ行って自分で検索することもできます。 こうした修正済みリポジトリで有名なものは以下があります:

• RealMayo氏のリポジトリ
• Nazgee氏のリポジトリ

ですが、私はこれらを使用していません。私のリポジトリを使用することもできます。 私のバージョンのAndEngine ではバグが修正済みです。

Alternative GitHub repositories Some members of the AndEngine community already fixed these problems and maintain their own repositories. They usually fix some errors along the way too, but sometimes their version is not the newest. You can go to forums and search for yourself. Some notable examples of such repositories are: RealMayo's repository Nazgee's repository I haven't used them though. Or you can use my repositories. My version of AndEngine has some bugs fixed.

---