Add some installation notes
[erdslangetjie.git] / README.txt
1 Bane's Befuddlement
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: ICS - 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 Installation notes
17 ------------------
18
19 For Linux, I created a virtualenv and used pip install kivy to setup the latest
20 kivy environment. Pygame installation didn't work for me using pip, so I used
21 the system packages for that.
22
23 i.e.
24
25 $ virtualenv --system-site-packages ve
26 $ . ve/bin/activate
27 $ pip install -r requirements.txt  # to install kivy and cython
28
29 Running the Game
30 ----------------
31
32 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
33
34 Othewise open a terminal / console and "cd" to the game directory and run:
35
36   python run_game.py
37
38
39 Game blurb
40 ----------
41
42 Yet again. that annoying superhero has found and destroyed your secret lair.
43
44 This time, you were prepared. Your trusty servant, Igor, has laid out a cunning
45 maze leading to a secret underwater submarine that will allow you to flee
46 without being caught.
47
48 Of course, it would have been better if Igor had managed to get the map to you
49 before things got compilcated, but the lack of a map is but a minor setback.
50
51
52 How to Play the Game
53 --------------------
54
55 Navigate to the map exit before your nemesis catches up with you.
56
57 Move using the cursor keys, WASD or by dragging the player sprite with the mouse.
58
59 You always start each maze with a small lead, and can use gates to delay your
60 pursuer. Your pursuer is relentless, though, so don't take too long deciding
61 what to do. 
62
63 Options
64 ------
65
66 You can access the settings panel by pressing F1
67
68 Note that changing the start level only takes effect on the next run, since we
69 don't reload the config when that changes.
70
71
72 Development notes 
73 -----------------
74
75 Creating a source distribution with::
76
77    python setup.py sdist
78
79 You may also generate Windows executables and OS X applications::
80
81    python setup.py py2exe
82    python setup.py py2app
83
84 Upload files to PyWeek with::
85
86    python pyweek_upload.py
87
88 Upload to the Python Package Index with::
89
90    python setup.py register
91    python setup.py sdist upload
92