Starbeamrainbowlabs
c84fa5f152
moondoc is the system we use for auto-generating Lua API docs Ref https://github.com/sbrl/moondoc |
||
|---|---|---|
| .docs | ||
| .github | ||
| .tests | ||
| .vscode | ||
| worldeditadditions | ||
| worldeditadditions_commands | ||
| worldeditadditions_core | ||
| worldeditadditions_farwand | ||
| .gitattributes | ||
| .gitignore | ||
| .luacheckrc | ||
| .luacov | ||
| API.md | ||
| bresenham.lua | ||
| build.sh | ||
| CHANGELOG.md | ||
| Chat-Command-Reference.md | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.tsv | ||
| Cookbook.md | ||
| FUNDING.yml | ||
| LICENSE | ||
| modpack.conf | ||
| modpack.txt | ||
| promise.lua | ||
| promise_tech.lua | ||
| README.md | ||
| rotate.js | ||
| screenshot.png | ||
| screenshot2.png | ||
| settingtypes.txt | ||
| test_count_chunks.lua | ||
| tests.sh | ||
| worldeditadditions-64.png | ||
| worldeditadditions.png | ||
WorldEditAdditions
Extra tools and commands to extend WorldEdit for Minetest
If you can dream of it, it probably belongs here!
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.
(Do you have a cool build that you used WorldEditAdditions to build? Get in touch and I'll feature your screenshot here!)
Table of Contents
- Quick Command Reference (including links to detailed explanations)
- Using the Far Wand
- Using the Cloud Wand
- Interactive Chat Command Reference (git)
- Lua API Reference
- Chat Command Cookbook
- Troubleshooting
- Contributing
- WorldEditAdditions around the web
- Licence
Quick Command Reference
The detailed explanations have moved! Check them out here (or edit at Chat-Command-Reference.md), or click the links below.
- Full chat command reference: https://worldeditadditions.mooncarrot.space/Reference/
- Lua API documentation (for mod developers and hackers): https://worldeditadditions.mooncarrot.space/api/
Geometry
//spline <replace_node> <width_start> [<width_end=width_start> [<steps=3>]]//dome+ <radius> <replace_node> [<pointing_dir:x|y|z|-x|-y|-z|?|front|back|left|right|up|down> ...] [h[ollow]]//metaball add <radius> | remove <index> | render <replace_node> [<threshold=1>] | list | clear | volume//ellipsoid <rx> <ry> <rz> <node_name> [h[ollow]]//ellipsoid2 <node_name> [h[ollow]]//hollowellipsoid <rx> <ry> <rz> <node_name>//torus <major_radius> <minor_radius> <node_name> [<axes=xy> [h[ollow]]]//hollowtorus <major_radius> <minor_radius> <node_name> [<axes=xy>]//walls <replace_node>//line [<replace_node> [<radius>]]//hollow [<wall_thickness>]//maze <replace_node> [<path_length> [<path_width> [<seed>]]]//maze3d <replace_node> [<path_length> [<path_width> [<path_depth> [<seed>]]]]//spiral2 [<circle|square>] [<replace_node=dirt> [<interval=3> [<acceleration=0>] ] ]//wbox <replace_node>//wcompass <replace_node> [<bead_node>]//wcorner <replace_node>
Misc
//rotate+ <axis> <degrees> [<axis> <degrees> ...] [origin|o [<pos_number>]](new in v1.15)//revolve <times> [<pivot_point_number=last_point>]//copy+ <axis:x|y|z|-x|-y|-z|?|front|back|left|right|up|down> <count> [<axis> <count> [...]]//move+ <axis:x|y|z|-x|-y|-z|?|front|back|left|right|up|down> <count> [<axis> <count> [...]]//set+ [param|param2|p2|light|l] <value>(new in v1.15)//replacemix <target_node> [<chance>] <replace_node_a> [<chance_a>] [<replace_node_b> [<chance_b>]] [<replace_node_N> [<chance_N>]] ....//floodfill [<replace_node> [<radius>]]//scale <axis> <scale_factor> | <factor_x> [<factor_y> <factor_z> [<anchor_x> <anchor_y> <anchor_z>]]experimental
Terrain
//overlay <node_name_a> [<chance_a>] <node_name_b> [<chance_b>] [<node_name_N> [<chance_N>]] ...//layers [<max_slope|min_slope..max_slope>] [<node_name_1> [<layer_count_1>]] [<node_name_2> [<layer_count_2>]] ...//fillcaves [<node_name>]//convolve <kernel> [<width>[,<height>]] [<sigma>]//erode [<snowballs|river> [<key_1> [<value_1>]] [<key_2> [<value_2>]] ...]experimental//noise2d [<key_1> [<value_1>]] [<key_2> [<value_2>]] ...]//sculpt [[<brush_name=default> [<brush_size=8> [<height=1>]]]//sculptlist [preview]
Flora
//bonemeal [<strength> [<chance> [<node_name> [<node_name> ...]]]]//forest [<density>] <sapling_a> [<chance_a>] <sapling_b> [<chance_b>] [<sapling_N> [<chance_N>]] ...(new in v1.9)//saplingaliases [aliases|all_saplings](new in v1.9)
Statistics
//count//basename <name>//ngroups <node_name> [v[erbose]](new in v1.15)//ndef <node_name>(new in v1.15)//uasparse <unified axis syntax>(new in v1.15)
Selection
//scol [<axis1> ] <length>//srect [<axis1> [<axis2>]] <length>//scube [<axis1> [<axis2> [<axis3>]]] <length>//scloud <0-6|stop|reset>//scentre//sgrow <unified axis syntax>(new in v1.15)//srel <unified axis syntax>//smake <operation:odd|even|equal> <mode:grow|shrink|average> [<target=xz> [<base>]]//sshrink <unified axis syntax>(new in v1.15)//sstack//spush//spop//sshift <unified axis syntax>//sfactor <mode:grow|shrink|average> <factor> [<target=xz>]//pos <index>//pos1//pos2//mark//unmark//reset
Measure
Meta
//multi <command_a> <command_b> ....//many <times> <command>(new in v1.9)//subdivide <size_x> <size_y> <size_z> <cmd_name> <args>//ellipsoidapply <command_name> <args>(new in v1.9)//airapply <command_name> <args>(new in v1.9)//noiseapply2d <threshold> <scale> <command_name> <args>(new in v1.13)//nodeapply <node_a> [<node_b>] [... <node_N>] -- <command_name> <args>//for <value1> <value2> <value3>... do //<command> <arg> %% <arg>(new in v1.13)
Extras
//y//n//speed [<value=1>](new in v1.15)
Tools
- WorldEditAdditions Far Wand
- WorldEditAdditions Cloud Wand
//farwand skip_liquid (true|false) | maxdist <number>
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, 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:
# 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)";
If you do not checkout the latest release, you will be using the development version of WorldEditAdditions. While every effort is made to ensure that the development version is stable at all times, this is not a guarantee.
Windows users, you'll need to check the releases page and find the name of the latest release, then do this instead of the git checkout above:
git checkout TAG_NAME_HERE
Integrations
WorldEditAdditions tries to be compatible with as many other mods and games as possible. If things aren't working as expected with your mod/game, please do open an issue and let us know.
Currently, we have explicit compatibility code added to support the following mods:
bonemeal: For//forest,//bonemeal, and other commands that use bonemeal to grow things.povafor adjusting player movement speed.
All compatibility code is optional: you don't have to have any of these mods installed in order to use WorldEditAdditions.
The following mods have known issues:
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.
I get a crash on startup saying attempt to call field 'alias_command' (a nil value)
Please update to v1.8+. There was a bug in earlier versions that caused a race condition that sometimes resulted in this crash.
Why don't the moretrees trees work with //forest?
As far as I can tell, the saplings provided by the moretrees mod don't properly interact with bonemeal from the bonemeal mod, 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.
The region markers look weird!
We've implemented a custom replacement for the WorldEdit region markers that supports selecting more than 2 points. This new WorldEditAdditions positioning system synchronises with WorldEdit's positioning system, so you can use both WorldEdit and WorldEditAdditions tools and commands interchangeably and they will seamlessly sync with each other.
The only side effect of this is that WorldEdit commands such as //shift are not aware of the new WorldEditAdditions positioning system, so you may encounter a situation where both WorldEdit and WorldEditAdditions region markers may display until you use another WorldEditAdditions command or tool to update them. This will be fixed in time as more commands and tools are implemented.
The position markers disappear when far way
This is a limitation of Minetest. You can workaround it though by setting active_block_range to a higher value - though be aware this also affects ABMs and other entities as well, so it can cause server lag.
The new positioning system now rectifies this issue with the region marker walls by creating a grid of entities instead of a single entity, such that a portion of them are more likely to be in range.
If this is not showing for you, please update WorldEditAdditions and try again.
Where's the documentation?
As linked above:
- Interactive Chat Command Reference (git)
- Lua API Reference (built with moondoc)
Building the website
The website that contains both of the above can be generated like so.
First, clone this git repository:
git clone git@git.github.com:sbrl/Minetest-WorldEditAdditions worldeditadditions;
cd worldeditadditions/.docs; # cd into the docs folder
Then, build the docs:
npm install
npm run build
Contributing
Contributions are welcome! Please state in your pull request(s) that you release your contribution under the Mozilla Public License 2.0.
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.
Lua API Documentation: https://worldeditadditions.mooncarrot.space/api/
Inspiration
Want to contribute, but finding it tough to find inspiration of what to implement? Here are some great places to look:
- Our issue tracker: There are always a bunch of issues open with cool commands and features that have yet to be implemented.
- Other software: Software for Minecraft is often far more mature than that available for Minetest. As a result, it's full of cool ideas. A lot of the existing commands in WorldEditAdditions were sourced from here.
- WorldEdit for Minecraft
- VoxelSniper(-Reimagined) for Minecraft
- WorldPainter for Minecraft
- Axiom for Minecraft
- Do some building: When you put WorldEditAdditions to use in building projects of your own, things will absolutely stand out to you what you want in the creative building process that WorldEditAdditions doesn't yet have.
- Watch others build stuff: Doesn't even have to be Minetest! There are lots of talented Minecraft builders with videos and series on e.g. YouTube. From their creative building processes, many ideas can be derived.
The ultimate goal is for WorldEditAdditions to support the creative building process in a way that enables builders of all backgrounds to create incredible things.
WorldEditAdditions around the web
Are you using WorldEditAdditions for a project? Open an issue and I'll add your project to the below list!
- @notsowow has built a magical mountain castle
- (No others that I'm aware of yet! Open an issue or get in touch and I'll link to your project (-:)
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.
All textures however are licenced under CC-BY-SA 4.0 (Creative Commons Attribution Share-Alike International 4.0).
If you'd like to do something that the license prohibits, please get in touch as it's possible we can negotiate something.
If WorldEditAdditions has helped you out in a project, please consider adding a little sign in a corner of your project saying so :-)