Mercurial > mamba

annotate README.txt @ 536:7fd6ecb72fd7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some stuff about the level editor
author Neil Muller <drnlmuller@gmail.com>
date Sun, 18 Sep 2011 01:18:48 +0200
parents 2bc856561333
children e12a4ebeccfc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
519
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
1 Mutable Mamba
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
2 =============
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
3
5
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
4 Entry in PyWeek #13 <http://www.pyweek.org/13/>
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
5 URL: http://pyweek.org/e/mamba
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
6 Team: mamba
5
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
7 Members:
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
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
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
10 Gideon Visser
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
11 Jeremy Thurgood
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
12 Neil Muller
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
13 Simon Cross
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
14 Stefano Rivera
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
15 License: see LICENSE.txt
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
16
519
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
17 For licensing info about the various resources used in the game, see:
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
18 * data/sounds/sources.txt
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
19 * data/tiles/sources.txt
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
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
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
22
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
23 Running the Game
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
24 ----------------
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
25
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
26 On Windows or Mac OS X, locate the "run_game.pyw" file and double-click it.
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
27
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
28 Othewise open a terminal / console and "cd" to the game directory and run:
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
29
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
30 python run_game.py
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
31
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
32
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
33 How to Play the Game
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
34 --------------------
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
35
519
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
36 Move the snake around the screen with the arrow keys. Get to the exit without
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
37 crashing into anything. Collect interesting and exciting mutations along the
2bc856561333 Updated README.
Jeremy Thurgood <firxen@gmail.com>
parents: 451
diff changeset
38 way. Make your own levels and share them with the world.
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
39
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
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
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
44 The level editor is available from the main menu. Levels are saved as
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
45 user levels, and stored in $XDG_DATA_HOME/.mamba/user_levels
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
46 or $APPDATA/.mamba/user_levels.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
47
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
48 A new level can be created from one of the existing templates using new.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
49 Level properties, such as the name, filename and background music track
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
50 can be changed using the "Edit Level Metaddata" button.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
51
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
52 The level editor has 3 modes: placing tiles, placing things and editing
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
53 sprites.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
54
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
55 Tiles are level geography, such as floors, walls and so forth.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
56 Things are items that the snake can eat, such as rats.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
57 Sprites are special elements with more complex items which require
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
58 extra confiugration information, such as tunnels.
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
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
62 tile. The selection of tiles can be scrolled using the arrow buttons.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
63
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
64 Sprites can be placed as well. Sprites require parameters. Each sprite
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
65 needs a unique id tag, which can be any string without spaces, and
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
66 then additional parameters that depend on the type of sprite, usually
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
67 the id of another sprite. Sprites can be added, edited and deleted.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
68 Look at existing maps to see how the parameters can be used.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
69
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
70 Levels can be saved, and uploaded to be shared with other people. Shared
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
71 levels only become available after the levels have been curated.
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
72
5
4c1e15426f7c Update team details.
Simon Cross <hodgestar@gmail.com>
parents: 0
diff changeset
73 Development notes
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
74 -----------------
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
75
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
76 Creating a source distribution with::
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
77
451
7a64ebfe74ba Update README to add Desilu to team and correct build instructions.
Simon Cross <hodgestar@gmail.com>
parents: 28
diff changeset
78 ./scripts/build_unix.sh
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
79
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
80 You may also generate Windows executables and OS X applications::
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
81
536
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
82 Windows:
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
83 ./scripts/wine-py2exe
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
84 ./scripts/makensis
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
85
536
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
86 OS X:
7fd6ecb72fd7 Add some stuff about the level editor
Neil Muller <drnlmuller@gmail.com>
parents: 519
diff changeset
87 ./scripts/darwin-py2app.sh
0
08941f788c15 Skellington! Inna repo!
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
88