summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..184242e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# Disk Mayhem
+Disk Mayhem is a fun two players platformer fighter, where the last slicer alive wins.
+Quickly chaotic, each of the six arenas will put your skills to the test in a different way.
+Jump, slash and throw saws to the win. And most importantly, have fun!
+
+To play the game quickly, you can clone this repository and run it with LÖVE:
+```sh
+$ git clone <this repo clone URL> disk-mayhem
+$ love disk-mayhem
+```
+Two gamepads is the recommanded way to play.
+The jam build is also available at owo-team.itch.io
+
+# Who made this?
+This game was made by KikooDX (~kikoodx) and Massena (~massenouille) for the Disc Room
+game jam. It was integraly made in two weeks, and mistakes were made organisation wise.
+We hope than making this project free and open source will be appreciated.
+
+# How?
+For a framework we choosed LÖVE and amazing MIT libraries.
+We used sfxr for audio, Aseprite for graphics and Tiled for level design.
+
+## Libraries used
+- https://github.com/kikito/anim8
+- https://github.com/tesselode/baton
+- https://github.com/rxi/classic/
+- https://github.com/Nikaoto/deep
+- https://github.com/Ulydev/push
+- https://github.com/Ulydev/shack
+- https://github.com/themousery/vector.lua
+
+Big thank you to the LÖVE contributors and LÖVE libraries creators.
+
+# Assets used
+http://mfs.jp.org/ font.
+
+# License
+The code is licensed under MIT license, the rest is CC-BY-SA 4.0. See LICENSE for more details.