README.md

   1 WorldEdit v0.5 for MineTest 0.4
   2 ===============================
   3 In-game world editing for [MineTest](http://minetest.net/)! Tons of chat commands to help with building, fixing, and more.
   4
   5 For more information, see the [forum topic](http://minetest.net/forum/viewtopic.php?id=572) at the MineTest forums.
   6
   7 Usage
   8 -----
   9 WorldEdit works primarily through chat commands. Depending on your key bindings, you can invoke chat entry with the "t" key, and open the chat console with the "F10" key.
  10
  11 WorldEdit has a huge potential for abuse by untrusted players. Therefore, users will not be able to use WorldEdit unless they have the "worldedit" privelege. This is available by default in single player, but in multiplayer the permission must be explicitly given by someone with the right credentials, using the follwoing chat command: `/grant <player name> worldedit`. This privelege can later be removed using the following chat command: `/revoke <player name> worldedit`.
  12
  13 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.
  14
  15 Regions
  16 -------
  17 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.
  18
  19 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.
  20
  21 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.
  22
  23 Markers
  24 -------
  25 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.
  26
  27 To remove the entities, simply punch them. This does not reset the positions themselves.
  28
  29 Commands
  30 --------
  31
  32 ### //reset
  33
  34 Reset the region so that it is empty.
  35
  36     //reset
  37
  38 ### //mark
  39
  40 Show markers at the region positions.
  41
  42     //mark
  43
  44 ### //pos1
  45
  46 Set WorldEdit region position 1 to the player's location.
  47
  48     //pos1
  49
  50 ### //pos2
  51
  52 Set WorldEdit region position 2 to the player's location.
  53
  54     //pos2
  55
  56 ### //p set/get
  57
  58 Set WorldEdit region by punching two nodes, or display the current WorldEdit region.
  59
  60     //p set
  61     //p get
  62
  63 ### //volume
  64
  65 Display the volume of the current WorldEdit region.
  66
  67     //volume
  68
  69 ### //set <node>
  70
  71 Set the current WorldEdit region to <node>.
  72
  73     //set dirt
  74     //set default:glass
  75     //set mesecons:mesecon
  76
  77 ### //replace <search node> <replace node>
  78
  79 Replace all instances of <search node> with <place node> in the current WorldEdit region.
  80
  81     //replace cobble stone
  82     //replace default:steelblock glass
  83     //replace dirt flowers:flower_waterlily
  84     //replace flowers:flower_rose flowers:flower_tulip
  85
  86 ### //hollowcylinder x/y/z <length> <radius> <node>
  87
  88 Add hollow cylinder at WorldEdit position 1 along the x/y/z axis with length <length> and radius <radius>, composed of <node>.
  89
  90     //hollowcylinder x +5 8 dirt
  91     //hollowcylinder y 28 10 default:glass
  92     //hollowcylinder z -12 3 mesecons:mesecon
  93
  94 ### //cylinder x/y/z <length> <radius> <node>
  95
  96 Add cylinder at WorldEdit position 1 along the x/y/z axis with length <length> and radius <radius>, composed of <node>.
  97
  98     //cylinder x +5 8 dirt
  99     //cylinder y 28 10 default:glass
 100     //cylinder z -12 3 mesecons:mesecon
 101
 102 ### //copy x/y/z <amount>
 103
 104 Copy the current WorldEdit region along the x/y/z axis by <amount> nodes.
 105
 106     //copy x 15
 107     //copy y -7
 108     //copy z +4
 109
 110 ### //move x/y/z <amount>
 111
 112 Move the current WorldEdit region along the x/y/z axis by <amount> nodes.
 113
 114     //move x 15
 115     //move y -7
 116     //move z +4
 117
 118 ### //stack x/y/z <count>
 119
 120 Stack the current WorldEdit region along the x/y/z axis <count> times.
 121
 122     //stack x 3
 123     //stack y -1
 124     //stack z +5
 125
 126 ### //transpose x/y/z x/y/z
 127
 128 Transpose the current WorldEdit region along the x/y/z and x/y/z axes.
 129
 130     //transpose x y
 131     //transpose x z
 132     //transpose y z
 133
 134 ### //flip x/y/z
 135
 136 Flip the current WorldEdit region along the x/y/z axis.
 137
 138    //flip x
 139    //flip y
 140    //flip z
 141
 142 ### //rotate
 143
 144 Rotate the current WorldEdit region around the y axis by angle <angle> (90 degree increment).
 145
 146     //rotate 90
 147     //rotate 180
 148     //rotate 270
 149
 150 ### //dig
 151
 152 Dig the current WorldEdit region.
 153
 154     //dig
 155
 156 ### //save <file>
 157
 158 Save the current WorldEdit region to "(world folder)/schems/<file>.we".
 159
 160     //save some random filename
 161     //save huge_base
 162
 163 ### //load <file>
 164
 165 Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current WorldEdit region as the origin.
 166
 167     //load some random filename
 168     //load huge_base
 169
 170 WorldEdit API
 171 -------------
 172 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.
 173
 174 ### worldedit.volume(pos1, pos2)
 175
 176 Determines the volume of the region defined by positions `pos1` and `pos2`.
 177
 178 Returns the volume.
 179
 180 ### worldedit.set(pos1, pos2, nodename)
 181
 182 Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`.
 183
 184 Returns the number of nodes set.
 185
 186 ### worldedit.replace(pos1, pos2, searchnode, replacenode)
 187
 188 Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
 189
 190 Returns the number of nodes replaced.
 191
 192 ### worldedit.hollow_cylinder(pos, axis, length, radius, nodename)
 193
 194 Adds a hollow cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`.
 195
 196 Returns the number of nodes added.
 197
 198 ### worldedit.cylinder(pos, axis, length, radius, nodename)
 199
 200 Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`.
 201
 202 Returns the number of nodes added.
 203
 204 ### worldedit.copy(pos1, pos2, axis, amount)
 205
 206 Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 207
 208 Returns the number of nodes copied.
 209
 210 ### worldedit.move(pos1, pos2, axis, amount)
 211
 212 Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 213
 214 Returns the number of nodes moved.
 215
 216 ### worldedit.stack(pos1, pos2, axis, count)
 217
 218 Duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times.
 219
 220 Returns the number of nodes stacked.
 221
 222 ### worldedit.transpose(pos1, pos2, axis1, axis2)
 223
 224 Transposes a region defined by the positions `pos1` and `pos2` between the `axis1` and `axis2` axes ("x" or "y" or "z").
 225
 226 Returns the number of nodes transposed.
 227
 228 ### worldedit.flip(pos1, pos2, axis)
 229
 230 Flips a region defined by the positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z").
 231
 232 Returns the number of nodes flipped.
 233
 234 ### worldedit.rotate(pos1, pos2, angle)
 235
 236 Rotates a region defined by the positions `pos1` and `pos2` by `angle` degrees clockwise around the y axis (supporting 90 degree increments only).
 237
 238 Returns the number of nodes rotated.
 239
 240 ### worldedit.dig(pos1, pos2)
 241
 242 Digs a region defined by positions `pos1` and `pos2`.
 243
 244 Returns the number of nodes dug.
 245
 246 ### worldedit.serialize(pos1, pos2)
 247
 248 Converts the region defined by positions `pos1` and `pos2` into a single string.
 249
 250 Returns the serialized data and the number of nodes serialized.
 251
 252 ### worldedit.deserialize(originpos, value)
 253
 254 Loads the nodes represented by string `value` at position `originpos`.
 255
 256 Returns the number of nodes deserialized.
 257
 258 ### worldedit.deserialize_old(originpos, value)
 259
 260 Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format.
 261
 262 This function is deprecated, and should not be used unless there is a need to support legacy WorldEdit save files.
 263
 264 Returns the number of nodes deserialized.
 265
 266 License
 267 -------
 268 Copyright 2012 sfan5 and Anthony Zhang (Temperest)
 269
 270 This mod is licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0.html).
 271
 272 Basically, this means everyone is free to use, modify, and distribute the files, as long as these modifications are also licensed the same way.
 273
 274 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.