AndEngine 技术文档

1. 安装指南

环境要求

• Eclipse: 需要 ADT-17 或更高版本。
• IntelliJ IDEA: 需要手动添加 BuildConfig 类。

安装步骤

1. 克隆项目:

   git clone https://github.com/nicolasgramlich/AndEngine.git
   

2. 导入项目:
   • 在 Eclipse 中，选择 File -> Import -> Existing Projects into Workspace，然后选择克隆的项目目录。
   • 在 IntelliJ IDEA 中，选择 File -> New -> Project from Existing Sources，然后选择克隆的项目目录。
3. 配置 BuildConfig 类（仅适用于 IntelliJ IDEA）:
   • 在项目根包 org.andengine 下手动添加以下类：

     package org.andengine;
     
     public final class BuildConfig { 
         public final static boolean DEBUG = true;
     }
     

2. 项目的使用说明

分支说明

• OpenGL ES 2:
  • GLES2-AnchorCenter: 活跃开发中，支持最新的功能，坐标系统在左下角，支持强大的 AnchorCenter 系统。
  • GLES2: 不再活跃开发，支持的功能较少。
• OpenGL ES 1:
  • master: 不再活跃开发，支持几乎所有 Android 设备。

示例项目

• AndEngineExamples: 包含多个示例项目，帮助用户快速上手。
• AndEngineRobotiumExtensionExample: 包含 Robotium 扩展的示例。

测试项目

• AndEngineTest: 包含项目的单元测试。
• AndEngineRobotiumExtensionExampleTest: 包含 Robotium 扩展的单元测试。

扩展项目

• AndEngineAugmentedRealityExtension: 增强现实扩展。
• AndEngineLiveWallpaperExtension: 动态壁纸扩展。
• AndEngineMODPlayerExtension: MOD 播放器扩展。
• AndEngineMultiplayerExtension: 多人游戏扩展。
• AndEngineMultiTouchExtension: 多点触控扩展。
• AndEnginePhysicsBox2DExtension: Box2D 物理引擎扩展。
• AndEngineRobotiumExtension: Robotium 测试框架扩展。
• AndEngineScriptingExtension: 脚本扩展。
• AndEngineScriptingExtensionGenerator: 脚本扩展生成器。
• AndEngineSVGTextureRegionExtension: SVG 纹理区域扩展。
• AndEngineTexturePackerExtension: 纹理打包器扩展。
• AndEngineTMXTiledMapExtension: TMX 瓦片地图扩展。

3. 项目API使用文档

主要API

• Scene: 场景管理，用于管理游戏中的各个场景。
• Entity: 游戏对象的基类，所有游戏对象都继承自该类。
• Sprite: 用于显示2D图像的类。
• Camera: 用于管理游戏视角的类。
• PhysicsWorld: 用于管理物理世界的类，通常与 Box2D 扩展一起使用。

示例代码

// 创建一个场景
Scene scene = new Scene();

// 创建一个精灵
Sprite sprite = new Sprite(0, 0, textureRegion, vertexBufferObjectManager);

// 将精灵添加到场景中
scene.attachChild(sprite);

// 创建一个物理世界
PhysicsWorld physicsWorld = new PhysicsWorld(new Vector2(0, SensorManager.GRAVITY_EARTH), false);

// 将物理世界添加到场景中
scene.registerUpdateHandler(physicsWorld);

4. 项目安装方式

通过 Eclipse 安装

1. 确保已安装 ADT-17 或更高版本。
2. 导入项目到 Eclipse 中。
3. 配置项目依赖。

通过 IntelliJ IDEA 安装

1. 导入项目到 IntelliJ IDEA 中。
2. 手动添加 BuildConfig 类。
3. 配置项目依赖。

通过命令行安装

1. 克隆项目到本地。
2. 使用 Gradle 或 Maven 构建项目。

# 使用 Gradle 构建项目
./gradlew build

# 使用 Maven 构建项目
mvn clean install

通过以上步骤，您可以成功安装并使用 AndEngine 项目。