# HG changeset patch
# User Neil Muller <drnlmuller@gmail.com>
# Date 1316301528 -7200
# Node ID 7fd6ecb72fd7e1f17e6b2b31c239569f5e909239
# Parent  463434711e532041cfcf483c1328d569930c60a1
Add some stuff about the level editor

diff -r 463434711e53 -r 7fd6ecb72fd7 README.txt
--- a/README.txt	Sun Sep 18 01:17:03 2011 +0200
+++ b/README.txt	Sun Sep 18 01:18:48 2011 +0200
@@ -38,6 +38,38 @@
 way. Make your own levels and share them with the world.
 
 
+Level Editor
+------------
+
+The level editor is available from the main menu. Levels are saved as
+user levels, and stored in $XDG_DATA_HOME/.mamba/user_levels
+or $APPDATA/.mamba/user_levels.
+
+A new level can be created from one of the existing templates using new.
+Level properties, such as the name, filename and background music track
+can be changed using the "Edit Level Metaddata" button.
+
+The level editor has 3 modes: placing tiles, placing things and editing
+sprites.
+
+Tiles are level geography, such as floors, walls and so forth.
+Things are items that the snake can eat, such as rats.
+Sprites are special elements with more complex items which require
+extra confiugration information, such as tunnels.
+
+To place tiles and things, select the desired element and click on the map to
+place the tile or thing.  Deleting anything replaces the space with a floor
+tile. The selection of tiles can be scrolled using the arrow buttons.
+
+Sprites can be placed as well. Sprites require parameters. Each sprite
+needs a unique id tag, which can be any string without spaces, and
+then additional parameters that depend on the type of sprite, usually
+the id of another sprite. Sprites can be added, edited and deleted.
+Look at existing maps to see how the parameters can be used.
+
+Levels can be saved, and uploaded to be shared with other people. Shared
+levels only become available after the levels have been curated.
+
 Development notes
 -----------------
 
@@ -47,10 +79,10 @@
 
 You may also generate Windows executables and OS X applications::
 
-   ./scripts/wine-py2exe
-   ./scripts/darwin-py2app.sh
+   Windows:
+      ./scripts/wine-py2exe
+      ./scripts/makensis
 
-Upload files to PyWeek with::
+   OS X:
+      ./scripts/darwin-py2app.sh
 
-   python pyweek_upload.py
-