How to use WorldEdit: Difference between revisions

From Vintage Story Wiki
Clarify that tv reloads the tree generators
(Clarify that tv reloads the tree generators)
 
(22 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<!--T:1-->
{{GameVersion|1.15}}
<!--T:2-->
__FORCETOC__
World Edit is a tool set for Vintage Story that offers powerful tools to paint three dimensionally with blocks. The tool set is available through textual commands but can also be controlled to a large extend through a graphical interface invoked by default by the [https://www.google.lv/search?q=tilde+key&hl=en&source=lnms&tbm=isch&sa=X&ved=0ahUKEwi18sX_s_TVAhXjbZoKHSJuB0kQ_AUICigB&biw=1920&bih=946 Tilde key].
World Edit is a tool set for Vintage Story that offers powerful tools to paint three dimensionally with blocks. The tool set is available through textual commands but can also be controlled to a large extend through a graphical interface invoked by default by the [https://www.google.lv/search?q=tilde+key&hl=en&source=lnms&tbm=isch&sa=X&ved=0ahUKEwi18sX_s_TVAhXjbZoKHSJuB0kQ_AUICigB&biw=1920&bih=946 Tilde key].


== Video Intro ==
== Video Intro == <!--T:3-->


<!--T:4-->
<youtube>we2WyxKSRuc</youtube>
<youtube>we2WyxKSRuc</youtube>


== Graphical interface ==
<!--T:47-->
<youtube>JFtADXlAWZU</youtube>
 
<!--T:48-->
<youtube>QfvgwwlAyvU</youtube>
 
 
== Graphical interface == <!--T:5-->


<!--T:6-->
The graphical interface is activated using the tilde (`) key, it's above the Tab key. If it doesn't work, check your keyboard controls in the settings. You have to be in creative mode to use it.
The graphical interface is activated using the tilde (`) key, it's above the Tab key. If it doesn't work, check your keyboard controls in the settings. You have to be in creative mode to use it.


<!--T:7-->
This UI makes use of the same feature set as the world edit commands (it literally just sends world edit commands to the server for you), however it does not support all of the commands yet, for example Area selection and modification has yet to added to the GUI
This UI makes use of the same feature set as the world edit commands (it literally just sends world edit commands to the server for you), however it does not support all of the commands yet, for example Area selection and modification has yet to added to the GUI


<!--T:8-->
In addition the right settings windows allow some extra settings, some of which are not available through worldedit.
In addition the right settings windows allow some extra settings, some of which are not available through worldedit.


<!--T:9-->
[[File:Worldeditgui.png|600px]]
[[File:Worldeditgui.png|600px]]


== Console interface ==
== Console interface == <!--T:10-->


<!--T:11-->
Some commands allow setting decimal numbers, you might need to use a comma (,) instead of dot (.) for entering those.
Some commands allow setting decimal numbers, you might need to use a comma (,) instead of dot (.) for entering those.


Line 43: Line 63:
</ul>
</ul>
<p>
<p>
<br><strong>Setting Range</strong>
=== Setting Range === <!--T:12-->
</p>
</p>


Line 54: Line 74:
</ul>
</ul>
<p>
<p>
<strong>Block Selection Preview</strong>
=== Block Selection Preview === <!--T:13-->
</p>
</p>


Line 69: Line 89:
</ul>
</ul>
<p>
<p>
<strong>Undo / Redo</strong>
=== Undo / Redo === <!--T:14-->
</p>
</p>


Line 83: Line 103:
</ul>
</ul>
<p>
<p>
<strong>Select, Import, Export, Clear,&nbsp;Fill</strong>
=== Select, Import, Export, Clear, Fill === <!--T:15-->
</p>
</p>


<!--T:16-->
<ul>
<ul>
<li>
<li>
<strong><span><span><span>/we ms</span></span></span></strong><span><span><span>&nbsp;<br>
<strong>/we ms</strong><br>
Marks your current position as the start point ("<strong>m</strong>ark <strong>s</strong>tart")</span></span></span><br>
Marks your current position as the start point ("<strong>m</strong>ark <strong>s</strong>tart")<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong><span><span><span>/we me&nbsp;</span></span></span></strong><br><span><span>Marks your current position as the end point&nbsp;("<strong>m</strong>ark <b>e</b>nd")</span></span><br>
<strong>/we me </strong><br>Marks your current position as the end point ("<strong>m</strong>ark <b>e</b>nd")<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we mc</strong><br>
<strong>/we mc</strong><br>
Un-Mark start and end position ("<strong>m</strong>ark&nbsp;<strong>c</strong>lear")<br>
Un-Mark start and end position ("<strong>m</strong>ark <strong>c</strong>lear")<br>
&nbsp;
</li>
<li>
<strong>/we mex [filename]</strong><br>Exports the area defined by the start and end point as json file in the vintage story data folder ("<strong>m</strong>arked <strong>ex</strong>port")<br>
</li>
</li>
<li>
<li>
<strong><span><span><span>/we mex [filename]</span></span></span></strong><br><span><span><span>Exports the area defined by the start and end point as json file in the vintage story data folder ("<strong>m</strong>arked <strong>ex</strong>port")</span></span></span><br>
<strong>/we mexc [filename]</strong><br>Exports the area defined by the start and end point, sends it as json file to the game client and stores in the vintage story data folder. This is useful when working on a dedicated server. Functions identically to /we mex when in single player.<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong><span><span><span>/we imp [filename]&nbsp;[origin]</span></span></span></strong><span><span><span>&nbsp;&nbsp;<br>
<strong>/we imp [filename] [origin]</strong><br>
Imports supplied json file at the defined start point. If the origin parameter is supplied with </span></span></span><span> </span>
Imports supplied json file at the defined start point. If the origin parameter is supplied with <span> </span>
<ul>
<ul>
<li>
<li>
<span><span><span>0 = Uses the start point as the bottom left front corner&nbsp;point (default) </span></span></span><span> </span>
0 = Uses the start point as the bottom left front corner point (default) <span> </span>
</li>
</li>
<li>
<li>
<span><span><span>1 = Uses the start point as the bottom center&nbsp;point </span></span></span><span> </span>
1 = Uses the start point as the bottom center point <span> </span>
</li>
</li>
<li>
<li>
<span><span><span>2 =&nbsp;Uses the start point as the top center point</span></span></span><br>
2 = Uses the start point as the top center point<br>
&nbsp;
</li>
</li>
</ul>
</ul>
Line 123: Line 148:
<li>
<li>
<strong>/we impr [0, 90, 180 or 270]</strong><br>
<strong>/we impr [0, 90, 180 or 270]</strong><br>
When importing block data using&nbsp;<em>/we imp</em>&nbsp;the imported block data will first be rotated by given angle.&nbsp;<br>
When importing block data using <em>/we imp</em> the imported block data will first be rotated by given angle.<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we impflip</strong><br>
<strong>/we impflip</strong><br>
When importing block data using&nbsp;<em>/we imp</em>&nbsp;the imported block data will first be vertically flipped<br>
When importing block data using <em>/we imp</em> the imported block data will first be vertically flipped<br>
&nbsp;
</li>
        <li>
<strong>/we impres [on|off]</strong><br>
Import item/block resolving mode. Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn<br>
</li>
</li>
<li>
<li>
<strong><span><span><span>/we mfill</span></span></span></strong><span><span>&nbsp;<br>
<strong>/we mfill</strong><br>
Fills the marked area defined by the start and end point with the block in your currently selected hotbar slot&nbsp;("<strong>m</strong>arked <b>fill</b>")</span></span><br>
Fills the marked area defined by the start and end point with the block in your currently selected hotbar slot ("<strong>m</strong>arked <b>fill</b>")<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong><span><span><span>/we mclear</span></span></span></strong><span><span>&nbsp;<br>
<strong>/we mclear</strong><br>
Clears the marked area defined by the start and end point&nbsp;</span>("<strong>m</strong>arked <b>clear</b>")</span><br>
Clears the marked area defined by the start and end point </span>("<strong>m</strong>arked <b>clear</b>")</span><br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we mcopy</strong><br>
<strong>/we mcopy</strong><br>
Copies the marked area.<br>
Copies the marked area.<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we mpaste</strong><br>
<strong>/we mpaste</strong><br>
Pastes the previously copied area to the defined start point.<br>
Pastes the previously copied area to the defined start point.<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we mm[u,d,n,e,s,w] [length]</strong><br>
<strong>/we mm[u,d,n,e,s,w] [length]</strong><br>
Moves the contents inside marked area in given direction by given length (default 1). Examples:<br><strong>/we mmu&nbsp;</strong>- Moves the marked area up by 1 block<br><strong>/we mms 5</strong>&nbsp;- Moves the marked area south by 5 blocks<br>
Moves the contents inside marked area in given direction by given length (default 1). Examples:<br><strong>/we mmu </strong>- Moves the marked area up by 1 block<br><strong>/we mms 5</strong> - Moves the marked area south by 5 blocks<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we mmby [x] [y] [z]</strong><br>
<strong>/we mmby [x] [y] [z]</strong><br>
Moves the contents inside marked area by given x/y/z length. Example:<br><strong>/we mmby 5 1 -2</strong>&nbsp;- Moves the marked area 5 blocks in x-direction, 1 block up and -2 blocks in z-direction<br>
Moves the contents inside marked area by given x/y/z length. Example:<br><strong>/we mmby 5 1 -2</strong> - Moves the marked area 5 blocks in x-direction, 1 block up and -2 blocks in z-direction<br>
&nbsp;
</li>
</li>


<li>
<!--T:17-->
<li>
<strong>/we mr [90|180|270]</strong><br>
<strong>/we mr [90|180|270]</strong><br>
Rotates the contents inside marked area by given angle.
Rotates the contents inside marked area by given angle.<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we clear [width&amp;length] [height]</strong><br>Deletes all blocks inside a cuboid around the player, delimited by supplied size arguments<br>
<strong>/we clear [width&amp;length] [height]</strong><br>Deletes all blocks inside a cuboid around the player, delimited by supplied size arguments<br>
&nbsp;
</li>
</li>
<li>
<li>
Line 186: Line 213:




<li>
<!--T:18-->
<li>
<strong>/we block</strong><br>
<strong>/we block</strong><br>
Places a block under your feet. Uses the block actively selected in your hotbar.<br>
Places a block under your feet. Uses the block actively selected in your hotbar.<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we sovp [0-1]</strong><br>
<strong>/we sovp [0-1]</strong><br>
Disable/Enable <strong>s</strong>erver <strong>ov</strong>erload <strong>p</strong>rotection. This protection prevents certain actions that are likely to kill the server, so it is not recommended to turn it off.<br>
Disable/Enable <strong>s</strong>erver <strong>ov</strong>erload <strong>p</strong>rotection. This protection prevents certain actions that are likely to kill the server, so it is not recommended to turn it off.<br>
&nbsp;
</li>
</li>


<!--T:19-->
<li>
<li>
<strong>/we g[u,d,n,e,s,w] [length]</strong><br>
<strong>/we g[u,d,n,e,s,w] [length]</strong><br>
Grows&nbsp;the current selection given length (default 1). Examples:<br><strong>/we gu&nbsp;</strong>- Grows the selection up by 1 block<br><strong>/we gn -3</strong>&nbsp;- Shrinks the selection from the north side<br>
Grows or shrinks the current selection by a given length (default 1). If length is a positive number, the selection will be grown, otherwise it will be shrunk.
&nbsp;
 
<!--T:49-->
Examples:<br><strong>/we gu </strong>- Grows the selection up by 1 block<br><strong>/we gn -3</strong> - Shrinks the selection from the north side by 3 blocks<br>
</li>
</li>
<li>
<li>
<strong>/we mmir[u,d,n,e,s,w] [|gn|sn]</strong><br>
<strong>/we mmir[u,d,n,e,s,w] [|gn|sn]</strong><br>
Mirrors the marked area in given direction. If the second parameter is set, the current marked area will be modified to select the newly created area (<strong>sn</strong>)&nbsp;to to grow the selection to include both the old and new area (<strong>gn</strong>). Examples:<br><strong>/we mmire</strong>&nbsp;- Mirrors the marked area to direction east<br><strong>/wemmiru sn</strong>&nbsp;- Mirrors the marked area to direction up and will select the mark placed blocks.<br>
Mirrors the marked area in given direction. If the second parameter is set, the current marked area will be modified to select the newly created area (<strong>sn</strong>) to to grow the selection to include both the old and new area (<strong>gn</strong>). Examples:<br><strong>/we mmire</strong> - Mirrors the marked area to direction east<br><strong>/wemmiru sn</strong> - Mirrors the marked area to direction up and will select the mark placed blocks.<br>
&nbsp;
</li>
</li>
<li>
<li>
<strong>/we mrep[u,d,n,e,s,w] [count] [|gn|sn]</strong><br>
<strong>/we mrep[u,d,n,e,s,w] [count] [|gn|sn]</strong><br>
Repeats (copies) the marked area in given direction for <em>count </em>times (default 1).&nbsp;If the third parameter is set, the current marked area will be modified to select the newly created area (<strong>sn</strong>)&nbsp;to to grow the selection to include both the old and new area (<strong>gn</strong>). Examples:<br><strong>/we mreps</strong>&nbsp;- Repeats the marked area once to direction south<br><strong>/we mrepu 5</strong>&nbsp;- Repeats the marked area 5 times to direction up<br><strong>/we mrepw 1 sn</strong>&nbsp;- Repeats the marked area once to direction south and will mark the newly placed blocks.
Repeats (copies) the marked area in given direction for <em>count </em>times (default 1). If the third parameter is set, the current marked area will be modified to select the newly created area (<strong>sn</strong>) to to grow the selection to include both the old and new area (<strong>gn</strong>). Examples:<br><strong>/we mreps</strong> - Repeats the marked area once to direction south<br><strong>/we mrepu 5</strong> - Repeats the marked area 5 times to direction up<br><strong>/we mrepw 1 sn</strong> - Repeats the marked area once to direction south and will mark the newly placed blocks.
</li>
</li>
</ul>
</ul>


== Console interface - Tools ==
== Console interface - Tools == <!--T:20-->


<!--T:21-->
<ul>
<ul>
<li>
<li>
Line 285: Line 318:
</p>
</p>


=== Paint Brush Tool ===
=== Paint Brush Tool === <!--T:22-->
[[File:Paintbrush.png|300px|right]]
[[File:Paintbrush.png|300px|right]]
Left mouse click: No effect<br>
Left mouse click: No effect<br>
Line 329: Line 362:




<li>
<!--T:23-->
<li>
<strong>/we tcr&nbsp;(dec. number)&nbsp;[dec. number]&nbsp;[dec. number]</strong><br>
<strong>/we tcr&nbsp;(dec. number)&nbsp;[dec. number]&nbsp;[dec. number]</strong><br>
Sets the cutout radius or length in x, y and z direction. The 2nd and 3d value is optional. Setting this radius to 0 gives you a normal brush, setting it to a non-zero value lets you create hollow shapes.<br>
Sets the cutout radius or length in x, y and z direction. The 2nd and 3d value is optional. Setting this radius to 0 gives you a normal brush, setting it to a non-zero value lets you create hollow shapes.<br>
Line 336: Line 370:




<li>
<!--T:24-->
<li>
<strong>/we ts [0-8]</strong><br>
<strong>/we ts [0-8]</strong><br>
Sets the paint brushes shape
Sets the paint brushes shape
Line 371: Line 406:
</ul>
</ul>


===Raise and Lower Tool===
===Raise and Lower Tool=== <!--T:25-->


<!--T:26-->
[[File:Raiselower.png|300px|right]]
[[File:Raiselower.png|300px|right]]
<span style="font-size:14px;">Left mouse click: Lower Terrain<br>
<span style="font-size:14px;">Left mouse click: Lower Terrain<br>
Line 409: Line 445:
</ul>
</ul>


=== Air brush Tool ===
=== Air brush Tool === <!--T:27-->


<!--T:28-->
[[File:Airbrush.png|300px|right]]
[[File:Airbrush.png|300px|right]]
Left mouse click: Randomly remove a bunch of blocks within a given radius, only works in draw mode 'Replace'<br>
Left mouse click: Randomly remove a bunch of blocks within a given radius, only works in draw mode 'Replace'<br>
Line 454: Line 491:
</ul>
</ul>


=== Erode Tool ===
=== Erode Tool === <!--T:29-->


<!--T:30-->
<p>
<p>
[[File:Erode.png|300px|right]]
[[File:Erode.png|300px|right]]
Line 464: Line 502:




<!--T:31-->
<ul>
<ul>
<li>
<li>
Line 482: Line 521:




<li>
<!--T:32-->
<li>
<strong>/we tusb (0 or 1)</strong><br>
<strong>/we tusb (0 or 1)</strong><br>
"Use selected block". When set to 1, any placed block will be the one held in hands. When set to 0 any placed block will be the one found below the given location.
"Use selected block". When set to 1, any placed block will be the one held in hands. When set to 0 any placed block will be the one found below the given location.
</li>
</li>


<!--T:33-->
</ul>
</ul>
<p>
<p>
Line 492: Line 533:
</p>
</p>


=== Import Tool ===
=== Import Tool === <!--T:34-->
<p>
<p>
Left mouse click: No effect<br>
Left mouse click: No effect<br>
Line 501: Line 542:




<!--T:35-->
<ul>
<ul>
<li>
<li>
Line 572: Line 614:
</ul>
</ul>


=== Eraser Tool ===
=== Eraser Tool === <!--T:36-->
<p>
<p>
Left mouse click: Removes blocks in given shape&nbsp;of currently selected block in your hotbar<br>
Left mouse click: Removes blocks in given shape&nbsp;of currently selected block in your hotbar<br>
Line 584: Line 626:
</ul>
</ul>


=== Grow / Shrink Tool ===
=== Grow / Shrink Tool === <!--T:37-->
<p>
<p>
Left mouse click: Shrinks all shapes inside given radius<br>
Left mouse click: Shrinks all shapes inside given radius<br>
Line 591: Line 633:




<!--T:38-->
<ul>
<ul>
<li>
<li>
Line 613: Line 656:




=== Line Tool ===
=== Line Tool === <!--T:39-->
<p>
<p>
Left mouse click: Marks the select position as the start point of the line<br>
Left mouse click: Marks the select position as the start point of the line<br>
Line 620: Line 663:




<!--T:40-->
<ul>
<ul>
<li>
<li>
Line 643: Line 687:
</p>
</p>


=== TreeGen Tool ===
=== TreeGen Tool === <!--T:41-->
<p>
<p>
Left mouse click: No effect<br>
Left mouse click: No effect<br>
Line 650: Line 694:




<!--T:42-->
<ul>
<ul>
<li>
<li>
Line 661: Line 706:
<strong>/we tv [name]</strong><br>
<strong>/we tv [name]</strong><br>
Sets the tree variant. Currently available is:&nbsp;dwarfbirch, englishoak, fir, himalayanbirch, japanesemaple, kapok, mountainmaple, mountainpine, oldenglishoak, oldkapok, pricklymoses, riverbirch, scotspine, silverbirch, sugarmaple, sugarmaplesmall and truemulga.<br><br>
Sets the tree variant. Currently available is:&nbsp;dwarfbirch, englishoak, fir, himalayanbirch, japanesemaple, kapok, mountainmaple, mountainpine, oldenglishoak, oldkapok, pricklymoses, riverbirch, scotspine, silverbirch, sugarmaple, sugarmaplesmall and truemulga.<br><br>
You can also add your own tree variant by adding a new tree generator config in assets/worldgen/tree/<br>
You can also add your own tree variant by adding a new tree generator config in assets/worldgen/tree/. Before selecting the tree variant, this command reloads all of the tree generators from the json files.<br>
&nbsp;
&nbsp;
</li>
</li>
</ul>
</ul>


=== Flood Fill Tool ===
=== Flood Fill Tool === <!--T:43-->
<p>
<p>
Left mouse click: No effect<br>
Left mouse click: Tries to erase selected area within given radius<br>
Right mouse click: Tries to flood fill selected area within given radius
Right mouse click: Tries to flood fill selected area within given radius (will also replace all blocks of Plant block material)
</p>
</p>






<!--T:44-->
<ul>
<ul>
<li>
<li>
<strong>/we tr [number]</strong><br>
<strong>/we tr [number]</strong><br>
Sets the search radius on how far the flood fill should reach<br>
Sets the search radius on how far the flood fill should reach<br>
</li>
<li>
<strong>/we trl [0-9999]</strong><br>
Sets the replaceable level (default 6000). If set to 9000, water will not be replaced<br>
</li>
</li>
<li>
<li>
Line 689: Line 739:
</li>
</li>


<!--T:45-->
</ul>
</ul>
</translate>
{{Game navbox}}
[[Category:Creative Mode{{#translation:}}]]
Confirmedusers
261

edits