Wuzzy/minetest_perlin_explorer_2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tweak README a bit

Browse Source
This commit is contained in:
Wuzzy 2022-04-17 11:48:18 +02:00
parent 249494c15e
commit 5f5bd3f8b5
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -9,6 +9,15 @@ mapgen settings in Minetest.
This mod uses Minetest's builtin Perlin noise, so the same rules apply here.
Refer to Minetest's documentation to learn about noise parameters.
## /!\ WARNING WARNING WARNING /!\
This mod can aggressively **grief** your world due to its
mapgen feature! Don’t use it in worlds with buildings
you care about.
**NEVER** use this mod on a public server, it has not been
security-tested yet.
## Features
* Powerful noise parameter editor to quickly adjust parameters
@ -24,20 +33,19 @@ Refer to Minetest's documentation to learn about noise parameters.
## Usage
### Before you begin
**IMPORTANT**: This mod can aggressively grief your world! Only use this
mod in throwaway or test worlds (Development Test is fine).
**NEVER** use this mod on a public server, it has not been security-tested yet.
This document assumes you already have a rough understanding of what
Perlin noises are used for
Perlin noises are used for.
Before you start, everything in this mod requires the 'server' privilege.
So just start a world in singleplayer in a *new* throwaway world.
To use this mod, create a brand new world to avoid accidents.
Everything in this mod requires the `server` privilege, so obtain
this privilege as well.
### Overview
The main feature and tool in this mod is the Perlin Noise Creator. Using
this item opens a window in which you can view, modify, analyze and
manage noise parameters, generate nodes
manage noise parameters, generate nodes and perform some basic
analysis.
### What are noise parameters?
These are used by Minetest for the Perlin noises.
@ -55,9 +63,13 @@ manner so you can quickly get results. This is much more
efficient than tweaking the noise in the Minetest settings
or Lua code.
This document is *not* an introduction to Perlin noises
and noise parameters. Please refer to the Minetest Lua API
documentation to learn more.
### The tools
This section explains the various tools you have at your disposal.
Most tools come in item form, so check out your Creative Inventory
These tools are items, so check out your Creative Inventory
(or something similar) to get them.
#### Perlin Noise Creator
@ -134,7 +146,7 @@ The buttons do the following:
Note: Currently, profiles are temporary. They are **not** saved on shutdown!
#### Noise options
##### Noise options
This section roughly says how the noise parameters are “interpreted”. You
can do 3 things here:
@ -163,7 +175,7 @@ can do 3 things here:
The statistics are useful if you want to make sure certain values
occur with a certain probability.
#### Node generation
##### Node generation
Playing around with parameters isn’t very useful if you don’t
get a visual result. That’s where the node generation comes
@ -309,6 +321,9 @@ This can happen if `scale` is exactly 0. Remember the result of all noise
computations is multiplied with `scale` afterwards, and multiplying with
0 will, of course, eliminate it all.
## Credits
This mod was written by Wuzzy.
## License
This program is free software; you can redistribute it and/or modify