README.md

   1 WorldEdit v1.0 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 Commands
  24 --------
  25
  26 ### //reset
  27
  28 Reset the region so that it is empty.
  29
  30 ### //pos1
  31
  32 Set WorldEdit region position 1 to the player's location.
  33
  34     //pos1
  35
  36 ### //pos2
  37
  38 Set WorldEdit region position 2 to the player's location.
  39
  40     //pos2
  41
  42 ### //p set/get
  43
  44 Set WorldEdit region by punching two nodes, or display the current WorldEdit region.
  45
  46     //p set
  47     //p get
  48
  49 ### //volume
  50
  51 Display the volume of the current WorldEdit region.
  52
  53     //volume
  54
  55 ### //set <node>
  56
  57 Set the current WorldEdit region to <node>.
  58
  59     //set dirt
  60     //set default:glass
  61     //set mesecons:mesecon
  62
  63 ### //replace <search node> <replace node>
  64
  65 Replace all instances of <search node> with <place node> in the current WorldEdit region.
  66
  67     //replace cobble stone
  68     //replace default:steelblock glass
  69     //replace dirt flowers:flower_waterlily
  70     //replace flowers:flower_rose flowers:flower_tulip
  71
  72 ### //copy x/y/z <amount>
  73
  74 Copy the current WorldEdit region along the x/y/z axis by <amount> nodes.
  75
  76     //copy x 15
  77     //copy y -7
  78     //copy z +4
  79
  80 ### //move x/y/z <amount>
  81
  82 Move the current WorldEdit region along the x/y/z axis by <amount> nodes.
  83
  84     //move x 15
  85     //move y -7
  86     //move z +4
  87
  88 ### //stack x/y/z <count>
  89
  90 Stack the current WorldEdit region along the x/y/z axis <count> times.
  91
  92     //stack x 3
  93     //stack y -1
  94     //stack z +5
  95
  96 ### //dig
  97
  98 Dig the current WorldEdit region.
  99
 100     //dig
 101
 102 ### //save <file>
 103
 104 Save the current WorldEdit region to "(world folder)/schems/<file>.we".
 105
 106     //save some random filename
 107     //save huge_base
 108
 109 ### //load <file>
 110
 111 Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current WorldEdit region as the origin.
 112
 113     //load some random filename
 114     //load huge_base
 115
 116 WorldEdit API
 117 -------------
 118 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.
 119
 120 ### worldedit.volume(pos1, pos2)
 121
 122 Determines the volume of the region defined by positions `pos1` and `pos2`.
 123
 124 Returns the volume.
 125
 126 ### worldedit.set(pos1, pos2, nodename)
 127
 128 Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`.
 129
 130 Returns the number of nodes set.
 131
 132 ### worldedit.replace(pos1, pos2, searchnode, replacenode)
 133
 134 Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
 135
 136 Returns the number of nodes replaced.
 137
 138 ### worldedit.copy(pos1, pos2, axis, amount)
 139
 140 Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 141
 142 Returns the number of nodes copied.
 143
 144 ### worldedit.move(pos1, pos2, axis, amount)
 145
 146 Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
 147
 148 Returns the number of nodes moved.
 149
 150 ### worldedit.stack(pos1, pos2, axis, count)
 151
 152 duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times.
 153
 154 Returns the number of nodes stacked.
 155
 156 ### worldedit.dig(pos1, pos2)
 157
 158 Digs a region defined by positions `pos1` and `pos2`.
 159
 160 Returns the number of nodes dug.
 161
 162 ### worldedit.serialize(pos1, pos2)
 163
 164 Converts the region defined by positions `pos1` and `pos2` into a single string.
 165
 166 Returns the serialized data and the number of nodes serialized.
 167
 168 ### worldedit.deserialize(originpos, value)
 169
 170 Loads the nodes represented by string `value` at position `originpos`.
 171
 172 Returns the number of nodes deserialized.
 173
 174 License
 175 -------
 176 Copyright 2012 sfan5 and Anthony Zhang (Temperest)
 177
 178 This mod is licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0.html).
 179
 180 Basically, this means everyone is free to use, modify, and distribute the files, as long as these modifications are also licensed the same way.
 181
 182 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.