annotate README.txt @ 356:eabda3289a32

Clean up README.
author Simon Cross <hodgestar@gmail.com>
date Sat, 05 Sep 2009 23:55:18 +0000
parents 41761fcd7386
children d1ff514fb6d4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
1 Operation Fox Assault
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
2 =====================
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
3
3
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
4 Entry in PyWeek #9 <http://www.pyweek.org/9/>
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
5 Team: Rinkhals
356
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
6 Members:
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
7
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
8 Adrianna Pinska
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
9 Jeremy Thurgood
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
10 Neil Muller
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
11 Simon Cross
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
12 David Fraser
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
13
3
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
14 A first PyWeek entry by the hackers of the Cape Town Python Users Group
356
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
15 (CTPUG). The theme for PyWeek 9 was "Feather".
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
16
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
17
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
18 RUNNING THE GAME
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
19 ================
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
20
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
21 It is likely that you have obtain the game in one of four possible ways:
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
22
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
23 Windows:
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
24
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
25 If you have the Windows .zip file, unzip it, find foxassault.exe and
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
26 doube-click it to launch the game.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
27
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
28 Unix:
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
29
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
30 If you have the Unix .tgz file, make sure you have Python and pygame
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
31 installed. The extract the tar file and run "python run_game.py" from
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
32 inside the extracted folder.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
33
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
34 Mac OS X:
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
35
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
36 If you have the Mac OS X .dmg file, double-click to open it. Drag
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
37 Operation Fox Assault to Applications to install. Alternatively,
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
38 double-click on Operation Fox Assault to run it.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
39
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
40 Source:
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
41
356
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
42 If you have obtained the source directly, you need to install the
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
43 dependencies listed further down. Then run "python run_game.py".
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
44
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
45
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
46 HOW TO PLAY THE GAME
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
47 ====================
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
48
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
49 Save the chickens!
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
50
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
51 The aim of the game is to make as much money as possible from your chicken
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
52 farm. The problem is the foxes, which want to eat your chickens. Since hiring
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
53 guards is both too expensive and unreliable, the obvious solution is to help
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
54 the chickens defend themselves.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
55
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
56 You lose if you end a night with no chickens left.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
57
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
58 Depending on the game length you select, you win if you survive for two weeks,
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
59 three months or until you have chopped down all the trees in the forest and
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
60 caused the complete extinction of the fox population.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
61
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
62 Chickens only lay eggs in henhouses, and must stay on the egg for 2 days to
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
63 hatch a new chicken. Chickens that hatch in already full henhouses are
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
64 moved to just outside. If there is no space outside, they die immediately
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
65 from overcrowding.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
66
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
67
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
68 DEPENDENCIES
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
69 ============
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
70
3
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
71 You will need to install these before running the game:
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
72
3
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
73 Python: http://www.python.org/
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
74 PyGame: http://www.pygame.org/
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
75 Python Game Utilities: http://code.google.com/p/pgu
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
76
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
77
356
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
78 LICENSE
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
79 =======
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
80
356
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
81 GNU Public License, version 2 or later. See COPYING.
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
82 For authors see COPYRIGHT.
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
83
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
84
356
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
85 LINKS
eabda3289a32 Clean up README.
Simon Cross <hodgestar@gmail.com>
parents: 3
diff changeset
86 =====
2
e057e9483488 Added pyweek skellington.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
87
3
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
88 - http://www.python.org.za/pugs/cape-town/Pyweek9Entry
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
89 - IRC: #ctpug on Atrum (http://www.atrum.org)
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
90
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
91 - http://www.pyweek.org/9/
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
92 - IRC: #pyweek on FreeNode
41761fcd7386 Fold temporary README into README.txt template.
Simon Cross <hodgestar@gmail.com>
parents: 2
diff changeset
93 - http://search.twitter.com/search?q=pyweek