Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonrobwebster authored Feb 27, 2021
1 parent 000f957 commit 371e7e7
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Cave
A 2d platformer with procedural level generation. Throw pots to get score while avoiding enemies.

# License
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.

# 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).

0 comments on commit 371e7e7

Please sign in to comment.