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