Add gameplay notes to README. Tweak instructions
[erdslangetjie.git] / README.txt
1 Peter's Thread Snake
2 =====================
3
4 Entry in PyWeek #16  <http://www.pyweek.org/16/>
5 URL: http://www.pyweek.org/e/erdslangetjie
6 Team: erdslangetjie
7 Members: Neil Muller (drnlm)
8 License: see LICENSE.txt
9
10
11 Requirements
12 ------------
13
14 This was developed using pygame 1.9.1 and kivy 1.6.0.
15
16
17 Running the Game
18 ----------------
19
20 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
21
22 Othewise open a terminal / console and "cd" to the game directory and run:
23
24   python run_game.py
25
26
27 Game blurb
28 ----------
29
30 Yet again. that annoying superhero has found and destroyed your secret lair.
31
32 This time, you were prepared. Your trusty servant, Igor, has laid out a cunning
33 maze leading to a secret underwater submarine that will allow you to flee
34 without being caught.
35
36 Of course, it would have been better if Igore had managed to get the map to you
37 before things got compilcated, but the lack of a map is but a minor setback.
38
39
40 How to Play the Game
41 --------------------
42
43 Navigate to the map exit before your nemesis catches up with you.
44
45 Move using the cursor keys, WASD or by dragging the player sprite with the mouse.
46
47 You always start each maze with a small lead, and can use gates to delay your
48 pursuer. Your pursuer is relentless, though, so don't take too long deciding
49 what to do. 
50
51
52 Development notes 
53 -----------------
54
55 Creating a source distribution with::
56
57    python setup.py sdist
58
59 You may also generate Windows executables and OS X applications::
60
61    python setup.py py2exe
62    python setup.py py2app
63
64 Upload files to PyWeek with::
65
66    python pyweek_upload.py
67
68 Upload to the Python Package Index with::
69
70    python setup.py register
71    python setup.py sdist upload
72