sbrl-github/Minetest-WorldEditAdditions
1
0
Fork 0
mirror of https://github.com/sbrl/Minetest-WorldEditAdditions.git synced 2024-11-26 09:03:01 +00:00
Code Issues Releases Wiki Activity

README: More //erode snowballs documentation

Browse source
This commit is contained in:
Starbeamrainbowlabs 2020-08-21 21:46:40 +01:00
parent 305ecb0a88
commit 71b7de4e10
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -257,14 +257,14 @@ The sigma value is only applicable to the `gaussian` kernel, and can be thought
//convolve gaussian 5 0.2 //convolve gaussian 5 0.2
``` ```
## `//erode [<snowballs|...> [<key_1> [<value_1>]] [<key_2> [<value_2>]] ...]` #### `//erode [<snowballs|...> [<key_1> [<value_1>]] [<key_2> [<value_2>]] ...]`
Runs an erosion algorithm over the defined region, optionally passing a number of key - value pairs representing parameters that are passed to the chosen algorithm. This command is **experimental**, as the author is currently on-the-fence about the effects it produces. Runs an erosion algorithm over the defined region, optionally passing a number of key - value pairs representing parameters that are passed to the chosen algorithm. This command is **experimental**, as the author is currently on-the-fence about the effects it produces.
Currently implemented algorithms: Currently implemented algorithms:
Algorithm | Mode | Description Algorithm | Mode | Description
------------|-------|------------------- ------------|-------|-------------------
`snowballs` | 2D | The default. Simulates snowballs rolling across the terrain, eroding & depositing material. Then runs a 3x3 gaussian kernel over the result (i.e. like the `//conv` / `//smoothadv` command). `snowballs` | 2D | The default - based on [this blog post](https://jobtalle.com/simulating_hydraulic_erosion.html). Simulates snowballs rolling across the terrain, eroding & depositing material. Then runs a 3x3 gaussian kernel over the result (i.e. like the `//conv` / `//smoothadv` command).
Usage examples: Usage examples:
@ -276,7 +276,8 @@ Usage examples:
Each of the algorithms above have 1 or more parameters that they support. These are detailed below. Each of the algorithms above have 1 or more parameters that they support. These are detailed below.
### Parameters: snowballs ### Algorithm: `snowballs`
Based on the algorithm detailed in [this blog post](https://jobtalle.com/simulating_hydraulic_erosion.html) ([direct link to the source code](https://github.com/jobtalle/HydraulicErosion/blob/master/js/archipelago/island/terrain/erosionHydraulic.js)), devised by [Job Talle](https://jobtalle.com/).
Parameter | Type | Default Value | Description Parameter | Type | Default Value | Description
--------------------|-----------|-------------------|------------------------ --------------------|-----------|-------------------|------------------------