comparison README.txt @ 641:35243e090a30

Update README.
author Simon Cross <hodgestar@gmail.com>
date Sun, 08 Sep 2013 01:45:35 +0200
parents 67387621c61b
children 2b9f3bd74635
comparison
equal deleted inserted replaced
640:5b8a436ed08f 641:35243e090a30
1 Your Game Title 1 Werewolf Sonata
2 =============== 2 ===============
3 3
4 Entry in PyWeek #17 <http://www.pyweek.org/17/> 4 Entry in PyWeek #17 <http://www.pyweek.org/17/>
5 URL: http://pyweek.org/e/nagslang 5
6 Team: Cape Viper (leave the "Team: bit") 6 URL:
7 Members: YOUR TEAM MEMBERS (leave the "Members: bit") 7 http://pyweek.org/e/nagslang
8 License: see LICENSE.txt 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
9 20
10 Requirements 21 Requirements
11 ============ 22 ============
12 23
13 The game requires pygame and pymunk. Requirements can be installed by 24 The game requires pygame and pymunk. Requirements can be installed by
25
14 pip install -e . 26 pip install -e .
27
15 Or 28 Or
29
16 pip install -r requirements.txt 30 pip install -r requirements.txt
17 31
18 It was developed using python 2.7, pymunk 4.0 and pygame 1.9.2. Older 32 It was developed using python 2.7, pymunk 4.0 and pygame 1.9.2. Older
19 versions may or may not work. 33 versions may or may not work.
20 34
21 The editor also requires Albow 2.2.0 35 The editor also requires Albow 2.2.0 from
22 (from http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/) 36 http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/
23 37
24 38
25 Running the Game 39 Running the Game
26 ---------------- 40 ----------------
27 41
33 47
34 48
35 How to Play the Game 49 How to Play the Game
36 -------------------- 50 --------------------
37 51
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.
38 62
39 63
40 Move the cursor around the screen with the mouse. 64 Development notes
41
42 Press the left mouse button to fire the ducks.
43
44
45 Development notes
46 ----------------- 65 -----------------
47 66
48 Creating a source distribution with:: 67 Creating a source distribution with::
49 68
50 python setup.py sdist 69 ./scripts/build_unix.sh
51 70
52 You may also generate Windows executables and OS X applications:: 71 You may also generate Windows executables and OS X applications::
53 72
54 python setup.py py2exe 73 python setup.py py2exe
55 python setup.py py2app 74 python setup.py py2app
56 75
57 Upload files to PyWeek with:: 76 Later you might be able to upload files to PyWeek with::
58 77
59 python pyweek_upload.py 78 python pyweek_upload.py
60 79
61 Upload to the Python Package Index with:: 80 Later you might be able to upload to the Python Package Index with::
62 81
63 python setup.py register 82 python setup.py register
64 python setup.py sdist upload 83 python setup.py sdist upload
65 84