]> git.lizzy.rs Git - worldedit.git/blob - README.md
Rename README to show markdown properly.
[worldedit.git] / 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 Commands
16 --------
17
18 ### //pos1
19
20 Set WorldEdit region position 1 to the player's location.
21
22     //pos1
23
24 ### //pos2
25
26 Set WorldEdit region position 2 to the player's location.
27
28     //pos2
29
30 ### //p set/get
31
32 Set WorldEdit region by punching two nodes, or display the current WorldEdit region.
33
34     //p set
35     //p get
36
37 ### //volume
38
39 Display the volume of the current WorldEdit region.
40
41     //volume
42
43 ### //set <node>
44
45 Set the current WorldEdit region to <node>.
46
47     //set dirt
48     //set default:glass
49     //set mesecons:mesecon
50
51 ### //replace <search node> <replace node>
52
53 Replace all instances of <search node> with <place node> in the current WorldEdit region.
54
55     //replace cobble stone
56     //replace default:steelblock glass
57     //replace dirt flowers:flower_waterlily
58     //replace flowers:flower_rose flowers:flower_tulip
59
60 ### //copy x/y/z <amount>
61
62 Copy the current WorldEdit region along the x/y/z axis by <amount> nodes.
63
64     //copy x 15
65     //copy y -7
66     //copy z +4
67
68 ### //move x/y/z <amount>
69
70 Move the current WorldEdit region along the x/y/z axis by <amount> nodes.
71
72     //move x 15
73     //move y -7
74     //move z +4
75
76 ### //stack x/y/z <count>
77
78 Stack the current WorldEdit region along the x/y/z axis <count> times.
79
80     //stack x 3
81     //stack y -1
82     //stack z +5
83
84 ### //dig
85
86 Dig the current WorldEdit region.
87
88     //dig
89
90 ### //save <file>
91
92 Save the current WorldEdit region to "(world folder)/schems/<file>.we".
93
94     //save some random filename
95     //save huge_base
96
97 ### //load <file>
98
99 Load nodes from "(world folder)/schems/<file>.we" with position 1 of the current WorldEdit region as the origin.
100
101     //load some random filename
102     //load huge_base
103
104 License
105 -------
106 Copyright 2012 sfan5 and Anthony Zhang (Temperest)
107
108 This mod is licensed under the [GNU Affero General Public License](http://www.gnu.org/licenses/agpl-3.0.html).
109
110 Basically, this means everyone is free to use, modify, and distribute the files, as long as these modifications are also licensed the same way.
111
112 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.