annotate README.txt @ 398:e36e6101b766

Restarting the level restores health
author Stefano Rivera <stefano@rivera.za.net>
date Sat, 07 Sep 2013 01:12:21 +0200
parents 67387621c61b
children 35243e090a30
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
1 Your Game Title
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
2 ===============
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
3
193
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
4 Entry in PyWeek #17 <http://www.pyweek.org/17/>
0
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
5 URL: http://pyweek.org/e/nagslang
193
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
6 Team: Cape Viper (leave the "Team: bit")
0
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
7 Members: YOUR TEAM MEMBERS (leave the "Members: bit")
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
8 License: see LICENSE.txt
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
9
193
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
10 Requirements
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
11 ============
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
12
287
67387621c61b Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents: 193
diff changeset
13 The game requires pygame and pymunk. Requirements can be installed by
67387621c61b Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents: 193
diff changeset
14 pip install -e .
67387621c61b Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents: 193
diff changeset
15 Or
67387621c61b Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents: 193
diff changeset
16 pip install -r requirements.txt
193
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
17
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
18 It was developed using python 2.7, pymunk 4.0 and pygame 1.9.2. Older
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
19 versions may or may not work.
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
20
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
21 The editor also requires Albow 2.2.0
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
22 (from http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/)
d862cc209de4 Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents: 0
diff changeset
23
0
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
24
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
25 Running the Game
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
26 ----------------
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
27
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
28 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
29
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
30 Othewise open a terminal / console and "cd" to the game directory and run:
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
31
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
32 python run_game.py
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
33
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
34
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
35 How to Play the Game
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
36 --------------------
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
37
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
38
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
39
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
40 Move the cursor around the screen with the mouse.
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
41
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
42 Press the left mouse button to fire the ducks.
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
43
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
44
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
45 Development notes
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
46 -----------------
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
47
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
48 Creating a source distribution with::
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
49
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
50 python setup.py sdist
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
51
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
52 You may also generate Windows executables and OS X applications::
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
53
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
54 python setup.py py2exe
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
55 python setup.py py2app
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
56
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
57 Upload files to PyWeek with::
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
58
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
59 python pyweek_upload.py
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
60
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
61 Upload to the Python Package Index with::
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
62
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
63 python setup.py register
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
64 python setup.py sdist upload
1ea8fa09b70f Add skellington
Neil Muller <drnlmuller@gmail.com>
parents:
diff changeset
65