-WorldEdit v0.5 for MineTest 0.4
-===============================
-In-game world editing for [MineTest](http://minetest.net/)! Tons of chat commands to help with building, fixing, and more.
+WorldEdit v1.3
+==============
+The ultimate in-game world editing tool for [Minetest](http://minetest.net/)! Tons of functionality to help with building, fixing, and more.
-For more information, see the [forum topic](http://minetest.net/forum/viewtopic.php?id=572) at the MineTest forums.
+For more information, see the [forum topic](https://forum.minetest.net/viewtopic.php?id=572) at the Minetest forums.
-Usage
------
-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.
-
-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`.
-
-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.
-
-Regions
--------
-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.
-
-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.
-
-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.
-
-Markers
--------
-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.
-
-To remove the entities, simply punch them. This does not reset the positions themselves.
-
-Commands
---------
-
-### //reset
-
-Reset the region so that it is empty.
-
- //reset
-
-### //pos1
-
-Set WorldEdit region position 1 to the player's location.
-
- //pos1
-
-### //pos2
-
-Set WorldEdit region position 2 to the player's location.
-
- //pos2
-
-### //p set/get
-
-Set WorldEdit region by punching two nodes, or display the current WorldEdit region.
-
- //p set
- //p get
+# New users should see the [tutorial](Tutorial.md).
-### //volume
+
-Display the volume of the current WorldEdit region.
+Installing
+----------
- //volume
+There is a nice installation guide over at the [Minetest Wiki](http://wiki.minetest.com/wiki/Installing_mods). Here is a short summary:
-### //set <node>
+1. Download the mod from the [official releases page](https://github.com/Uberi/Minetest-WorldEdit/releases). The download links are labelled "Source Code". If you are using Windows, you'll want to download the ZIP version.
+2. You should have a file named `Minetest-WorldEdit-x.x.zip`.
+3. Extract this file using your archiver of choice. If you are using Windows, open the ZIP file and move the folder inside to a safe place outside of the ZIP file.
+4. Make sure that you now have a folder with a file named README.md inside it. If you just have another folder inside this folder, use the nested folder instead.
+5. Move this folder into the `MINETEST_FOLDER/mods` folder, where `MINETEST_FOLDER` is the folder Minetest is located in.
+6. Open Minetest to a world selection screen.
+7. Select a world you want to use WorldEdit in by left clicking on it once and press the **Configure** button.
+8. You should have a mod selection screen. Select the one named something like `Minetest-WorldEdit` by left clicking once and press the **Enable Modpack** button.
+9. Press the **Save** button. You can now use WorldEdit in that world. Repeat steps 7 to 9 to enable WorldEdit for other worlds too.
-Set the current WorldEdit region to <node>.
+If you are having trouble, try asking for help in the [IRC channel](https://web.libera.chat/#minetest) (faster but may not always have helpers online)
+or ask on the [forum topic](https://forum.minetest.net/viewtopic.php?id=572) (slower but more likely to get help).
- //set dirt
- //set default:glass
- //set mesecons:mesecon
-
-### //replace <search node> <replace node>
-
-Replace all instances of <search node> with <place node> in the current WorldEdit region.
-
- //replace cobble stone
- //replace default:steelblock glass
- //replace dirt flowers:flower_waterlily
- //replace flowers:flower_rose flowers:flower_tulip
-
-### //copy x/y/z <amount>
-
-Copy the current WorldEdit region along the x/y/z axis by <amount> nodes.
-
- //copy x 15
- //copy y -7
- //copy z +4
-
-### //move x/y/z <amount>
-
-Move the current WorldEdit region along the x/y/z axis by <amount> nodes.
-
- //move x 15
- //move y -7
- //move z +4
-
-### //stack x/y/z <count>
-
-Stack the current WorldEdit region along the x/y/z axis <count> times.
+Usage
+-----
+WorldEdit works primarily through the WorldEdit GUI and 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.
- //stack x 3
- //stack y -1
- //stack z +5
+WorldEdit has a huge potential for abuse by untrusted players. Therefore, users will not be able to use WorldEdit unless they have the `worldedit` privilege.
+This is available by default in singleplayer, but in multiplayer the permission must be explicitly given by someone with the right credentials,
+using the following chat command: `/grant <player name> worldedit`. This privilege can later be removed using the following chat command: `/revoke <player name> worldedit`.
-### //dig
+Certain functions/commands such as WorldEdit `//lua` and `//luatransform` chat commands additionally require the `server` privilege.
+This is because it is extremely dangerous to give access to these commands to untrusted players, since they essentially are able to control the computer the server is running on.
+Give this privilege only to people you trust with your computer.
-Dig the current WorldEdit region.
+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.
- //dig
+Interface
+---------
+WorldEdit is accessed in-game in two main ways.
-### //save <file>
+The GUI adds a screen to each player's inventory that gives access to various WorldEdit functions. The [tutorial](Tutorial.md) may be helpful in learning to use it.
-Save the current WorldEdit region to "(world folder)/schems/<file>.we".
+The chat interface adds many chat commands that perform various WorldEdit powered tasks. It is documented in the [Chat Commands Reference](ChatCommands.md).
- //save some random filename
- //save huge_base
+Compatibility
+-------------
+This mod supports Minetest versions 5.0 and newer. Older versions of WorldEdit may work with older versions of Minetest, but are not recommended or supported.
-### //load <file>
+WorldEdit works quite well with other mods and does not have any known mod conflicts.
-Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current WorldEdit region as the origin.
+WorldEdit GUI requires one of [sfinv](https://github.com/minetest/minetest_game/tree/master/mods/sfinv) (included in minetest_game),
+[Unified Inventory](https://forum.minetest.net/viewtopic.php?t=12767),
+[Inventory++](https://forum.minetest.net/viewtopic.php?id=6204) or [Smart Inventory](https://forum.minetest.net/viewtopic.php?t=16597).
- //load some random filename
- //load huge_base
+If you use any other inventory manager mods, note that they may conflict with the WorldEdit GUI. If this is the case, it may be necessary to disable them.
WorldEdit API
-------------
-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.
+WorldEdit exposes all significant functionality in a simple Lua interface.
-### worldedit.volume(pos1, pos2)
+Adding WorldEdit as a dependency to your mod gives you access to all of the `worldedit` functions. The API is useful for tasks such as high-performance node manipulation, alternative interfaces and map creation.
-Determines the volume of the region defined by positions `pos1` and `pos2`.
+AGPLv3 compatible mods may further include WorldEdit files in their own mods. This can be useful if a modder wishes to completely avoid any dependency on WorldEdit. Note that it is required to give credit to the authors in this case.
-Returns the volume.
+This API is documented in the [WorldEdit API Reference](WorldEdit%20API.md).
-### worldedit.set(pos1, pos2, nodename)
+Axes
+----
+The coordinate system is the same as that used by Minetest; positive Y is upwards, positive X is rightwards, and positive Z is forwards, if a player is facing North (positive Z axis).
-Sets a region defined by positions `pos1` and `pos2` to `nodename`. To clear to region, use "air" as the value of `nodename`.
+When an axis is specified in a WorldEdit chat command, it is specified as one of the following values: `x`, `y`, `z`, or `?`.
-Returns the number of nodes set.
+In the GUI, there is a dropdown menu for this purpose. The "Look direction" option has the same effect as `?` does in chat commands.
-### worldedit.replace(pos1, pos2, searchnode, replacenode)
+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.
-Replaces all instances of `searchnode` with `replacenode` in a region defined by positions `pos1` and `pos2`.
-
-Returns the number of nodes replaced.
-
-### worldedit.copy(pos1, pos2, axis, amount)
-
-Copies the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
-
-Returns the number of nodes copied.
+Nodes
+-----
+Node names are required for many types of commands that identify or modify specific types of nodes. They can be specified in a number of ways.
-### worldedit.move(pos1, pos2, axis, amount)
+First, by description - the tooltip that appears when hovering over the item in an inventory. This is case insensitive and includes values such as "Cobblestone" and "bronze block".
+Note that certain commands (namely, `//replace` and `//replaceinverse`) do not support descriptions that contain spaces in the `<searchnode>` field.
-Moves the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") by `amount` nodes.
+Second, by name - the node name that is defined by code, but without the mod name prefix. This is case sensitive and includes values such as "piston_normal_off" and "cactus".
+If there are multiple possible nodes (such as "a:celery" and "b:celery"), one is chosen in no particular order.
-Returns the number of nodes moved.
+Finally, by full name - the unambiguous identifier of the node, prefixes and all. This is case sensitive and includes values such as "default:stone" and "mesecons:wire_00000000_off".
-### worldedit.stack(pos1, pos2, axis, count)
+The node name "air" can be used anywhere a normal node name can and acts as a blank node. This is useful for clearing or removing nodes.
+For example, `//set air` would remove all the nodes in the current WorldEdit region. Similarly, `//sphere 10 air`, when WorldEdit position 1 underground, would dig a large sphere out of the ground.
-duplicates the region defined by positions `pos1` and `pos2` along the `axis` axis ("x" or "y" or "z") `count` times.
+Regions
+-------
+Most WorldEdit commands operate on regions. Regions are a set of two positions that define a 3D cuboid. They are local to each player and chat commands affect only the region for the player giving the commands.
-Returns the number of nodes stacked.
+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.
-### worldedit.dig(pos1, pos2)
+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.
-Digs a region defined by positions `pos1` and `pos2`.
+Markers
+-------
+Entities are used to mark the location of the WorldEdit regions. They appear as boxes containing the number 1 or 2 and represent the first and second position of the WorldEdit region, respectively.
-Returns the number of nodes dug.
+To remove the entities, simply punch them. This does not reset the positions themselves.
-### worldedit.serialize(pos1, pos2)
+Schematics
+----------
+WorldEdit supports two different types of schematics.
-Converts the region defined by positions `pos1` and `pos2` into a single string.
+The first is the WorldEdit Schematic format, with the file extension ".we", and in some older versions, ".wem".
+There have been several previous versions of the WorldEdit Schematic format, but WorldEdit is capable of loading any past versions, and will always support them - there is no need to worry about schematics becoming obsolete.
-Returns the serialized data and the number of nodes serialized.
+As of version 5, WorldEdit schematics include a header. The header is seperated from the content by a colon (`:`). It may contain fields seperated by commas (`,`).
+Currently only one field is used, which contains the version as an ASCII decimal.
-### worldedit.deserialize(originpos, value)
+The current version of the WorldEdit Schematic format is essentially an array of node data tables in Lua 5.1 table syntax preceded by a header.
+Specifically it looks like this:
-Loads the nodes represented by string `value` at position `originpos`.
+ 5:return {
+ {
+ y = <y-axis coordinate>,
+ x = <x-axis coordinate>,
+ z = <z-axis coordinate>,
+ name = <node name>,
+ param1 = <param1 value>,
+ param2 = <param2 value>,
+ meta = <metadata table>,
+ },
+ <...>
+ }
-Returns the number of nodes deserialized.
-### worldedit.deserialize_old(originpos, value)
+The ordering of the values and minor aspects of the syntax, such as trailing commas or newlines, are not guaranteed to stay the same in future versions.
-Loads the nodes represented by string `value` at position `originpos`, using the older table-based WorldEdit format.
+The WorldEdit Schematic format is accessed via the WorldEdit API, or WorldEdit serialization chat commands such as `//serialize` and `//deserialize`.
-This function is deprecated, and should not be used unless there is a need to support legacy WorldEdit save files.
+The second is the Minetest Schematic format (MTS). The details of this format may be found in the Minetest documentation and are out of the scope of this document.
+Access to this format is done via specialized MTS commands such as `//mtschemcreate` and `//mtschemplace`.
-Returns the number of nodes deserialized.
+Authors
+-------
+WorldEdit would not be possible without the contributions of many developers and designers. Below, they are listed alphabetically:
+
+ Alexander Weber
+ ANAND
+ beyondlimits
+ Carter Kolwey
+ cornernote
+ Cy
+ Daniel Sosa
+ electricface
+ est31
+ Eugen Wesseloh
+ h3ndrik
+ HybridDog
+ Isidor Zeuner
+ Jean-Patrick Guerrero
+ Joseph Pickard
+ kaeza
+ kilbith
+ KodexKy
+ Kyle
+ MT-Modder
+ Niwla23
+ Panquesito7
+ Pedro Gimeno
+ Rui
+ Sebastien Ponce
+ sfan5
+ ShadowNinja
+ shivajiva101
+ spillz
+ Starbeamrainbowlabs
+ TalkLounge
+ tenplus1
+ Uberi/Temperest
+ Wuzzy
License
-------
-Copyright 2012 sfan5 and Anthony Zhang (Temperest)
+Copyright (c) 2012 sfan5, Anthony Zhang (Uberi/Temperest), and Brett O'Donnell (cornernote).
-This mod is licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0.html).
+This mod is licensed under the [GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html).
Basically, this means everyone is free to use, modify, and distribute the files, as long as these modifications are also licensed the same way.
-
-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.
\ No newline at end of file
+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.
projects / worldedit.git / blobdiff