diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..ed7c8a4c93dcd195403379d1bba83b852b7e5110 --- /dev/null +++ b/README.en.md @@ -0,0 +1,53 @@ +This project is an action role-playing game (RPG) demonstration project developed using the Godot Engine. It includes implementations of fundamental game mechanics such as player control, enemy behavior, combat system, sound effects, and UI, making it suitable for learning Godot game development or serving as a starting point for RPG-style games. + +--- + +## 📁 Project Structure Overview + +- **Scripts/**: Contains GDScript files for game logic, such as player control, enemy behavior, and UI control. +- **YouTube Action RPG Resources/**: Directory for game assets, including images, sound effects, music, and UI elements. +- **scenes/**: Stores game scene files (`.tscn`), such as player scene, enemy scene, and world map. +- **tres/**: Stores resource files (e.g., `.tres`) used to save data objects within the game. +- **Other files**: Includes project configuration files (e.g., `project.godot`) and export presets (`export_presets.cfg`). + +--- + +## 🚀 How to Run the Project + +1. Install the [Godot Engine](https://godotengine.org/download/) (it is recommended to use a version compatible with the project). +2. Open Godot, select **"Open Project"**, navigate to this project folder, and import it. +3. Click the **"Run"** button to start the game. + +--- + +## 🧩 Key Functional Modules + +- **Player Control**: Implemented using `player.gd` for basic actions such as movement, attacking, and jumping. +- **Enemy Behavior**: For example, `bat.gd` controls the movement and attack logic of bat enemies. +- **Combat System**: Includes damage detection (`hitbox.gd` / `hurtbox.gd`) and health management (`hearts_ui.gd`). +- **UI System**: Displays player health, pause menu, and other interfaces. +- **Sound Effects and Music**: Enhances the gaming experience using audio files such as attack sounds and background music. + +--- + +## 📜 License + +This project follows an open-source license (please refer to the `LICENSE` file for detailed information). + +--- + +## 🤝 Contribution Guidelines + +Code contributions, bug fixes, or documentation improvements are welcome. Please submit a Pull Request or create an Issue for discussion. + +--- + +## 📬 Contact + +To contact the project maintainer, please check the project homepage or submit an Issue. + +--- + +## 📌 Notes + +This project is a demonstration intended for educational purposes and is suitable for beginners learning the Godot game development workflow. To extend functionality, you may build upon the existing modules. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..82f462095cc8458cccff3ce60b995690a20db473 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +该项目是一个基于 Godot 引擎开发的动作类角色扮演游戏(RPG)演示项目。它包含了基础的游戏机制实现,例如玩家控制、敌人行为、战斗系统、音效和 UI 等,适合用于学习 Godot 游戏开发或作为 RPG 类型游戏的起点。 + +--- + +## 📁 项目结构概览 + +- **Scripts/**: 包含游戏逻辑的 GDScript 脚本,例如玩家控制、敌人行为、UI 控制等。 +- **YouTube Action RPG Resources/**: 游戏资源目录,包含图像、音效、音乐和 UI 素材。 +- **sences/**: 存放游戏场景文件(`.tscn`),例如玩家场景、敌人场景、世界地图等。 +- **tres/**: 存放资源文件(如 `.tres`),用于保存游戏中的数据对象。 +- **其他文件**: 包括项目配置文件(如 `project.godot`)、导出配置(`export_presets.cfg`)等。 + +--- + +## 🚀 如何运行项目 + +1. 安装 [Godot Engine](https://godotengine.org/download/)(建议使用与项目兼容的版本)。 +2. 打开 Godot,选择 **“打开项目”**,浏览到本项目文件夹并导入。 +3. 点击 **“运行”** 按钮启动游戏。 + +--- + +## 🧩 主要功能模块 + +- **玩家控制**: 使用 `player.gd` 实现移动、攻击、跳跃等基础操作。 +- **敌人行为**: 例如 `bat.gd` 控制蝙蝠敌人的移动与攻击逻辑。 +- **战斗系统**: 包括伤害判定(`hitbox.gd` / `hurtbox.gd`)和生命值管理(`hearts_ui.gd`)。 +- **UI 系统**: 显示玩家生命值、暂停菜单等界面。 +- **音效与音乐**: 使用音效文件增强游戏体验,如攻击音效、背景音乐等。 + +--- + +## 📜 许可证 + +本项目遵循开源许可证(请查看 `LICENSE` 文件以获取详细信息)。 + +--- + +## 🤝 贡献指南 + +欢迎贡献代码、修复 bug 或改进文档。请提交 Pull Request 或创建 Issue 进行讨论。 + +--- + +## 📬 联系方式 + +如需联系项目维护者,请查看项目主页或提交 Issue。 + +--- + +## 📌 备注 + +该项目为教学用途的演示项目,适合初学者学习 Godot 游戏开发流程。如需扩展功能,可基于现有模块进行开发。 \ No newline at end of file