This is a simple text-based dungeon game engine that uses a human-readable and extensible format for creating and playing dungeon games. The game engine is implemented in JavaScript and reads YAML files that define the game structure, levels, and player and monster status.
- Human-readable YAML format for defining games
- Kishōtenketsu plot structure for game stories
- ASCII dungeon representation for easy game level design
- Dynamic game and level loading
- Simple RPG mechanics with hit points, attack, and defense
- Clone or download this repository.
- Install a local web server, such as
serve
orhttp-server
, to serve the project files. - Open the
index.html
file in your browser to start playing the game. - Choose a game and follow the on-screen instructions.
To create your own game:
- Create a new folder inside the
games
directory and name it after your game. - Create one or more
.yaml
files inside your game folder, one for each level. - Define your game levels using the YAML format, specifying the opening and ending novels, ASCII dungeon layout, player status, and monster status.
Example level file structure:
opening_novel: |
Your opening novel text here.
dungeon_map: |
Your ASCII dungeon layout here.
ending_novel: |
Your ending novel text here.
If you have any ideas or suggestions for improving the game engine or adding new features, feel free to open an issue or submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.