WorldEdit Tutorial\r
==================\r
-This is a step-by-step tutorial outlining the basic usage of WorldEdit. For more information, see the [README](README.md).\r
+This is a step-by-step tutorial outlining the basic usage of WorldEdit.\r
\r
Let's start with a few assumptions:\r
\r
-* You have a compatible version of Minetest working.\r
- * See the [README](README.md) for compatibility information.\r
+* You have a compatible version of Minetest working, that is 5.0 or later.\r
* You have WorldEdit installed as a mod.\r
- * If using Windows, [MODSTER](https://forum.minetest.net/viewtopic.php?pid=101463) makes installing mods totally painless.\r
* Simply download the file, extract the archive, and move it to the correct mod folder for Minetest.\r
+ * See the installation instructions in [README](README.md) if you need more details.\r
* You are familiar with the basics of the game.\r
* How to walk, jump, and climb.\r
* How to dig, place, and punch blocks.\r
- * How to type into the chat and read text from it.\r
+ * One of the following:\r
+ * How to type into the chat and read text from it.\r
+ * How to open the inventory screen and press buttons on it.\r
\r
Overview\r
--------\r
WorldEdit has a "region", which is simply a cuboid area defined by two markers, both of which the player can move around. Every player can have their own region with their own two markers.\r
\r
-WorldEdit chat commands can work inside the region selected, or around the first marker.\r
+WorldEdit GUI buttons and chat commands generally work inside the region selected, or around the first marker.\r
+\r
+If you are using the chat commands, follow the steps under **Chat Commands**. If you are using the WorldEdit GUI, follow the steps under **WorldEdit GUI**.\r
\r
Step 1: Selecting a region\r
--------------------------\r
+### Chat Commands\r
+\r
In the chat prompt, enter `//p set`. In the chat, you are prompted to punch two nodes to set the positions of the two markers.\r
\r
Punch a nearby node. Be careful of breakable ones such as torches. A black cube reading "1" will appear around the node. This is the marker for WorldEdit position 1.\r
\r
Walk away from the node you just punched. Now, punch another node. A black cube reading "2" will appear around the node. This is the marker for WorldEdit position 2.\r
\r
+### WorldEdit GUI\r
+\r
+Open the main WorldEdit GUI from your inventory screen. The icon looks like a globe with a red dot in the center.\r
+\r
+Press the "Get/Set Positions" button. On the new screen, press the "Set Position 1" button. The inventory screen should close.\r
+\r
+Punch a nearby node. Be careful of breakable ones such as torches. A black cube reading "1" will appear around the node. This is the marker for WorldEdit position 1.\r
+\r
+Walk away from the node you just punched. Open your inventory again. It should be on the same page as it was before.\r
+\r
+Press the "Set Position 2" button. The inventory screen should close.\r
+\r
+Now, punch another node. A black cube reading "2" will appear around the node. This is the marker for WorldEdit position 2.\r
+\r
Step 2: Region commands\r
-----------------------\r
+### Chat Commands\r
+\r
In the chat prompt, enter `//set mese`. In the chat, you will see a message showing the number of nodes set after a small delay.\r
\r
Look at the place between the two markers: it is now filled with MESE blocks!\r
\r
The `//set <node>` command fills the region with whatever node you want. It is a region-oriented command, which means it works inside the WorldEdit region only.\r
\r
-Now, try a few different variations, such as `//set torch`, `//set cobble`, and `//set water`.\r
+Now, try a few different variations, such as `//set torch`, `//set cobble`, and `//set water source`.\r
+\r
+### WorldEdit GUI\r
+\r
+Open the main WorldEdit GUI from your inventory screen.\r
+\r
+Press the "Set Nodes" button. You should see a new screen with various options for setting nodes.\r
+\r
+Enter "mese" in the "Name" field. Press Search if you would like to see what the node you just entered looks like.\r
+\r
+Press the "Set Nodes" button on this screen. In the chat, you will see a message showing the number of nodes set after a small delay.\r
+\r
+Look at the place between the two markers: it is now filled with MESE blocks!\r
+\r
+The "Set Nodes" function fills the region with whatever node you want. It is a region-oriented command, which means it works inside the WorldEdit region only.\r
+\r
+Now, try a few different variations on the node name, such as "torch", "cobble", and "water source".\r
\r
Step 3: Position commands\r
-------------------------\r
+### Chat Commands\r
+\r
In the chat prompt, enter `//hollowdome 30 glass`. In the chat, you will see a message showing the number of nodes set after a small delay.\r
\r
Look around marker 1: it is now surrounded by a hollow glass dome!\r
\r
The `//hollowdome <radius> <node>` command creates a hollow dome centered around marker 1, made of any node you want. It is a position-oriented command, which means it works around marker 1 and can go outside the WorldEdit region.\r
\r
+### WorldEdit GUI\r
+\r
+Open the main WorldEdit GUI from your inventory screen.\r
+\r
+Press the "Sphere/Dome" button. You should see a new screen with various options for making spheres or domes.\r
+\r
+Enter "glass" in the "Name" field. Press Search if you would like to see what the node you just entered looks like.\r
+\r
+Enter "30" in the "Radius" field.\r
+\r
+Press the "Hollow Dome" button on this screen. In the chat, you will see a message showing the number of nodes added after a small delay.\r
+\r
+Look around marker 1: it is now surrounded by a hollow glass dome!\r
+\r
+The "Hollow Dome" function creates a hollow dome centered around marker 1, made of any node you want. It is a position-oriented command, which means it works around marker 1 and can go outside the WorldEdit region.\r
+\r
Step 4: Other commands\r
----------------------\r
-There are many more commands than what is shown here. See the [Chat Commands Reference](Chat Commands.md) for a detailed list of them, along with descriptions and examples for every single one.\r
+### Chat Commands\r
+\r
+There are many more commands than what is shown here. See the [Chat Commands Reference](ChatCommands.md) for a detailed list of them, along with descriptions and examples for every single one.\r
\r
If you're in-game and forgot how a command works, just use the `/help <command name>` command, without the first forward slash. For example, to see some information about the `//set <node>` command mentioned earlier, simply use `/help /set`.\r
\r
-A very useful command to check out is the `//save <schematic>` command, which can save everything inside the WorldEdit region to a file, stored on the computer hosting the server (the player's computer, in single player mode). You can then later use `//load <schematic>` to load the data in a file into a world, even another world on another computer.
\ No newline at end of file
+A very useful command to check out is the `//save <schematic>` command, which can save everything inside the WorldEdit region to a file, stored on the computer hosting the server (the player's computer, in single player mode). You can then later use `//load <schematic>` to load the data in a file into a world, even another world on another computer.\r
+\r
+### WorldEdit GUI\r
+\r
+This only scratches the surface of what WorldEdit is capable of. Most of the functions in the WorldEdit GUI correspond to chat commands, and so the [Chat Commands Reference](ChatCommands.md) may be useful if you get stuck.\r
+\r
+It is helpful to explore the various buttons in the interface and check out what they do. Learning the chat command interface is also useful if you use WorldEdit intensively - an experienced chat command user can usually work faster than an experienced WorldEdit GUI user.\r
projects / worldedit.git / blobdiff