-WorldEdit v0.5 for MineTest 0.4
-===============================
-In-game world editing for [MineTest](http://minetest.net/)! Tons of chat commands to help with building, fixing, and more.
+WorldEdit v1.0 for MineTest 0.4.7-dev+
+======================================
+The ultimate in-game world editing tool for [Minetest](http://minetest.net/)! Tons of functionality to help with building, fixing, and more.
-For more information, see the [forum topic](http://minetest.net/forum/viewtopic.php?id=572) at the MineTest forums.
+For more information, see the [forum topic](https://forum.minetest.net/viewtopic.php?id=572) at the Minetest forums.
+
+# New users should see the [tutorial](Tutorial.md).
Usage
-----
For in-game information about these commands, type `/help <command name>` in the chat. For example, to learn more about the `//copy` command, simply type `/help /copy` to display information relevant to copying a region.
-Axes
-----
-The coordinate system is the same as that used by MineTest; Y is upwards, X is perpendicular, and Z is parallel.
-
-When an axis is specified in a WorldEdit command, it is specified as one of the following values: x, y, z, or ?.
-
-The value ? represents the axis the player is currently facing. If the player is facing more than one axis, the axis the player face direction is closest to will be used.
-
-Regions
--------
-Most WorldEdit commands operate on regions. Regions are a set of two positions that define a 3D cube. They are local to each player and chat commands affect only the region for the player giving the commands.
-
-Each positions together define two opposing corners of the cube. With two opposing corners it is possible to determine both the location and dimensions of the region.
-
-Regions are not saved between server restarts. They start off as empty regions, and cannot be used with most WorldEdit commands until they are set to valid values.
-
-Markers
--------
-Entities are used to mark the location of the WorldEdit regions. They appear as boxes containing the number 1 or 2, and represent position 1 and 2 of the WorldEdit region, respectively.
-
-To remove the entities, simply punch them. This does not reset the positions themselves.
-
-Commands
---------
-
-### //reset
-
-Reset the region so that it is empty.
-
- //reset
-
-### //mark
-
-Show markers at the region positions.
-
- //mark
-
-### //pos1
-
-Set WorldEdit region position 1 to the player's location.
-
- //pos1
-
-### //pos2
-
-Set WorldEdit region position 2 to the player's location.
-
- //pos2
-
-### //p set/get
-
-Set WorldEdit region by punching two nodes, or display the current WorldEdit region.
-
- //p set
- //p get
-
-### //volume
-
-Display the volume of the current WorldEdit region.
-
- //volume
-
-### //set <node>
-
-Set the current WorldEdit region to <node>.
-
- //set dirt
- //set default:glass
- //set mesecons:mesecon
-
-### //replace <search node> <replace node>
-
-Replace all instances of <search node> with <place node> in the current WorldEdit region.
-
- //replace cobble stone
- //replace default:steelblock glass
- //replace dirt flowers:flower_waterlily
- //replace flowers:flower_rose flowers:flower_tulip
-
-### //hollowcylinder x/y/z/? <length> <radius> <node>
-
-Add hollow cylinder at WorldEdit position 1 along the x/y/z/? axis with length <length> and radius <radius>, composed of <node>.
-
- //hollowcylinder x +5 8 dirt
- //hollowcylinder y 28 10 default:glass
- //hollowcylinder z -12 3 mesecons:mesecon
- //hollowcylinder ? 2 4 stone
-
-### //cylinder x/y/z/? <length> <radius> <node>
-
-Add cylinder at WorldEdit position 1 along the x/y/z/? axis with length <length> and radius <radius>, composed of <node>.
-
- //cylinder x +5 8 dirt
- //cylinder y 28 10 default:glass
- //cylinder z -12 3 mesecons:mesecon
- //cylinder ? 2 4 stone
-
-### //spiral <size> <node>
-
-Add spiral at WorldEdit position 1 with size <size>, composed of <node>.
-
- //spiral 8 dirt
- //spiral 5 default:glass
- //spiral 2 stone
-
-
-### //copy x/y/z/? <amount>
-
-Copy the current WorldEdit region along the x/y/z/? axis by <amount> nodes.
-
- //copy x 15
- //copy y -7
- //copy z +4
- //copy ? 8
-
-### //move x/y/z/? <amount>
-
-Move the current WorldEdit positions and region along the x/y/z/? axis by <amount> nodes.
-
- //move x 15
- //move y -7
- //move z +4
- //move ? -1
-
-### //stack x/y/z/? <count>
-
-Stack the current WorldEdit region along the x/y/z/? axis <count> times.
-
- //stack x 3
- //stack y -1
- //stack z +5
- //stack ? 12
-
-### //transpose x/y/z/? x/y/z/?
-
-Transpose the current WorldEdit region along the x/y/z/? and x/y/z/? axes.
-
- //transpose x y
- //transpose x z
- //transpose y z
- //transpose ? y
-
-### //flip x/y/z/?
-
-Flip the current WorldEdit region along the x/y/z/? axis.
-
- //flip x
- //flip y
- //flip z
- //flip ?
-
-### //rotate x/y/z/? <angle>
-
-Rotate the current WorldEdit region along the x/y/z/? axis by angle <angle> (90 degree increment).
-
- //rotate x 90
- //rotate y 180
- //rotate z 270
- //rotate ? -90
-
-### //dig
-
-Dig the current WorldEdit region.
-
- //dig
-
-### //save <file>
-
-Save the current WorldEdit region to "(world folder)/schems/<file>.we".
-
- //save some random filename
- //save huge_base
-
-### //load <file>
-
-Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current WorldEdit region as the origin.
-
- //load some random filename
- //load huge_base
-
-### //metasave <file>
-
-Save the current WorldEdit region including metadata to "(world folder)/schems/<file>.wem".
+Chat Commands
+-------------
+WorldEdit is accessed in-game through an interface. By default, the mod distribution includes a chat interface for this purpose. It is documented in the [Chat Commands Reference](Chat Commands.md).
- //metasave some random filename
- //metasave huge_base
+If visual manipulation of nodes is desired, the [WorldEdit GUI](https://forum.minetest.net/viewtopic.php?id=3112) mod provides a simple interface with buttons and text entry fields for this purpose.
-### //metaload <file>
+Compatibility
+-------------
+This mod supports Minetest versions 0.4.7-dev and newer. Note that the stable Minetest 0.4.7 will not work.
-Load nodes and metadata from "(world folder)/schems/<file>.wem" with position 1 of the current WorldEdit region as the origin.
+Older versions of WorldEdit may work with older versions of Minetest, but are not recommended.
- //metaload some random filename
- //metaload huge_base
+WorldEdit works quite well with other mods, and does not have any known mod conflicts.
WorldEdit API
-------------
-WorldEdit exposes all significant functionality in a simple interface. Adding WorldEdit to the file "depends.txt" in your mod gives you access to all of the `worldedit` functions. These are useful if you're looking for high-performance node manipulation without all the hassle of writing tons of code.
-
-### worldedit.volume(pos1, pos2)
-
-Determines the volume of the region defined by positions `pos1` and `pos2`.
-
-Returns the volume.
-
-### worldedit.set(pos1, pos2, nodename)
-
-Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`.
-
-Returns the number of nodes set.
-
-### worldedit.replace(pos1, pos2, searchnode, replacenode)
-
-Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
-
-Returns the number of nodes replaced.
-
-### worldedit.hollow_cylinder(pos, axis, length, radius, nodename)
-
-Adds a hollow cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`.
-
-Returns the number of nodes added.
-
-### worldedit.cylinder(pos, axis, length, radius, nodename)
+WorldEdit exposes all significant functionality in a simple Lua interface. Adding WorldEdit to the file "depends.txt" in your mod gives you access to all of the `worldedit` functions. The API is useful for tasks such as high-performance node manipulation, alternative interfaces, and map creation.
-Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`.
+If you don't add WorldEdit to your "depends.txt" file, each file in the WorldEdit mod is also independent. For example, one may import the WorldEdit primitives API using the following code:
-Returns the number of nodes added.
+ dofile(minetest.get_modpath("worldedit").."/primitives.lua")
-### worldedit.spiral(pos, size, nodename)
+AGPLv3 compatible mods may further include WorldEdit files in their own mods. This may be useful if a modder wishes to completely avoid any dependencies on WorldEdit. Note that it is required to give credit to the authors.
-Adds a spiral at `pos` with size `size`.
+This API is documented in the [WorldEdit API Reference](WorldEdit API.md).
-Returns the number of nodes changed.
-
-### worldedit.copy(pos1, pos2, axis, amount)
-
-Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
-
-Returns the number of nodes copied.
-
-### worldedit.move(pos1, pos2, axis, amount)
-
-Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
-
-Returns the number of nodes moved.
-
-### worldedit.stack(pos1, pos2, axis, count)
-
-Duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times.
-
-Returns the number of nodes stacked.
-
-### worldedit.transpose(pos1, pos2, axis1, axis2)
-
-Transposes a region defined by the positions `pos1` and `pos2` between the `axis1` and `axis2` axes ("x" or "y" or "z").
-
-Returns the number of nodes transposed.
-
-### worldedit.flip(pos1, pos2, axis)
-
-Flips a region defined by the positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z").
-
-Returns the number of nodes flipped.
-
-### worldedit.rotate(pos1, pos2, angle)
-
-Rotates a region defined by the positions `pos1` and `pos2` by `angle` degrees clockwise around the y axis (supporting 90 degree increments only).
-
-Returns the number of nodes rotated.
+Axes
+----
+The coordinate system is the same as that used by MineTest; Y is upwards, X is perpendicular, and Z is parallel.
-### worldedit.dig(pos1, pos2)
+When an axis is specified in a WorldEdit command, it is specified as one of the following values: x, y, z, or ?.
-Digs a region defined by positions `pos1` and `pos2`.
+The value ? represents the axis the player is currently facing. If the player is facing more than one axis, the axis the player face direction is closest to will be used.
-Returns the number of nodes dug.
+Nodes
+-----
+Node names are required for many types of commands that identify or modify specific types of nodes. They can be specified in a number of ways.
-### worldedit.serialize(pos1, pos2)
+First, by description - the tooltip that appears when hovering over the item in an inventory. This is case insensitive and includes values such as "Cobblestone" and "bronze block". Note that certain commands (namely, `//replace` and `//replaceinverse`) do not support descriptions that contain spaces in the `<searchnode>` field.
-Converts the region defined by positions `pos1` and `pos2` into a single string.
+Second, by name - the node name that is defined by code, but without the mod name prefix. This is case sensitive and includes values such as "piston_normal_off" and "cactus". Nodes defined in the `default` mod always take precedence over other nodes when searching for the correct one, and if there are multiple possible nodes (such as "a:celery" and "b:celery"), one is chosen in no particular order.
-Returns the serialized data and the number of nodes serialized.
+Finally, by full name - the unambiguous identifier of the node, prefixes and all. This is case sensitive and includes values such as "default:stone" and "mesecons:wire_00000000_off".
-### worldedit.deserialize(originpos, value)
+The node name "air" can be used anywhere a normal node name can, and acts as a blank node. This is useful for clearing or removing nodes. For example, `//set air` would remove all the nodes in the current WorldEdit region. Similarly, `//sphere 10 air`, when WorldEdit position 1 underground, would dig a large sphere out of the ground.
-Loads the nodes represented by string `value` at position `originpos`.
+Regions
+-------
+Most WorldEdit commands operate on regions. Regions are a set of two positions that define a 3D cuboid. They are local to each player and chat commands affect only the region for the player giving the commands.
-Returns the number of nodes deserialized.
+Each positions together define two opposing corners of the cube. With two opposing corners it is possible to determine both the location and dimensions of the region.
-### worldedit.deserialize_old(originpos, value)
+Regions are not saved between server restarts. They start off as empty regions, and cannot be used with most WorldEdit commands until they are set to valid values.
-Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format.
+Markers
+-------
+Entities are used to mark the location of the WorldEdit regions. They appear as boxes containing the number 1 or 2, and represent position 1 and 2 of the WorldEdit region, respectively.
-This function is deprecated, and should not be used unless there is a need to support legacy WorldEdit save files.
+To remove the entities, simply punch them. This does not reset the positions themselves.
-Returns the number of nodes deserialized.
+Schematics
+----------
+WorldEdit supports two different types of schematics.
-### worldedit.metasave(pos1, pos2, file)
+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.
-Saves the nodes and meta defined by positions `pos1` and `pos2` into a file
+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:
-Returns the number of nodes saved
+ 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>,
+ },
+ <...>
+ }
-### worldedit.metaload(pos1, file)
+Value ordering and minor aspects of the syntax, such as trailing commas or newlines, are not guaranteed.
-Loads the nodes and meta from `file` to position `pos1`
+The WorldEdit Schematic format is accessed via the WorldEdit API, or WorldEdit serialization chat commands such as `//serialize` and `//deserialize`.
-Returns the number of nodes loaded
+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`.
License
-------
-Copyright 2012 sfan5 and Anthony Zhang (Temperest)
+Copyright 2013 sfan5, Anthony Zhang (Uberi/Temperest), and Brett O'Donnell (cornernote).
This mod is licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0.html).
projects / worldedit.git / blobdiff