2021-06-20 21:56:08 +00:00
# ![](https://raw.githubusercontent.com/sbrl/Minetest-WorldEditAdditions/main/worldeditadditions-64.png) Minetest-WorldEditAdditions
2021-05-30 00:47:05 +00:00
![GitHub release (latest by date) ](https://img.shields.io/github/v/release/sbrl/Minetest-WorldEditAdditions?color=green&label=latest%20release ) [![View the changelog ](https://img.shields.io/badge/%F0%9F%93%B0-Changelog-informational )](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/CHANGELOG.md) [![ContentDB ](https://content.minetest.net/packages/Starbeamrainbowlabs/worldeditadditions/shields/downloads/ )](https://content.minetest.net/packages/Starbeamrainbowlabs/worldeditadditions/)
2020-06-25 22:49:50 +00:00
2018-05-22 21:20:26 +00:00
> Extra tools and commands to extend WorldEdit for Minetest
2018-06-09 19:11:46 +00:00
If you can dream of it, it probably belongs here!
2021-03-17 21:38:36 +00:00
**Important News: The `master` branch has been renamed to `main` , to follow the new standard across the Git ecosystem. If you've installed _WorldEditAadditions_ through git, you will need to re-clone the repository.**
2021-05-30 00:47:05 +00:00
![Screenshot ](https://raw.githubusercontent.com/sbrl/Minetest-WorldEditAdditions/main/screenshot.png )
2019-05-30 10:45:41 +00:00
2021-02-08 15:09:17 +00:00
_(Do you have a cool build that you used WorldEditAdditions to build? [Get in touch ](https://github.com/sbrl/Minetest-WorldEditAdditions/issues/new ) and I'll feature your screenshot here!)_
2020-08-21 22:46:48 +00:00
## Table of Contents
2020-08-21 22:47:05 +00:00
- [Quick Command Reference ](#quick-command-reference ) (including links to detailed explanations)
2021-05-30 00:47:05 +00:00
- [Using the Far Wand ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#far-wand )
- [Using the Cloud Wand ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#cloud-wand )
- [Detailed Chat Command Explanations ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md )
- [Chat Command Cookbook ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Cookbook.md )
2020-08-21 22:46:48 +00:00
- [Troubleshooting ](#troubleshooting )
- [Contributing ](#contributing )
- [WorldEditAdditions around the web ](#worldeditadditions-around-the-web )
- [Licence ](#license )
2020-05-14 20:44:46 +00:00
## Quick Command Reference
2022-01-03 12:53:41 +00:00
The detailed explanations have moved! Check them out [here ](https://worldeditadditions.mooncarrot.space/Reference/ ), or click the links below.
2018-06-09 19:06:39 +00:00
2020-06-10 00:44:04 +00:00
### Geometry
2021-08-07 20:22:27 +00:00
- [`//ellipsoid < rx > < ry > < rz > < node_name > [h[ollow]]`](https://worldeditadditions.mooncarrot.space/Reference/#ellipsoid)
2021-10-14 00:50:27 +00:00
- [`//ellipsoid2 < node_name > [h[ollow]]`](https://worldeditadditions.mooncarrot.space/Reference/#ellipsoid2)
2021-08-07 20:22:27 +00:00
- [`//hollowellipsoid <rx> <ry> <rz> <node_name>` ](https://worldeditadditions.mooncarrot.space/Reference/#hollowellipsoid )
- [`//torus < major_radius > < minor_radius > < node_name > [< axes = xy > [h[ollow]]]`](https://worldeditadditions.mooncarrot.space/Reference/#torus)
- [`//hollowtorus < major_radius > < minor_radius > < node_name > [< axes = xy > ]`](https://worldeditadditions.mooncarrot.space/Reference/#hollowtorus)
- [`//walls <replace_node>` ](https://worldeditadditions.mooncarrot.space/Reference/#walls )
- [`//line [< replace_node > [< radius > ]]`](https://worldeditadditions.mooncarrot.space/Reference/#line)
- [`//hollow [< wall_thickness > ]`](https://worldeditadditions.mooncarrot.space/Reference/#hollow)
- [`//maze < replace_node > [< path_length > [< path_width > [< seed > ]]]`](https://worldeditadditions.mooncarrot.space/Reference/#maze)
- [`//maze3d < replace_node > [< path_length > [< path_width > [< path_depth > [< seed > ]]]]`](https://worldeditadditions.mooncarrot.space/Reference/#maze3d)
2021-11-07 01:02:36 +00:00
- [`//spiral2 [< circle | square > ] [< replace_node = dirt > [< interval = 3 > [< acceleration = 0 > ] ] ]`](https://worldeditadditions.mooncarrot.space/Reference/#spiral2)
2022-01-03 12:49:59 +00:00
- [`//wbox <replace_node>` ](https://worldeditadditions.mooncarrot.space/Reference/#wbox )
- [`//wcompass < replace_node > [< bead_node > ]`](https://worldeditadditions.mooncarrot.space/Reference/#wcompass)
- [`//wcorner <replace_node>` ](https://worldeditadditions.mooncarrot.space/Reference/#wcorner )
2020-06-10 00:44:04 +00:00
### Misc
2022-01-03 12:49:59 +00:00
- [`//copy+ < axis:x | y | z | -x | -y | -z |?| front | back | left | right | up | down > < count > [< axis > < count > [...]]`](https://worldeditadditions.mooncarrot.space/Reference/#copy)
- [`//move+ < axis:x | y | z | -x | -y | -z |?| front | back | left | right | up | down > < count > [< axis > < count > [...]]`](https://worldeditadditions.mooncarrot.space/Reference/#move)
2021-08-07 20:22:27 +00:00
- [`//replacemix < target_node > [< chance > ] < replace_node_a > [< chance_a > ] [< replace_node_b > [< chance_b > ]] [< replace_node_N > [< chance_N > ]] ....`](https://worldeditadditions.mooncarrot.space/Reference/#replacemix)
- [`//floodfill [< replace_node > [< radius > ]]`](https://worldeditadditions.mooncarrot.space/Reference/#floodfill)
- [`//scale < axis > < scale_factor > | < factor_x > [< factor_y > < factor_z > [< anchor_x > < anchor_y > < anchor_z > ]]`](https://worldeditadditions.mooncarrot.space/Reference/#scale) **experimental**
2020-06-10 00:44:04 +00:00
### Terrain
2021-08-07 20:22:27 +00:00
- [`//overlay < node_name_a > [< chance_a > ] < node_name_b > [< chance_b > ] [< node_name_N > [< chance_N > ]] ...`](https://worldeditadditions.mooncarrot.space/Reference/#overlay)
2021-10-04 20:51:07 +00:00
- [`//layers [< max_slope | min_slope .. max_slope > ] [< node_name_1 > [< layer_count_1 > ]] [< node_name_2 > [< layer_count_2 > ]] ...`](https://worldeditadditions.mooncarrot.space/Reference/#layers)
2021-08-07 20:22:27 +00:00
- [`//fillcaves [< node_name > ]`](https://worldeditadditions.mooncarrot.space/Reference/#fillcaves)
- [`//convolve < kernel > [< width > [,< height > ]] [< sigma > ]`](https://worldeditadditions.mooncarrot.space/Reference/#convolve)
- [`//erode [< snowballs | river > [< key_1 > [< value_1 > ]] [< key_2 > [< value_2 > ]] ...]`](https://worldeditadditions.mooncarrot.space/Reference/#erode) **experimental**
2021-08-07 22:10:40 +00:00
- [`//noise2d [< key_1 > [< value_1 > ]] [< key_2 > [< value_2 > ]] ...]`](https://worldeditadditions.mooncarrot.space/Reference/#noise2d)
2021-12-31 12:44:15 +00:00
- [`//sculpt [< brush_name = default > [< height = 5 > [< brush_size = 10 > ]]]`](https://worldeditadditions.mooncarrot.space/Reference/#sculpt)
- [`//sculptlist [preview]`](https://worldeditadditions.mooncarrot.space/Reference/#sculptlist)
2020-06-10 00:44:04 +00:00
2020-09-14 01:12:05 +00:00
### Flora
2021-10-04 20:51:07 +00:00
- [`//bonemeal [< strength > [< chance > [< node_name > [< node_name > ...]]]]`](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#bonemeal-strength-chance)
2021-08-07 20:22:27 +00:00
- [`//forest [< density > ] < sapling_a > [< chance_a > ] < sapling_b > [< chance_b > ] [< sapling_N > [< chance_N > ]] ...`](https://worldeditadditions.mooncarrot.space/Reference/#forest) _(new in v1.9)_
- [`//saplingaliases [aliases|all_saplings]`](https://worldeditadditions.mooncarrot.space/Reference/#saplingaliases) _(new in v1.9)_
2020-09-14 01:12:05 +00:00
2020-06-10 00:44:04 +00:00
### Statistics
2021-08-07 20:22:27 +00:00
- [`//count` ](https://worldeditadditions.mooncarrot.space/Reference/#count )
2021-10-04 21:12:41 +00:00
- [`//basename <name>` ](https://worldeditadditions.mooncarrot.space/Reference/#basename )
2020-06-10 00:41:13 +00:00
2021-03-01 22:34:06 +00:00
### Selection
2021-08-07 20:22:27 +00:00
- [`//scol [< axis1 > ] < length > `](https://worldeditadditions.mooncarrot.space/Reference/#scol)
- [`//srect [< axis1 > [< axis2 > ]] < length > `](https://worldeditadditions.mooncarrot.space/Reference/#srect)
- [`//scube [< axis1 > [< axis2 > [< axis3 > ]]] < length > `](https://worldeditadditions.mooncarrot.space/Reference/#scube)
- [`//scloud <0-6|stop|reset>` ](https://worldeditadditions.mooncarrot.space/Reference/#scloud )
- [`//scentre` ](https://worldeditadditions.mooncarrot.space/Reference/#scentre )
- [`//srel < axis1 > < length1 > [< axis2 > < length2 > [< axis3 > < length3 > ]]`](https://worldeditadditions.mooncarrot.space/Reference/#srel)
- [`//smake < operation:odd | even | equal > < mode:grow | shrink | average > [< target = xz > [< base > ]]`](https://worldeditadditions.mooncarrot.space/Reference/#smake)
- [`//sstack` ](https://worldeditadditions.mooncarrot.space/Reference/#sstack )
- [`//spush` ](https://worldeditadditions.mooncarrot.space/Reference/#spush )
- [`//spop` ](https://worldeditadditions.mooncarrot.space/Reference/#spop )
2022-01-03 12:49:59 +00:00
- [`//sshift < axis1 > < length1 > [< axis2 > < length2 > [< axis3 > < length3 > ]]`](https://worldeditadditions.mooncarrot.space/Reference/#sshift)
- [`//sfactor < mode:grow | shrink | average > < factor > [< target = xz > ]`](https://worldeditadditions.mooncarrot.space/Reference/#sfactor)
2021-07-15 18:45:06 +00:00
### Measure
2021-08-07 21:35:32 +00:00
- [`//mface` ](https://worldeditadditions.mooncarrot.space/Reference/#mface ) _(new in v1.13)_
- [`//midpos` ](https://worldeditadditions.mooncarrot.space/Reference/#midpos ) _(new in v1.13)_
- [`//msize` ](https://worldeditadditions.mooncarrot.space/Reference/#msize ) _(new in v1.13)_
- [`//mtrig` ](https://worldeditadditions.mooncarrot.space/Reference/#mtrig ) _(new in v1.13)_
2021-07-15 18:45:06 +00:00
2020-09-20 21:07:47 +00:00
### Meta
2021-08-07 20:22:27 +00:00
- [`//multi <command_a> <command_b> ....` ](https://worldeditadditions.mooncarrot.space/Reference/#multi )
- [`//many <times> <command>` ](https://worldeditadditions.mooncarrot.space/Reference/#many ) _(new in v1.9)_
- [`//subdivide <size_x> <size_y> <size_z> <cmd_name> <args>` ](https://worldeditadditions.mooncarrot.space/Reference/#subdivide )
- [`//ellipsoidapply <command_name> <args>` ](https://worldeditadditions.mooncarrot.space/Reference/#ellipsoidapply ) _(new in v1.9)_
- [`//airapply <command_name> <args>` ](https://worldeditadditions.mooncarrot.space/Reference/#airapply ) _(new in v1.9)_
2021-08-07 22:10:40 +00:00
- [`//noiseapply2d <threshold> <scale> <command_name> <args>` ](https://worldeditadditions.mooncarrot.space/Reference/#noiseapply2d ) _(new in v1.13)_
2022-01-03 12:49:59 +00:00
- [`//for <value1> <value2> <value3>... do //<command> <arg> %% <arg>` ](https://worldeditadditions.mooncarrot.space/Reference/#for ) _(new in v1.13)_
2020-09-20 21:07:47 +00:00
### Extras
2021-05-30 00:47:05 +00:00
- [`//y` ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#y )
- [`//n` ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#n )
2019-06-16 13:13:05 +00:00
2020-06-21 17:05:56 +00:00
### Tools
2021-05-30 00:47:05 +00:00
- [WorldEditAdditions Far Wand ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#far-wand )
2021-06-26 11:20:31 +00:00
- [WorldEditAdditions Cloud Wand ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#cloud-wand )
2021-05-30 00:47:05 +00:00
- [`//farwand skip_liquid (true|false) | maxdist <number>` ](https://github.com/sbrl/Minetest-WorldEditAdditions/blob/main/Chat-Command-Reference.md#farwand-skip_liquid-truefalse--maxdist-number )
2020-06-21 17:05:56 +00:00
2021-03-17 22:04:09 +00:00
## Installation
You can install _WorldEditAadditions_ in multiple ways:
### Through ContentDB
WorldEditAdditions is on ContentDB here: < https: / / content . minetest . net / packages / Starbeamrainbowlabs / worldeditadditions / > .
### Through the latest release
You can get a copy of WorldEditAdditions by downloading the source code for the [latest release ](https://github.com/sbrl/Minetest-WorldEditAdditions/releases/latest ), but this is not recommended because it takes additional effort to update to the latest version.
### Through Git
You can also clone this git repository. Note that the `main` branch is not considered to be stable at all times - though it shouldn't crash. It is recommended that you checkout a release to ensure stability. Do that like so:
```bash
# First, clone the repository
git clone https://github.com/sbrl/Minetest-WorldEditAdditions.git WorldEditAdditions
cd WorldEditAdditions
# Then, checkout the latest release on Linux:
git checkout "$(git describe --tags --abbrev=0)";
```
Windows users, you'll need to check the [releases page ](https://github.com/sbrl/Minetest-WorldEditAdditions/releases ) and find the name of the latest release, then do this instead of the `git checkout` above:
```bash
git checkout TAG_NAME_HERE
```
2020-05-10 20:24:34 +00:00
## Troubleshooting
If you're experiencing issues with this mod, try checking this FAQ before opening an issue.
### I get an error saying that worldedit isn't installed
WorldEditAdditions requires that the `worldedit` mod is installed as a dependency. Install it and then try launching Minetest (or the `minetest-server` ) again.
### I get an error saying that `worldedit.register_command()` is not a function
This is probably because your version of `worldedit` is too old. Try updating it. Specifically the `worldedit.register_command()` function was only added to `worldedit` in December 2019.
2020-10-10 16:26:04 +00:00
### I get a crash on startup saying `attempt to call field 'alias_command' (a nil value)`
2020-07-17 16:20:48 +00:00
Please update to v1.8+. There was a bug in earlier versions that caused a race condition that sometimes resulted in this crash.
2020-10-10 16:21:01 +00:00
### Why don't the [moretrees](https://content.minetest.net/packages/VanessaE/moretrees/) trees work with `//forest`?
As far as I can tell, the saplings provided by the [`moretrees` mod ](https://content.minetest.net/packages/VanessaE/moretrees/ ) don't properly interact with bonemeal from the [bonemeal mod ](https://content.minetest.net/packages/TenPlus1/bonemeal/ ), which WorldEditAdditions uses to grow trees. As far as I can tell WorldEditAdditions has everything in place needed to support them, but until applying bonemeal to `moretrees` saplings results in a tree rather than waiting for one to grow over time, WorldEditAdditions will always fail to place trees provided by the `moretrees` mod, unfortunately.
2020-05-10 20:32:01 +00:00
2018-06-09 19:11:46 +00:00
## Contributing
Contributions are welcome! Please state in your pull request(s) that you release your contribution under the _Mozilla Public License 2.0_ .
2021-07-26 23:35:18 +00:00
Please also make sure that the logic for every new command has it's own file. For example, the logic for `//floodfill` goes in `worldeditadditions/floodfill.lua` , the logic for `//overlay` goes in `worldeditadditions/overlay.lua` , etc. More contributing help can be found in [the contributing guide ](CONTRIBUTING.md ).
2021-07-26 23:29:01 +00:00
2021-03-15 23:37:46 +00:00
I, Starbeamrainbowlabs (@sbrl), have the ultimate final say.
2020-06-21 17:05:56 +00:00
2020-05-11 01:14:49 +00:00
## WorldEditAdditions around the web
Are you using WorldEditAdditions for a project? Open an issue and I'll add your project to the below list!
2020-09-20 23:37:15 +00:00
- _(None that I'm aware of yet! Open an issue or get in touch and I'll link to your project (-:)_
2020-05-11 01:14:49 +00:00
2018-06-09 19:11:46 +00:00
## License
This mod is licensed under the _Mozilla Public License 2.0_ , a copy of which (along with a helpful summary as to what you can and can't do with it) can be found in the `LICENSE` file in this repository.
2020-06-13 13:25:00 +00:00
All textures however are licenced under [CC-BY-SA 4.0 ](https://creativecommons.org/licenses/by-sa/4.0/ ) (Creative Commons Attribution Share-Alike International 4.0).
2018-06-09 19:11:46 +00:00
If you'd like to do something that the license prohibits, please get in touch as it's possible we can negotiate something.
2020-05-11 01:14:49 +00:00
If WorldEditAdditions has helped you out in a project, please consider adding a little sign in a corner of your project saying so :-)