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 ### //copy x/y/z <amount>
  87
  88 Copy the current WorldEdit region along the x/y/z axis by <amount> nodes.
  89
  90     //copy x 15
  91     //copy y -7
  92     //copy z +4
  93
  94 ### //move x/y/z <amount>
  95
  96 Move the current WorldEdit region along the x/y/z axis by <amount> nodes.
  97
  98     //move x 15
  99     //move y -7
 100     //move z +4
 101
 102 ### //stack x/y/z <count>
 103
 104 Stack the current WorldEdit region along the x/y/z axis <count> times.
 105
 106     //stack x 3
 107     //stack y -1
 108     //stack z +5
 109
 110 ### //dig
 111
 112 Dig the current WorldEdit region.
 113
 114     //dig
 115
 116 ### //save <file>
 117
 118 Save the current WorldEdit region to "(world folder)/schems/<file>.we".
 119
 120     //save some random filename
 121     //save huge_base
 122
 123 ### //load <file>
 124
 125 Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current WorldEdit region as the origin.
 126
 127     //load some random filename
 128     //load huge_base
 129
 130 WorldEdit API
 131 -------------
 132 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.
 133
 134 ### worldedit.volume(pos1, pos2)
 135
 136 Determines the volume of the region defined by positions `pos1` and `pos2`.
 137
 138 Returns the volume.
 139
 140 ### worldedit.set(pos1, pos2, nodename)
 141
 142 Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`.
 143
 144 Returns the number of nodes set.
 145
 146 ### worldedit.replace(pos1, pos2, searchnode, replacenode)
 147
 148 Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
 149
 150 Returns the number of nodes replaced.
 151
 152 ### worldedit.copy(pos1, pos2, axis, amount)
 153
 154 Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 155
 156 Returns the number of nodes copied.
 157
 158 ### worldedit.move(pos1, pos2, axis, amount)
 159
 160 Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 161
 162 Returns the number of nodes moved.
 163
 164 ### worldedit.stack(pos1, pos2, axis, count)
 165
 166 duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times.
 167
 168 Returns the number of nodes stacked.
 169
 170 ### worldedit.dig(pos1, pos2)
 171
 172 Digs a region defined by positions `pos1` and `pos2`.
 173
 174 Returns the number of nodes dug.
 175
 176 ### worldedit.serialize(pos1, pos2)
 177
 178 Converts the region defined by positions `pos1` and `pos2` into a single string.
 179
 180 Returns the serialized data and the number of nodes serialized.
 181
 182 ### worldedit.deserialize(originpos, value)
 183
 184 Loads the nodes represented by string `value` at position `originpos`.
 185
 186 Returns the number of nodes deserialized.
 187
 188 ### worldedit.deserialize_old(originpos, value)
 189
 190 Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format.
 191
 192 This function is deprecated, and should not be used unless there is a need to support legacy WorldEdit save files.
 193
 194 Returns the number of nodes deserialized.
 195
 196 License
 197 -------
 198 Copyright 2012 sfan5 and Anthony Zhang (Temperest)
 199
 200 This mod is licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0.html).
 201
 202 Basically, this means everyone is free to use, modify, and distribute the files, as long as these modifications are also licensed the same way.
 203
 204 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.