Proof-read and fix README
This commit is contained in:
Wuzzy
parent
18546cc500
commit
34849dac41
88
README.md
88
README.md
@ -16,7 +16,7 @@ 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.
|
||||
security-tested.
|
||||
|
||||
## Features
|
||||
|
||||
@ -26,7 +26,7 @@ security-tested yet.
|
||||
* Color denotes value, cutoff points can be customized
|
||||
* Choose between solid nodes, transparent grid nodes, and tiny climbable cube nodes
|
||||
* Generate a small portion of the noise as map at a given area
|
||||
* Enable “mapgen mode” to automatically generate a map as you move around
|
||||
* Enable “mapgen mode” to automatically generate nodes as you move around
|
||||
* Load predefined Perlin noises from the Minetest configuration
|
||||
* Save noise parameters into profiles for later use
|
||||
* Mathematical and statistical analysis of noises
|
||||
@ -49,12 +49,12 @@ analysis.
|
||||
|
||||
### What are noise parameters?
|
||||
These are used by Minetest for the Perlin noises.
|
||||
Perlin noises are used various things such as generating the map,
|
||||
Perlin noises are used for various things such as generating the world,
|
||||
decorations (trees, plants, etc.), ores, biomes and much more.
|
||||
|
||||
And noise parameters are, well, the parameters that are used
|
||||
to tweak the Perlin noises. They change the output numbers,
|
||||
they stretch or squeeze the noise, they might it make more
|
||||
they stretch or squeeze the noise, they make more or less
|
||||
detailed, and more.
|
||||
|
||||
The Perlin Explorer mod’s main use case is to allow you to
|
||||
@ -64,11 +64,11 @@ 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.
|
||||
and noise parameters themselves! Please refer to the Minetest
|
||||
Lua API documentation to learn more.
|
||||
|
||||
### Active noise
|
||||
This tool heavily relies on something called the “active noise”
|
||||
This mod heavily relies on something called the “active noise”
|
||||
(or “active noise parameters”). These are the noise parameters
|
||||
and options that the mod will use for various operations, like
|
||||
getting values, generating nodes, using mapgen mode, etc. The “Apply” button
|
||||
@ -77,7 +77,7 @@ There can only be one active noise parameters. Also, the active
|
||||
noise is always valid; if you enter invalid noise parameters,
|
||||
the mod refuses them for the active noise.
|
||||
|
||||
Initially, there are no active noise parameters, you you have
|
||||
Initially, there are no active noise parameters, so you have
|
||||
to push the “Apply” button mentioned before first.
|
||||
|
||||
### The tools
|
||||
@ -86,7 +86,7 @@ These tools are items, so check out your Creative Inventory
|
||||
(or something similar) to get them.
|
||||
|
||||
#### Perlin Noise Creator
|
||||
This is the heart of this mod. Hold this item in hand and punch
|
||||
This is the main tool of this mod. Hold this item in hand and punch
|
||||
to open a window.
|
||||
|
||||
The window has multiple sections:
|
||||
@ -101,7 +101,7 @@ The window has multiple sections:
|
||||
This section has 2 parts: The top part is a list of profiles.
|
||||
An explanation for that is below.
|
||||
|
||||
The bottom part contains the actual noise parameters.
|
||||
The bottom part contains the actual noise parameters:
|
||||
|
||||
* Offset
|
||||
* Scale
|
||||
@ -110,14 +110,13 @@ The bottom part contains the actual noise parameters.
|
||||
* Octaves
|
||||
* Persistence
|
||||
* Lacunarity
|
||||
* eased
|
||||
* absvalue
|
||||
* Flags (defaults, eased, absvalue)
|
||||
|
||||
Please refer to Minetest Lua API documentation for a definition.
|
||||
Node this mod will enforce sanity check on some for the values,
|
||||
This mod enforces a few sanity checks on some for the values,
|
||||
i.e. octaves can’t be lower than 1.
|
||||
|
||||
HINT: If you hit “Enter” while the focus is on any of the noise
|
||||
**Hint**: If you hit “Enter” while the focus is on any of the noise
|
||||
parameters, this is the same as if you clicked “Accept” or “Accept
|
||||
and create” (see below). Use this to your advantage to quickly
|
||||
tweak a particular value.
|
||||
@ -127,17 +126,19 @@ convenience.
|
||||
|
||||
The “Analyze” button shows you some basic info about the
|
||||
noise parameters as displayed in the form. First, the
|
||||
minimum and maximum possible value
|
||||
throughout the entire noise. Then, the “wavelengths” for each
|
||||
axis. This means across how many nodes (roughly) the noise is
|
||||
stretched out, specified for each octave, beginning with the first.
|
||||
theoretical minimum and maximum possible value
|
||||
of the entire noise.
|
||||
Then, the “wavelengths” for each axis. This means across
|
||||
how many nodes (roughly) the noise is stretched out, specified
|
||||
for each octave, beginning with the first.
|
||||
If any wavelength reaches a number lower than 1, it will be
|
||||
shown in red because the official Lua documentation discourages
|
||||
this. If this happens, either increase the spread, the octaves
|
||||
or the lacunarity.
|
||||
shown in red because this means your noise parameters are invalid.
|
||||
If this happens, either increase the spread or decrease the octaves
|
||||
or lacunarity.
|
||||
|
||||
**Note**: The Analyze feature uses the noise parameters currently
|
||||
in the form, *not* the *active* noise parameters.
|
||||
**Note**: The Analyze feature uses the noise parameters as they
|
||||
are displayed in the form, *not* the *active* noise parameters.
|
||||
This is because the active noise must always be valid.
|
||||
|
||||
###### Profiles
|
||||
A profile is just noise parameters that you can load for later use.
|
||||
@ -156,7 +157,7 @@ This list contains three types of profiles:
|
||||
“Profile 1”
|
||||
|
||||
User profiles will also automatically saved on disk so they
|
||||
get restored when restarting.
|
||||
get restored when restarting the world.
|
||||
|
||||
The buttons do the following:
|
||||
|
||||
@ -167,8 +168,8 @@ The buttons do the following:
|
||||
for non-user profiles)
|
||||
|
||||
##### Noise options
|
||||
This section roughly says how the noise parameters are “interpreted”. You
|
||||
can do 3 things here:
|
||||
This section roughly says how the noise parameters are “interpreted”.
|
||||
These fields are available:
|
||||
|
||||
* Number of dimensions (2D or 3D)
|
||||
* 2D: Noise is 2-dimensional. In the world, only the X and Z
|
||||
@ -180,8 +181,8 @@ can do 3 things here:
|
||||
This gives a “pixelized”/“voxelized” look. You normally don’t need
|
||||
this but it’s useful to emulate the `sidelen` parameter of
|
||||
mapgen decorations (relevant for game development)
|
||||
* Statistics: Will calculate millions of values (without generating a
|
||||
map in a predefined area/volume to make some statistics. This
|
||||
* Statistics: Will calculate tons of values (without generating
|
||||
nodes) in a predefined area/volume to make some statistics. This
|
||||
will take a while to do so.
|
||||
The main feature is a histogram which shows which values were the most
|
||||
common. The first row shows the percentage, the 2nd and 3rd row show
|
||||
@ -192,10 +193,10 @@ can do 3 things here:
|
||||
The statistics always distributes the values into “buckets” of
|
||||
equal sizes, beginning with the lowest theoretical value and
|
||||
ending with the highest one.
|
||||
The statistics are useful if you want to make sure certain values
|
||||
occur with a certain probability.
|
||||
The histogram is useful if you want to see how common or rare
|
||||
each value is.
|
||||
**Note**: This button will calculate statistics of the noise settings
|
||||
as displayed in the form, it does *not* use the active noise.
|
||||
as they were displayed in the form. It does *not* use the active noise.
|
||||
|
||||
##### Node generation
|
||||
|
||||
@ -203,7 +204,7 @@ Playing around with parameters isn’t very useful if you don’t
|
||||
get a visual result. That’s where the node generation comes
|
||||
into play. Here you specify parameters for generating nodes
|
||||
from the noise.
|
||||
All noise values are either high or low and are divided
|
||||
All noise values are either high or low; they are divided
|
||||
by the **midpoint**: Values equal to or higher than the
|
||||
midpoint are high, otherwise low.
|
||||
|
||||
@ -292,12 +293,13 @@ to place nodes in a certain area:
|
||||
|
||||
#### Footer (Apply / Apply and close / Enable mapgen / Disable mapgen)
|
||||
|
||||
The footer is the final part of the formspec. He
|
||||
The footer is the final part of the form. It has these buttons:
|
||||
|
||||
* Apply: Set the current noise params as the “active noise”. If the
|
||||
mapgen is active, it will automatically update
|
||||
mapgen is active, it will automatically update the world around
|
||||
players
|
||||
* Apply and create: Generate some nodes at the specified XYZ coordinates
|
||||
with the specified size (see above)
|
||||
with the specified size (see Position settings above)
|
||||
* Enable mapgen: Enable the mapgen mode. In mapgen mode, nodes will
|
||||
automatically be generated according to the settings around players.
|
||||
This allows you to actually *explore* a world.
|
||||
@ -320,10 +322,10 @@ Use the “Punch” key anywhere to get the value of *your* position (rounded).
|
||||
If you hold down “Sneak” while punching, your *exact* position (not rounded)
|
||||
will be used instead.
|
||||
|
||||
**Note**: This tool always calculates the values of the *currently active noise
|
||||
params* (by triggering the “Accept” or “Accept and create” button in the Perlin Noise
|
||||
Creator). It completely ignores what kind of terrain you touch, so this
|
||||
tool also works if you haven’t generated any nodes.
|
||||
**Note**: This tool always calculates the values of the *active noise*
|
||||
It completely ignores whatever nodes were generated and what those nodes
|
||||
represents, so tool also works if you haven’t generated any nodes.
|
||||
It actually only looks at the coordinates of the node or yourself.
|
||||
If you’re unsure about what the current active noise is, just hit “Accept” again
|
||||
in the Perlin Noise Creator.
|
||||
|
||||
@ -337,9 +339,11 @@ will then instantly update the map.
|
||||
|
||||
If mapgen mode is disabled, the meaning of this tool is this:
|
||||
|
||||
* Punch: Set a new seed, but do not regenerate map
|
||||
* Place: Set a new seed and regenerate nodes (using the XYZ and Size parameters
|
||||
in the Perlin Noise Creator)
|
||||
* Punch: Set a new seed of the active noise, but do not regenerate map
|
||||
* Place: Set a new seed of the active noise, then regenerate nodes
|
||||
(using the XYZ and Size parameters in the Perlin Noise Creator)
|
||||
|
||||
This can be useful to look at many different variations of the noise.
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user