annotate README.txt @ 286:0dbb50d07764

Poke the current state before checking to see if there is text in case the world has changed and it is time for the state machine to move on.
author Simon Cross <hodgestar@gmail.com>
date Fri, 08 Apr 2011 20:58:12 +0200
parents df7dc1fdf8c4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
138
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
1 Nine Tales
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
2 ==========
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
3
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
4 Entry in PyWeek #12 <http://www.pyweek.org/12/>
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
5 URL: http://pyweek.org/e/skaapsteker
138
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
6 Team: Skaapsteker
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
7 Members: Adrianna Pinska, Anna Malczyk, Jeremy Thurgood, Neil Muller,
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
8 Oliver Hambsch, Simon Cross, Stefano Rivera
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
9 License: MIT, see LICENSE.txt
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
10
3
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
11 Dependancies
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
12 ------------
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
13
f0c108bee0b2 Supporting Python 2.[67]
Stefano Rivera <stefano@rivera.za.net>
parents: 1
diff changeset
14 Python >= 2.6 (not Python 3)
138
80472fc8f24d Update README and LICENCE
Stefano Rivera <stefano@rivera.za.net>
parents: 3
diff changeset
15 pygame >= 1.8
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
16
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
17 Running the Game
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
18 ----------------
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
19
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
20 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
21
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
22 Othewise open a terminal / console and "cd" to the game directory and run:
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
23
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
24 python run_game.py
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
25
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
26
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
27 How to Play the Game
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
28 --------------------
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
29
140
df7dc1fdf8c4 Update instructions for the playing the game (just a test commit from work really).
Simon Cross <hodgestar+hg@gmail.com>
parents: 138
diff changeset
30 Use arrow keys and Enter to navigate menus.
df7dc1fdf8c4 Update instructions for the playing the game (just a test commit from work really).
Simon Cross <hodgestar+hg@gmail.com>
parents: 138
diff changeset
31
df7dc1fdf8c4 Update instructions for the playing the game (just a test commit from work really).
Simon Cross <hodgestar+hg@gmail.com>
parents: 138
diff changeset
32 Use arrow keys to move the kitsune around the screen. X and Z are your fire
df7dc1fdf8c4 Update instructions for the playing the game (just a test commit from work really).
Simon Cross <hodgestar+hg@gmail.com>
parents: 138
diff changeset
33 buttons. Press Q or Escape to quit.
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
34
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
35
140
df7dc1fdf8c4 Update instructions for the playing the game (just a test commit from work really).
Simon Cross <hodgestar+hg@gmail.com>
parents: 138
diff changeset
36 Development notes
0
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
37 -----------------
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
38
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
39 Creating a source distribution with::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
40
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
41 python setup.py sdist
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
42
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
43 You may also generate Windows executables and OS X applications::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
44
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
45 python setup.py py2exe
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
46 python setup.py py2app
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
47
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
48 Upload files to PyWeek with::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
49
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
50 python pyweek_upload.py
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
51
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
52 Upload to the Python Package Index with::
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
53
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
54 python setup.py register
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
55 python setup.py sdist upload
d6fd1a0b192a Commit skellington.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
56