Add README

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Maximilian Moser
+
+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

@@ -0,0 +1,26 @@
+# Maxman
+
+Maxman is a simple game inspired by classics such as `Pacman`, `Achtung, die Kurve!` (also known as `Zatacka`), and `Snake`.
+
+The basic goal is to grow by eating the food lying around until you're big enough to eat your competitors.
+
+
+## Getting started
+
+The game's requirements are listed in `Pipfile`, so you can just install them with `pipenv install`.
+To run the game after installing the requirements, use `pipenv run ./maxman.py`
+
+
+## Controls
+
+Per default, each player has their own key bindings (up, left, down, right):
+* Maxman (yellow): `w`, `a`, `s`, `d`
+* Blackman (black): `i`, `j`, `k`, `l`
+
+Other key bindings are:
+* `SPACE`: Pause/resume
+
+
+## Playing against AI
+
+If you want to play against the AI instead of other players, supply the corresponding CLI flag: `pipenv run ./maxman.py --ai`

maxman.py

@@ -1,3 +1,5 @@
+#!/bin/env python3
+
 import abc
 import dataclasses
 import math