diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e30f41d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 Jonathan Hager + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..99deeeb --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# The Restless Caverns - The best dungeon crawler of all time + + + +[[_TOC_]] + +## General Information + +"The Restless Caverns" is the best dungeon crawler the world has ever seen. + +The project was created by @GammelJAN and @JonathanHager +The project is still being updated, and far from finished. +The future of this game is **HUGE**. + +Engine: libGDX - https://libgdx.badlogicgames.com/ + + + +Credits for Entity-Sprites: +Calciumtrice +Twitter: https://twitter.com/calciumtrice +OpenGameArt: https://opengameart.org/users/calciumtrice + + + +## Installation + +#### newest Build: + +Download executable -jar here: +https://send.firefox.com/download/04dde021f2f23c45/#HErUzC8M5guBWYE-wRZLgg + + +## Known Issues + +## Controls + +**W**: move up +**A**: move left +**S**: move down +**D**: move right +**SPACE**: Attack +**F**: pick up +**R**: equip selected item +**scroll-wheel**: change selected item +**Q**: drop selected Item +**ESC**: pause Game / resume Game + +## Information about the code + +### Model + +### View + +### Control + +## Contact + +Mail: +therestlesscaverns@gmail.com + +GitLab: +@GammelJAN +@Jonathanhager \ No newline at end of file