From 99f5f4bbfad2fa9cd354695fc896b5699bb19111 Mon Sep 17 00:00:00 2001 From: Maximilian Moser Date: Wed, 28 Feb 2024 22:35:45 +0100 Subject: [PATCH] Add README --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e5bfc03 --- /dev/null +++ b/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`