Tuts for noobs.
[naja.git] / README.txt
1 Codename Naja
2 =============
3
4 Entry in PyWeek #18  <http://www.pyweek.org/18/>
5
6 URL:
7     http://pyweek.org/e/naja
8 Team:
9     Naja
10 Members:
11     Simon Cross
12     Neil Muller
13     Adrianna PiƄska
14     Stefano Rivera
15     David Sharpe
16     Jeremy Thurgood
17 License:
18     see LICENSE.txt
19
20
21 Requirements
22 ============
23
24 The game requires pygame and pymunk. Requirements can be installed by
25
26   pip install -e .
27
28 Or
29
30   pip install -r requirements.txt
31
32 It was developed using python 2.7 and pygame 1.9.2. Older versions may or may
33 not work.
34
35
36 Running the Game
37 ----------------
38
39 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
40
41 Othewise open a terminal / console and "cd" to the game directory and run:
42
43   python run_game.py
44
45
46 How to Play the Game
47 --------------------
48
49 You are a robot, frantically trying to set the correct bits to gain points,
50 for reasons that are unlikely to ever become clear.
51
52 Your robot has 8 bits. Four bits control the directions you can move in,
53 3 allow you to unlock various actions, and the last, the Most Significant Bit,
54 makes everything work better.
55
56 The game has two phases. Movement and Actions.
57
58 During Movement, you can explore the board and learn about the available
59 tiles. Tiles you can legally move onto are highlighted. It's always possible
60 to stay on your current tile.
61
62 After moving, select an action from the tile. Most actions require various
63 bits to be set, although all tiles have a default action, although this may
64 be "No effect". After the action, the tile will be replaced with a new tile.
65
66 Some actions cost you health. When you run out of health, the game is over
67 and you lose.
68
69 If you have all three colour bits set, and are on the right tile, you can
70 gain a point, although this unsets all the colour bits. Once you have enough
71 points, you win the game, and there is much rejoicing.
72
73 (In true 8-bit style, the Konami Code is accepted.)
74
75 Development notes
76 -----------------
77
78 Creating a source distribution with::
79
80    python setup.py sdist
81
82 You may also generate Windows executables and OS X applications::
83
84    python setup.py py2exe
85    python setup.py py2app
86
87 Later you might be able to upload files to PyWeek with::
88
89    python pyweek_upload.py
90
91 Later you might be able to upload to the Python Package Index with::
92
93    python setup.py register
94    python setup.py sdist upload