WorldEdit GUI support for new //cylinder functionality

[worldedit.git] / README.md

diff --git a/README.md b/README.md
index 224059e8bbb660a3a0c5c595b753db4562c42a8a..22dd7c741b85468ac7718c56228d31459ced9de9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-WorldEdit v1.0 for Minetest 0.4.8+
+WorldEdit v1.1 for Minetest 0.4.8+
 ==================================
 The ultimate in-game world editing tool for [Minetest](http://minetest.net/)! Tons of functionality to help with building, fixing, and more.
 
@@ -41,9 +41,9 @@ Interface
 ---------
 WorldEdit is accessed in-game in two main ways.
 
-The GUI adds a screen to each player's inventory that gives access to various WorldEdit functions. The [tutorial](Tutorial.md) and the [Chat Commands Reference](Chat Commands.md) may be helpful in learning to use it.
+The GUI adds a screen to each player's inventory that gives access to various WorldEdit functions. The [tutorial](Tutorial.md) and the [Chat Commands Reference](ChatCommands.md) may be helpful in learning to use it.
 
-The chat interface adds many chat commands that perform various WorldEdit powered tasks. It is documented in the [Chat Commands Reference](Chat Commands.md).
+The chat interface adds many chat commands that perform various WorldEdit powered tasks. It is documented in the [Chat Commands Reference](ChatCommands.md).
 
 Compatibility
 -------------
@@ -109,20 +109,24 @@ WorldEdit supports two different types of schematics.
 
 The first is the WorldEdit Schematic format, with the file extension ".we", and in some older versions, ".wem". There have been several previous versions of the WorldEdit Schematic format, but WorldEdit is capable of loading any past versions, and will always support them - there is no need to worry about schematics becoming obselete.
 
-The current version of the WorldEdit Schematic format, internally known as version 4, is essentially an array of node data tables in Lua 5.2 table syntax. Specifically:
-
-    return {
-        {
-            ["y"]      = <y-axis coordinate>,
-            ["x"]      = <x-axis coordinate>,
-            ["name"]   = <node name>,
-            ["z"]      = <z-axis coordinate>,
-            ["meta"]   = <metadata table>,
-            ["param2"] = <param2 value>,
-            ["param1"] = <y-axis coordinate>,
-        },
-        <...>
-    }
+As of version 5, WorldEdit schematics include a header.  The header is seperated from the content by a colon (`:`).  It contains fields seperated by commas (`,`).  Currently only one field is used, which contains the version in ASCII decimal.
+
+The current version of the WorldEdit Schematic format is essentially an array of node data tables in Lua 5.1 table syntax preceded by a header.
+Specifically it looks like this:
+
+       5:return {
+               {
+                       y      = <y-axis coordinate>,
+                       x      = <x-axis coordinate>,
+                       z      = <z-axis coordinate>,
+                       name   = <node name>,
+                       param1 = <param1 value>,
+                       param2 = <param2 value>,
+                       meta   = <metadata table>,
+               },
+               <...>
+       }
+
 
 The ordering of the values and minor aspects of the syntax, such as trailing commas or newlines, are not guaranteed to stay the same in future versions.