diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..d891912ad32d7fdd54e4fe9cb0d441a7192df022 --- /dev/null +++ b/README.en.md @@ -0,0 +1,55 @@ +This is a Godot game project that implements an Action RPG style combat system. The project contains game scripts, assets, and scenes for building a 2D RPG game with combat mechanics. + +## Features + +- Player movement and combat controls +- Enemy AI (bat enemy type implemented) +- Health system with heart UI display +- Sound effects for combat actions +- Pause menu functionality +- 2D tile-based world system with grass, cliffs, and dirt tiles +- Hit detection system with hitboxes and hurtboxes + +## Project Structure + +- **Scripts/** - Contains all game logic in GDScript files +- **YouTube Action RPG Resources/** - Game assets including: + - Enemy sprites (bat) + - Player character sprites + - Sound effects for combat and UI + - UI elements (hearts, buttons) + - World tiles and background elements +- **Scenes/** - Game scenes including player, enemies, and world +- **tres/** - Resource files for game objects + +## Getting Started + +1. Install Godot Engine (3.x or 4.x depending on project requirements) +2. Import the project using the project.godot file +3. Explore scenes in the **Scenes/** directory to understand game structure +4. Review **Scripts/** for game logic implementation + +## Usage + +The project provides a complete combat system framework that can be extended with: +- Additional enemy types +- New player abilities +- Expanded UI elements +- Additional world tiles and environments + +To run the game, open the main scene in Godot and click the play button. + +## Contributing + +This project could benefit from contributions in: +- Expanding the combat system +- Adding new enemy types +- Creating additional world environments +- Improving the UI system +- Adding more detailed documentation + +Please make sure to follow the existing code style when making contributions. + +## License + +This project is open source under the MIT License - see the LICENSE file for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..361a4808127b176a9fbed3881fb632783bf1cf91 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +This is a Godot game project that implements an Action RPG style combat system. The project contains game scripts, assets, and scenes for building a 2D RPG game with combat mechanics. + +## Features + +- Player movement and combat controls +- Enemy AI (bat enemy type implemented) +- Health system with heart UI display +- Sound effects for combat actions +- Pause menu functionality +- 2D tile-based world system with grass, cliffs, and dirt tiles +- Hit detection system with hitboxes and hurtboxes + +## Project Structure + +- **Scripts/** - Contains all game logic in GDScript files +- **YouTube Action RPG Resources/** - Game assets including: + - Enemy sprites (bat) + - Player character sprites + - Sound effects for combat and UI + - UI elements (hearts, buttons) + - World tiles and background elements +- **sences/** - Game scenes including player, enemies, and world +- **tres/** - Resource files for game objects + +## Getting Started + +1. Install Godot Engine (3.x or 4.x depending on project requirements) +2. Import the project using the project.godot file +3. Explore scenes in the sences/ directory to understand game structure +4. Review Scripts/ for game logic implementation + +## Usage + +The project provides a complete combat system framework that can be extended with: +- Additional enemy types +- New player abilities +- Expanded UI elements +- Additional world tiles and environments + +To run the game, open the main scene in Godot and click the play button. + +## Contributing + +This project could benefit from contributions in: +- Expanding the combat system +- Adding new enemy types +- Creating additional world environments +- Improving the UI system +- Adding more detailed documentation + +Please make sure to follow the existing code style when making contributions. + +## License + +This project is open source under the MIT License - see the LICENSE file for details. \ No newline at end of file