From 0f890253dd7ff491bbfcc284766a7d14db3e8a24 Mon Sep 17 00:00:00 2001 From: Jonathan Hager Date: Sat, 26 Sep 2020 15:08:04 +0200 Subject: [PATCH] README started --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index b2931e5..4760406 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # ProtectTheMonster +[[_TOC_]] + +## General Information + +"Protect the Monster" has been created for the (NoImage Gamejam)[https://itch.io/jam/no-image-jam]. It was developed by @JonathanHager and @GammelJAN. The main goal of this game is to prevent the monster +from eating the humans that run towards it. + +## Installation +You can find the newest Jar file in *core/build/libs/*. If you wish to compile your own, you need to have the JDK and Gradle installed. Then run *./gradlew desktop:dist* in the root directory of the project. +If you happen to be on Windows or any non-Unix platform, go get a good operating system (not MacOS!). + +## Known Issues +The collisions should represent collisions in the real world. The physics for this system were written by ourselves, so problems may occur. + +## Controls + +Drag your mouse to create new walls that block of the humans. + +## Information about the code + +### Model + +### View + +### Control + +## Contact + +Mail: +therestlesscaverns@gmail.com + +GitLab: +@GammelJAN +@JonathanHager + +