]> git.lizzy.rs Git - worldedit.git/blobdiff - README.md
Replace worldedit.spiral with worldedit.pyramid, as well as related chat commands.
[worldedit.git] / README.md
index 84e2820c089fa1e69c48551fe4d813e522fd22ef..5324efb0284c1fc3493f53a3790c97c20b67a3c5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-WorldEdit v1.0 for MineTest 0.4
+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.
 
@@ -12,6 +12,14 @@ WorldEdit has a huge potential for abuse by untrusted players. Therefore, users
 
 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.
@@ -20,6 +28,12 @@ Each positions together define two opposing corners of the cube. With two opposi
 
 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
 --------
 
@@ -27,6 +41,14 @@ Commands
 
 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.
@@ -69,29 +91,102 @@ Replace all instances of <search node> with <place node> in the current WorldEdi
     //replace dirt flowers:flower_waterlily
     //replace flowers:flower_rose flowers:flower_tulip
 
-### //copy x/y/z <amount>
+### //hollowsphere <radius> <node>
+
+Add hollow sphere at WorldEdit position 1 with radius <radius>, composed of <node>.
+
+    //hollowsphere 5 dirt
+    //hollowsphere 12 default:glass
+    //hollowsphere 17 mesecons:mesecon
+
+### //sphere <radius> <node>
+
+Add sphere at WorldEdit position 1 with radius <radius>, composed of <node>.
+
+    //sphere 5 dirt
+    //sphere 12 default:glass
+    //sphere 17 mesecons:mesecon
+
+### //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>
 
-Copy the current WorldEdit region along the x/y/z axis by <amount> nodes.
+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
+    
+### //pyramid <height> <node>
+
+Add pyramid at WorldEdit position 1 with height <height>, composed of <node>.
+
+    //pyramid 8 dirt
+    //pyramid 5 default:glass
+    //pyramid 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 x/y/z/? <amount>
 
-Move the current WorldEdit region along the x/y/z axis by <amount> nodes.
+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 x/y/z/? <count>
 
-Stack the current WorldEdit region along the x/y/z axis <count> times.
+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
 
@@ -113,6 +208,20 @@ Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current
     //load some random filename
     //load huge_base
 
+### //metasave <file>
+
+Save the current WorldEdit region including metadata to "(world folder)/schems/<file>.wem".
+
+    //metasave some random filename
+    //metasave huge_base
+
+### //metaload <file>
+
+Load nodes and metadata from "(world folder)/schems/<file>.wem" with position 1 of the current WorldEdit region as the origin.
+
+    //metaload some random filename
+    //metaload huge_base
+
 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.
@@ -135,6 +244,36 @@ Replaces all instances of `searchnode` with `replacenode` in a region defined by
 
 Returns the number of nodes replaced.
 
+### worldedit.hollow_sphere = function(pos, radius, nodename)
+
+Adds a hollow sphere at `pos` with radius `radius`, composed of `nodename`.
+
+Returns the number of nodes added.
+
+### worldedit.sphere = function(pos, radius, nodename)
+
+Adds a sphere at `pos` with radius `radius`, composed of `nodename`.
+
+Returns the number of nodes added.
+
+### 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`, composed of `nodename`.
+
+Returns the number of nodes added.
+
+### worldedit.cylinder(pos, axis, length, radius, nodename)
+
+Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`.
+
+Returns the number of nodes added.
+
+### worldedit.pyramid(pos, height, nodename)
+
+Adds a pyramid at `pos` with height `height`.
+
+Returns the number of nodes added.
+
 ### 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.
@@ -149,10 +288,28 @@ 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.
+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.
+
 ### worldedit.dig(pos1, pos2)
 
 Digs a region defined by positions `pos1` and `pos2`.
@@ -171,6 +328,26 @@ Loads the nodes represented by string `value` at position `originpos`.
 
 Returns the number of nodes deserialized.
 
+### worldedit.deserialize_old(originpos, value)
+
+Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format.
+
+This function is deprecated, and should not be used unless there is a need to support legacy WorldEdit save files.
+
+Returns the number of nodes deserialized.
+
+### worldedit.metasave(pos1, pos2, file)
+
+Saves the nodes and meta defined by positions `pos1` and `pos2` into a file
+
+Returns the number of nodes saved
+
+### worldedit.metaload(pos1, file)
+
+Loads the nodes and meta from `file` to position `pos1`
+
+Returns the number of nodes loaded
+
 License
 -------
 Copyright 2012 sfan5 and Anthony Zhang (Temperest)
@@ -179,4 +356,4 @@ This mod is licensed under the [GNU Affero General Public License](http://www.gn
 
 Basically, this means everyone is free to use, modify, and distribute the files, as long as these modifications are also licensed the same way.
 
-Most importantly, the Affero variant of the GPL requires you to publish your modifications in source form, even if the mod is run only on the server, and not distributed.
\ No newline at end of file
+Most importantly, the Affero variant of the GPL requires you to publish your modifications in source form, even if the mod is run only on the server, and not distributed.