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 ### //hollowsphere <radius> <node>
  95
  96 Add hollow sphere at WorldEdit position 1 with radius <radius>, composed of <node>.
  97
  98     //hollowsphere 5 dirt
  99     //hollowsphere 12 default:glass
 100     //hollowsphere 17 mesecons:mesecon
 101
 102 ### //sphere <radius> <node>
 103
 104 Add sphere at WorldEdit position 1 with radius <radius>, composed of <node>.
 105
 106     //sphere 5 dirt
 107     //sphere 12 default:glass
 108     //sphere 17 mesecons:mesecon
 109
 110 ### //hollowcylinder x/y/z/? <length> <radius> <node>
 111
 112 Add hollow cylinder at WorldEdit position 1 along the x/y/z/? axis with length <length> and radius <radius>, composed of <node>.
 113
 114     //hollowcylinder x +5 8 dirt
 115     //hollowcylinder y 28 10 default:glass
 116     //hollowcylinder z -12 3 mesecons:mesecon
 117     //hollowcylinder ? 2 4 stone
 118
 119 ### //cylinder x/y/z/? <length> <radius> <node>
 120
 121 Add cylinder at WorldEdit position 1 along the x/y/z/? axis with length <length> and radius <radius>, composed of <node>.
 122
 123     //cylinder x +5 8 dirt
 124     //cylinder y 28 10 default:glass
 125     //cylinder z -12 3 mesecons:mesecon
 126     //cylinder ? 2 4 stone
 127
 128 ### //pyramid <height> <node>
 129
 130 Add pyramid at WorldEdit position 1 with height <height>, composed of <node>.
 131
 132     //pyramid 8 dirt
 133     //pyramid 5 default:glass
 134     //pyramid 2 stone
 135
 136
 137 ### //copy x/y/z/? <amount>
 138
 139 Copy the current WorldEdit region along the x/y/z/? axis by <amount> nodes.
 140
 141     //copy x 15
 142     //copy y -7
 143     //copy z +4
 144     //copy ? 8
 145
 146 ### //move x/y/z/? <amount>
 147
 148 Move the current WorldEdit positions and region along the x/y/z/? axis by <amount> nodes.
 149
 150     //move x 15
 151     //move y -7
 152     //move z +4
 153     //move ? -1
 154
 155 ### //stack x/y/z/? <count>
 156
 157 Stack the current WorldEdit region along the x/y/z/? axis <count> times.
 158
 159     //stack x 3
 160     //stack y -1
 161     //stack z +5
 162     //stack ? 12
 163
 164 ### //transpose x/y/z/? x/y/z/?
 165
 166 Transpose the current WorldEdit region along the x/y/z/? and x/y/z/? axes.
 167
 168     //transpose x y
 169     //transpose x z
 170     //transpose y z
 171     //transpose ? y
 172
 173 ### //flip x/y/z/?
 174
 175 Flip the current WorldEdit region along the x/y/z/? axis.
 176
 177    //flip x
 178    //flip y
 179    //flip z
 180    //flip ?
 181
 182 ### //rotate x/y/z/? <angle>
 183
 184 Rotate the current WorldEdit region along the x/y/z/? axis by angle <angle> (90 degree increment).
 185
 186     //rotate x 90
 187     //rotate y 180
 188     //rotate z 270
 189     //rotate ? -90
 190
 191 ### //dig
 192
 193 Dig the current WorldEdit region.
 194
 195     //dig
 196
 197 ### //save <file>
 198
 199 Save the current WorldEdit region to "(world folder)/schems/<file>.we".
 200
 201     //save some random filename
 202     //save huge_base
 203
 204 ### //load <file>
 205
 206 Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current WorldEdit region as the origin.
 207
 208     //load some random filename
 209     //load huge_base
 210
 211 ### //metasave <file>
 212
 213 Save the current WorldEdit region including metadata to "(world folder)/schems/<file>.wem".
 214
 215     //metasave some random filename
 216     //metasave huge_base
 217
 218 ### //metaload <file>
 219
 220 Load nodes and metadata from "(world folder)/schems/<file>.wem" with position 1 of the current WorldEdit region as the origin.
 221
 222     //metaload some random filename
 223     //metaload huge_base
 224
 225 WorldEdit API
 226 -------------
 227 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.
 228
 229 ### worldedit.volume(pos1, pos2)
 230
 231 Determines the volume of the region defined by positions `pos1` and `pos2`.
 232
 233 Returns the volume.
 234
 235 ### worldedit.set(pos1, pos2, nodename)
 236
 237 Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`.
 238
 239 Returns the number of nodes set.
 240
 241 ### worldedit.replace(pos1, pos2, searchnode, replacenode)
 242
 243 Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
 244
 245 Returns the number of nodes replaced.
 246
 247 ### worldedit.hollow_sphere = function(pos, radius, nodename)
 248
 249 Adds a hollow sphere at `pos` with radius `radius`, composed of `nodename`.
 250
 251 Returns the number of nodes added.
 252
 253 ### worldedit.sphere = function(pos, radius, nodename)
 254
 255 Adds a sphere at `pos` with radius `radius`, composed of `nodename`.
 256
 257 Returns the number of nodes added.
 258
 259 ### worldedit.hollow_cylinder(pos, axis, length, radius, nodename)
 260
 261 Adds a hollow cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`.
 262
 263 Returns the number of nodes added.
 264
 265 ### worldedit.cylinder(pos, axis, length, radius, nodename)
 266
 267 Adds a cylinder at `pos` along the `axis` axis ("x" or "y" or "z") with length `length` and radius `radius`, composed of `nodename`.
 268
 269 Returns the number of nodes added.
 270
 271 ### worldedit.pyramid(pos, height, nodename)
 272
 273 Adds a pyramid at `pos` with height `height`.
 274
 275 Returns the number of nodes added.
 276
 277 ### worldedit.copy(pos1, pos2, axis, amount)
 278
 279 Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 280
 281 Returns the number of nodes copied.
 282
 283 ### worldedit.move(pos1, pos2, axis, amount)
 284
 285 Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 286
 287 Returns the number of nodes moved.
 288
 289 ### worldedit.stack(pos1, pos2, axis, count)
 290
 291 Duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times.
 292
 293 Returns the number of nodes stacked.
 294
 295 ### worldedit.transpose(pos1, pos2, axis1, axis2)
 296
 297 Transposes a region defined by the positions `pos1` and `pos2` between the `axis1` and `axis2` axes ("x" or "y" or "z").
 298
 299 Returns the number of nodes transposed.
 300
 301 ### worldedit.flip(pos1, pos2, axis)
 302
 303 Flips a region defined by the positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z").
 304
 305 Returns the number of nodes flipped.
 306
 307 ### worldedit.rotate(pos1, pos2, angle)
 308
 309 Rotates a region defined by the positions `pos1` and `pos2` by `angle` degrees clockwise around the y axis (supporting 90 degree increments only).
 310
 311 Returns the number of nodes rotated.
 312
 313 ### worldedit.dig(pos1, pos2)
 314
 315 Digs a region defined by positions `pos1` and `pos2`.
 316
 317 Returns the number of nodes dug.
 318
 319 ### worldedit.serialize(pos1, pos2)
 320
 321 Converts the region defined by positions `pos1` and `pos2` into a single string.
 322
 323 Returns the serialized data and the number of nodes serialized.
 324
 325 ### worldedit.deserialize(originpos, value)
 326
 327 Loads the nodes represented by string `value` at position `originpos`.
 328
 329 Returns the number of nodes deserialized.
 330
 331 ### worldedit.deserialize_old(originpos, value)
 332
 333 Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format.
 334
 335 This function is deprecated, and should not be used unless there is a need to support legacy WorldEdit save files.
 336
 337 Returns the number of nodes deserialized.
 338
 339 ### worldedit.metasave(pos1, pos2, file)
 340
 341 Saves the nodes and meta defined by positions `pos1` and `pos2` into a file
 342
 343 Returns the number of nodes saved
 344
 345 ### worldedit.metaload(pos1, file)
 346
 347 Loads the nodes and meta from `file` to position `pos1`
 348
 349 Returns the number of nodes loaded
 350
 351 License
 352 -------
 353 Copyright 2012 sfan5 and Anthony Zhang (Temperest)
 354
 355 This mod is licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0.html).
 356
 357 Basically, this means everyone is free to use, modify, and distribute the files, as long as these modifications are also licensed the same way.
 358
 359 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.