From fa8be5179e01d883c283f592472531f199212fc5 Mon Sep 17 00:00:00 2001 From: Ameen Radwan Date: Fri, 7 Jun 2024 10:39:30 -0700 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index c2b8e6e..d9078cf 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,27 @@ A [gleam](https://gleam.run/) [rewrite](https://github.com/Acepie/GameAIBulletHell) of a bullet hell style game my friend and I made in college. The goal is mainly for myself to use gleam on a larger/more creative project. Uses [p5js bindings](https://github.com/Acepie/p5js_gleam) for running the project as a web game. +## How To Play + +### Controls + +- Use the arrow keys or WASD to move +- Press "space" to jump +- Press "shift" or hold down the mouse button to fire bullets +- Press "R" to restart + +## Features + +- Levels are procedurally generated +- Enemies use A\* to find their way toward the player +- Enemies avoid walls, pits, obstacles, and each other +- Enemies jump over pits when convenient and possible based on current velocity +- Enemy behaviors utilize behavior trees (patrolling until they spot the player, then chasing the player, and firing if within range) +- The player can jump over pits and enemies, but not over obstacles +- Pits instantly kill the player +- After getting hit, the player and enemies are briefly invulnerable to avoid continuous damage +- If the player kills all enemies in a room, they will be spawned in the next randomly-generated room + ## Development This project is using [esgleam](https://hexdocs.pm/esgleam/) for bundling the project into a web page.