Mercurial > nagslang
annotate README.txt @ 651:9bc02ea5f9d8
Someone forgot the sheep!
author | David Sharpe <decoydavid@gmail.com> |
---|---|
date | Sun, 08 Sep 2013 02:09:25 +0200 |
parents | 35243e090a30 |
children | 2b9f3bd74635 |
rev | line source |
---|---|
641 | 1 Werewolf Sonata |
0 | 2 =============== |
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/> |
641 | 5 |
6 URL: | |
7 http://pyweek.org/e/nagslang | |
8 Team: | |
9 Cape Viper | |
10 Members: | |
11 Simon Cross | |
12 David Fraser | |
13 Neil Muller | |
14 Adrianna Pinska | |
15 Stefano Rivera | |
16 David Sharpe | |
17 Jeremy Thurgood | |
18 License: | |
19 see LICENSE.txt | |
0 | 20 |
193
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
21 Requirements |
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
22 ============ |
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
23 |
287
67387621c61b
Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents:
193
diff
changeset
|
24 The game requires pygame and pymunk. Requirements can be installed by |
641 | 25 |
287
67387621c61b
Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents:
193
diff
changeset
|
26 pip install -e . |
641 | 27 |
287
67387621c61b
Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents:
193
diff
changeset
|
28 Or |
641 | 29 |
287
67387621c61b
Added requirements.txt and use it from setup.py
David Fraser <davidf@sjsoft.com>
parents:
193
diff
changeset
|
30 pip install -r requirements.txt |
193
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
31 |
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
32 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
|
33 versions may or may not work. |
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
34 |
641 | 35 The editor also requires Albow 2.2.0 from |
36 http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/ | |
193
d862cc209de4
Add some notes on requirements to the readme
Neil Muller <drnlmuller@gmail.com>
parents:
0
diff
changeset
|
37 |
0 | 38 |
39 Running the Game | |
40 ---------------- | |
41 | |
42 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it. | |
43 | |
44 Othewise open a terminal / console and "cd" to the game directory and run: | |
45 | |
46 python run_game.py | |
47 | |
48 | |
49 How to Play the Game | |
50 -------------------- | |
51 | |
641 | 52 Move Lyca, the werewolf insurance assessor, around the screen with the arrow |
53 keys or A, S, W, D. | |
54 | |
55 Fire a gun or claw aliens with X or CTRL. | |
56 | |
57 Change between werewolf and human by pressing C. | |
58 | |
59 Interact with doors and other objects using SPACE. | |
60 | |
61 There are no ducks. | |
0 | 62 |
63 | |
641 | 64 Development notes |
0 | 65 ----------------- |
66 | |
67 Creating a source distribution with:: | |
68 | |
641 | 69 ./scripts/build_unix.sh |
0 | 70 |
71 You may also generate Windows executables and OS X applications:: | |
72 | |
73 python setup.py py2exe | |
74 python setup.py py2app | |
75 | |
641 | 76 Later you might be able to upload files to PyWeek with:: |
0 | 77 |
78 python pyweek_upload.py | |
79 | |
641 | 80 Later you might be able to upload to the Python Package Index with:: |
0 | 81 |
82 python setup.py register | |
83 python setup.py sdist upload | |
84 |