Add a sensible license
[koperkapel.git] / README
1 This is the repo for the koperkapel team entry for pyweek 21.
2
3 Quickstart
4 ==========
5
6 The koperkapel entry uses pygame-zero. Pygame-zero requires Python 3.
7 Instructions for installing pygame-zero on various operating systems
8 can be found at https://pygame-zero.readthedocs.org/en/latest/installation.html.
9
10 Running the game
11 ================
12
13 This game requires Python 3.
14
15 Run the game using:
16
17 $ python -m koperkapel
18
19 or, if your default python is Python 2,
20
21 $ python3 -m koperkapel
22
23 or just
24
25 $ ./run_game.py
26
27 Playing the game
28 ================
29
30
31 Arrow keys move the hero
32
33 'C' interacts with objects in the world you're standing on, and picks up items
34 in the world
35
36 'X' fires
37
38 'Z' switches to the roach management screen, which allows you to use some of
39 the items in the world, or switches back from the roach management window.
40
41 'V' switches you in and out of vehicles.
42
43 The roach management screen is mouse driven. Click on seats (the ovals on the
44 left) to select them. Click of the cockroaches on the right to add them to the
45 seats.
46
47 Serums can be applied by clicking on them in the inventory. Serums increase your
48 stats (strength, speed and intelligence). Currently only intelligence is useful
49 as it controls which keypads you can open.
50
51 Your health is dependant on the number of roaches you control. More roaches
52 means more health. When you take damage, roaches may die and your health drops.
53
54 ESC returns you to the main menu.