-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.
# New users should see the [tutorial](Tutorial.md).
+
+
Installing
----------
-In order to use the WorldEdit GUI, you must have one of the following mods installed:
-
-* [Unified Inventory](https://forum.minetest.net/viewtopic.php?id=3933) (RECOMMENDED)
-* [Inventory++](https://forum.minetest.net/viewtopic.php?id=6204)
-
-Installation of Unified Inventory is highly recommended. If neither of these mods are installed, the WorldEdit GUI will not be available, though the rest of WorldEdit will work fine.
If you are using Windows, consider installing this mod using [MODSTER](https://forum.minetest.net/viewtopic.php?id=6497), a super simple mod installer that will take care of everything for you. If you are using MODSTER, skip directly to step 6 in the instructions below.
---------
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
-------------
WorldEdit works quite well with other mods, and does not have any known mod conflicts.
-WorldEdit GUI requires either [Unified Inventory](https://forum.minetest.net/viewtopic.php?id=3933) or [Inventory++](https://forum.minetest.net/viewtopic.php?id=6204) to be installed in order to use it. This is optional but highly recommended.
+WorldEdit GUI works with [Unified Inventory](https://forum.minetest.net/viewtopic.php?id=3933) and [Inventory++](https://forum.minetest.net/viewtopic.php?id=6204), but these are not required to use the mod.
+
+If you use any other inventory manager mods, note that they may conflict with the WorldEdit GUI. If this is the case, it may be necessary to disable them.
WorldEdit API
-------------
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.
The second is the Minetest Schematic format (MTS). The details of this format may be found in the Minetest documentation and are out of the scope of this document. Access to this format is done via specialized MTS commands such as `//mtschemcreate` and `//mtschemplace`.
+Authors
+-------
+WorldEdit would not be possible without the contributions of many developers and designers. Below, they are listed alphabetically:
+
+ cheapie
+ cornernote
+ cyisfor
+ electricface
+ kaeza
+ khonkhortisan
+ sfan5
+ ShadowNinja
+ spillz
+ Uberi/Temperest
+
License
-------
Copyright 2013 sfan5, Anthony Zhang (Uberi/Temperest), and Brett O'Donnell (cornernote).
projects / worldedit.git / blobdiff