游戏基础框架 - gameBase使用手册

本手册旨在指导您如何使用由Deepnight开发的游戏基础框架(gameBase)，该框架基于Heaps框架和Haxe语言。以下是详细的项目指南，包括目录结构、启动文件和配置文件的介绍。

1. 项目的目录结构及介绍

gameBase项目采用清晰的目录结构来组织代码和资源：

• src：核心源代码目录，包含了游戏的主要逻辑和实体定义。
• _base 和 hxml 子目录分别存放了编译的基础设置和Haxe命令脚本。
  • _base/hxml：基础的Haxe编译配置文件，用于不同平台的构建。
• gitignore：指定版本控制中忽略的文件或目录。
• CHANGELOG.md：记录了项目的重要变更日志。
• LICENSE：MIT许可证文件，详细说明了软件的授权方式。
• README.md：项目的快速入门和概要说明。
• setup.hxml：用于安装项目所需库的Haxe命令脚本。
• 其余如build/dev.hxml, build/directx.hxml, build/opengl.hxml, build/js.hxml, run_js/html等文件是针对特定编译目标的Haxe编译配置和运行命令。
• tools 目录可能包含辅助开发的工具或脚本。

2. 项目的启动文件介绍

gameBase的启动流程依赖于编译目标。对于大部分开发者，主要关注的是编译后的可执行文件或Web文件：

• DirectX/OpenGL版本：在完成对应平台的编译后，通过命令行运行hl bin\client.hl即可启动游戏（假设是在Windows环境下）。
• WebGL版本：编译到JavaScript后，通过浏览器运行run_js/html文件夹下的HTML文件即可启动游戏。

虽然直接的“启动文件”在Haxe开发中不是传统的概念（因为编译过程产生最终的启动程序），但上述操作指明了从编译产物到运行的路径。

3. 项目的配置文件介绍

主要配置文件

• HXML配置文件 (*.hxml)：这些文件位于_base/hxml和根目录下，是Haxe编译的核心配置。例如，setup.hxml用于安装必要的库，而如build/dev.hxml、build/directx.hxml等则是针对不同环境的编译指令集，它们控制编译选项、目标平台、附加库等。

• 其他配置：尽管gameBase的目录结构示例中没有明确指出其他形式的配置文件（如JSON或XML），但在实际应用中，游戏状态管理、资源路径、游戏设置等可能会使用自定义配置文件。在开发过程中，可以根据需要在src或其他适当位置添加此类文件。

为了使您的游戏项目顺利运行，仔细阅读并理解这些配置文件中的选项至关重要。通过修改这些HXML配置，您可以定制化编译流程以适应不同的开发需求和部署环境。记得在进行任何更改之前备份原有配置，并确保理解所做修改的影响。