source: README.txt @ 641:35243e090a30

Last change on this file since 641:35243e090a30 was 641:35243e090a30, checked in by Simon Cross <hodgestar@…>, 7 years ago

Update README.

File size: 1.6 KB
Line 
1Werewolf Sonata
2===============
3
4Entry in PyWeek #17  <http://www.pyweek.org/17/>
5
6URL:
7    http://pyweek.org/e/nagslang
8Team:
9    Cape Viper
10Members:
11    Simon Cross
12    David Fraser
13    Neil Muller
14    Adrianna Pinska
15    Stefano Rivera
16    David Sharpe
17    Jeremy Thurgood
18License:
19    see LICENSE.txt
20
21Requirements
22============
23
24The game requires pygame and pymunk. Requirements can be installed by
25
26  pip install -e .
27
28Or
29
30  pip install -r requirements.txt
31
32It was developed using python 2.7, pymunk 4.0 and pygame 1.9.2. Older
33versions may or may not work.
34
35The editor also requires Albow 2.2.0 from
36http://www.cosc.canterbury.ac.nz/greg.ewing/python/Albow/
37
38
39Running the Game
40----------------
41
42On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
43
44Othewise open a terminal / console and "cd" to the game directory and run:
45
46  python run_game.py
47
48
49How to Play the Game
50--------------------
51
52Move Lyca, the werewolf insurance assessor, around the screen with the arrow
53keys or A, S, W, D.
54
55Fire a gun or claw aliens with X or CTRL.
56
57Change between werewolf and human by pressing C.
58
59Interact with doors and other objects using SPACE.
60
61There are no ducks.
62
63
64Development notes
65-----------------
66
67Creating a source distribution with::
68
69   ./scripts/build_unix.sh
70
71You may also generate Windows executables and OS X applications::
72
73   python setup.py py2exe
74   python setup.py py2app
75
76Later you might be able to upload files to PyWeek with::
77
78   python pyweek_upload.py
79
80Later you might be able to upload to the Python Package Index with::
81
82   python setup.py register
83   python setup.py sdist upload
84
Note: See TracBrowser for help on using the repository browser.