Mercurial > mamba
annotate README.txt @ 562:8473936c8884
Add quick-n-dirty conversion script
author | Neil Muller <drnlmuller@gmail.com> |
---|---|
date | Tue, 18 Oct 2011 12:46:27 +0200 |
parents | 30a5ded79313 |
children |
rev | line source |
---|---|
519 | 1 Mutable Mamba |
2 ============= | |
0 | 3 |
5 | 4 Entry in PyWeek #13 <http://www.pyweek.org/13/> |
0 | 5 URL: http://pyweek.org/e/mamba |
6 Team: mamba | |
5 | 7 Members: |
8 Adrianna Pinska | |
451
7a64ebfe74ba
Update README to add Desilu to team and correct build instructions.
Simon Cross <hodgestar@gmail.com>
parents:
28
diff
changeset
|
9 Desilu Crossman |
5 | 10 Gideon Visser |
11 Jeremy Thurgood | |
12 Neil Muller | |
13 Simon Cross | |
14 Stefano Rivera | |
0 | 15 License: see LICENSE.txt |
16 | |
519 | 17 For licensing info about the various resources used in the game, see: |
18 * data/sounds/sources.txt | |
19 * data/tiles/sources.txt | |
20 * data/music/sources.txt | |
28
f9a415bb17ad
Add note on sound sources to README
Neil Muller <drnlmuller@gmail.com>
parents:
5
diff
changeset
|
21 |
0 | 22 |
23 Running the Game | |
24 ---------------- | |
25 | |
26 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it. | |
27 | |
28 Othewise open a terminal / console and "cd" to the game directory and run: | |
29 | |
30 python run_game.py | |
31 | |
32 | |
33 How to Play the Game | |
34 -------------------- | |
35 | |
519 | 36 Move the snake around the screen with the arrow keys. Get to the exit without |
37 crashing into anything. Collect interesting and exciting mutations along the | |
38 way. Make your own levels and share them with the world. | |
0 | 39 |
40 | |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
41 Level Editor |
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
42 ------------ |
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
43 |
537
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
44 The level editor is available from the main menu. Levels are saved as user |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
45 levels, and stored in $XDG_DATA_HOME/.mamba/user_levels (i.e. |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
46 ~/.local/share/.mamba/user_levels) or $APPDATA/.mamba/user_levels on Windows. |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
47 |
537
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
48 A new level can be created from one of the existing templates using "New". |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
49 Level properties, such as the name, filename and background music track can be |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
50 changed using the "Edit Level Metadata" button. |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
51 |
552
b2e0f1267282
Add test mode to README. Tweak help text
Neil Muller <drnlmuller@gmail.com>
parents:
537
diff
changeset
|
52 The level editor has 4 modes: placing tiles, placing things, editing sprites |
b2e0f1267282
Add test mode to README. Tweak help text
Neil Muller <drnlmuller@gmail.com>
parents:
537
diff
changeset
|
53 and testing the level. |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
54 |
537
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
55 Tiles are level geography, such as floors, walls and so forth. Things are |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
56 items that the snake can eat, such as rats. Sprites are special elements with |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
57 more complex items which require extra configuration information, such as |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
58 tunnels. |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
59 |
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
60 To place tiles and things, select the desired element and click on the map to |
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
61 place the tile or thing. Deleting anything replaces the space with a floor |
537
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
62 tile (Right click also deletes). The selection of tiles can be scrolled using |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
63 the arrow buttons. |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
64 |
537
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
65 Sprites can be placed as well. Sprites require parameters. Each sprite needs a |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
66 unique id tag, which can be any string without spaces, and then additional |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
67 parameters that depend on the type of sprite, usually the id of another sprite. |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
68 Sprites can be added, edited and deleted. Look at existing maps to see how the |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
69 parameters can be used. |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
70 |
552
b2e0f1267282
Add test mode to README. Tweak help text
Neil Muller <drnlmuller@gmail.com>
parents:
537
diff
changeset
|
71 Test mode allows you to test the level without any clock running. The snake is |
b2e0f1267282
Add test mode to README. Tweak help text
Neil Muller <drnlmuller@gmail.com>
parents:
537
diff
changeset
|
72 moved using the cursor keys or by pressing space, but interacts with the level |
b2e0f1267282
Add test mode to README. Tweak help text
Neil Muller <drnlmuller@gmail.com>
parents:
537
diff
changeset
|
73 as in the actual game. Space will advance the snake one step, useful for |
556
30a5ded79313
Add replay note to README
Neil Muller <drnlmuller@gmail.com>
parents:
552
diff
changeset
|
74 testing arrows. Replays can be stored of progress on a run to date, which is |
30a5ded79313
Add replay note to README
Neil Muller <drnlmuller@gmail.com>
parents:
552
diff
changeset
|
75 useful for debugging levels. |
552
b2e0f1267282
Add test mode to README. Tweak help text
Neil Muller <drnlmuller@gmail.com>
parents:
537
diff
changeset
|
76 |
537
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
77 Levels can be saved, and uploaded to be shared with other people. Shared levels |
e12a4ebeccfc
Edits to Niel's LevelEditor README
Stefano Rivera <stefano@rivera.za.net>
parents:
536
diff
changeset
|
78 only become available after the levels have been curated by the Mamba team. |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
79 |
5 | 80 Development notes |
0 | 81 ----------------- |
82 | |
83 Creating a source distribution with:: | |
84 | |
451
7a64ebfe74ba
Update README to add Desilu to team and correct build instructions.
Simon Cross <hodgestar@gmail.com>
parents:
28
diff
changeset
|
85 ./scripts/build_unix.sh |
0 | 86 |
87 You may also generate Windows executables and OS X applications:: | |
88 | |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
89 Windows: |
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
90 ./scripts/wine-py2exe |
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
91 ./scripts/makensis |
0 | 92 |
536
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
93 OS X: |
7fd6ecb72fd7
Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents:
519
diff
changeset
|
94 ./scripts/darwin-py2app.sh |
0 | 95 |