Merge pull request #94 from EuleMitKeule/develop

chore: release

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022 Lennard Beers
+
+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.

README.md

@@ -1,3 +1,4 @@
+[![Available on itch.io](https://img.shields.io/badge/-available%20on%20itch.io%20-blue)](https://eulemitkeule.itch.io/tanks-on-a-plain)
 [![CI](https://github.com/EuleMitKeule/github-gameoff-2022/actions/workflows/ci.yml/badge.svg)](https://github.com/EuleMitKeule/github-gameoff-2022/actions/workflows/ci.yml)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=EuleMitKeule_github-gameoff-2022&metric=coverage)](https://sonarcloud.io/summary/new_code?id=EuleMitKeule_github-gameoff-2022)
 [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=EuleMitKeule_github-gameoff-2022&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=EuleMitKeule_github-gameoff-2022)
@@ -9,8 +10,41 @@
 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=EuleMitKeule_github-gameoff-2022&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=EuleMitKeule_github-gameoff-2022)
 [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=EuleMitKeule_github-gameoff-2022&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=EuleMitKeule_github-gameoff-2022)
 
-# WorkingTitle
+# Tanks on a Plain
 
 > Our submission for the Github GameOff 2022 Game Jam.
 
-WorkingTitle is an open-source over-the-top action game made with the Unity engine.
+Tanks on a Plain is an open-source action game made with the Unity engine.<br>
+This years theme was **cliché**. We tried to integrate this by focussing on the gaming cliché of collecting power ups.
+
+## The Game
+
+Your goal is to survive as long as you can!
+
+You will encounter hoards of enemy tanks attacking you.<br>
+Destroy them and collect their power ups to gain strength.
+
+But beware, the enemy tanks will also collect and use the power ups to get even stronger!
+
+> WASD - Move<br>
+> Mouse - Aim<br>
+> Left Mouse - Shoot
+
+## Installation
+
+Download the [latest game binaries](https://github.com/EuleMitKeule/github-gameoff-2022/releases) according to your operating system, extract them and start the game.<br>
+You can also find the game on [itch.io](https://eulemitkeule.itch.io/tanks-on-a-plain).
+
+## Features
+
+* Flow Field Pathfinding
+* Power Up System
+* Difficulty Scaling System
+* Tilemap Chunking System
+* Projectile Ricochet Physics
+* Statistics Tracking
+* Test and Deployment CI including SonarCloud Code Scanning
+
+## Credits
+
+This project was made from scratch in one month by [Ben Korinth](https://github.com/mifiamigahna), [Niklas Held](https://github.com/niklasheld) and [Lennard Beers](https://github.com/EuleMitKeule).