diff --git a/README.md b/README.md new file mode 100644 index 0000000..9702576 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Cave +A 2d platformer with procedural level generation. Throw pots to get score while avoiding enemies. + +# License +Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. + +# Usage +For use with the [Godot engine](https://godotengine.org/). Built with Godot 3.2.3. + +# Features +- A procedurally generated platformer, similar to one found in Spelunky +- Finite state machine implementations for AI and player movement +- Player UI +- Pause screen with persistent options settings +- Many bugs + +# External links +A playable version of the game can be downloaded on [itch.io](https://jrberyllium.itch.io/cave).