From 2344ba204792dd2b821fa9a625e65bd964cebebe Mon Sep 17 00:00:00 2001 From: William Blake Galbreath Date: Fri, 28 Feb 2020 19:08:07 -0600 Subject: [PATCH] Add docs for biomes.yml --- docs/source/biomes.rst | 38 +++++++++++++++++++++++++++++++++++ docs/source/configuration.rst | 2 ++ docs/source/index.rst | 1 + 3 files changed, 41 insertions(+) create mode 100644 docs/source/biomes.rst diff --git a/docs/source/biomes.rst b/docs/source/biomes.rst new file mode 100644 index 000000000..8025ec55d --- /dev/null +++ b/docs/source/biomes.rst @@ -0,0 +1,38 @@ +============= +Biomes.yml +============= + +This page details the biome specific options found in biomes.yml + +.. |br| raw:: html + +.. contents:: + :depth: 1 + :local: + +Biomes +=============== + +spawn-data +~~~~~~~~~~ +* **description**: Spawn data is a map of key->value pairs for each entity and it's natural spawn settings per biome. The + value consists of 3 integers representing the weight, minimum group, and maximum group. + + Weight represents the chance the entity has to spawn. It's not really a percent chance, it's the number of chances this + entity gets in the rng roll. Take the `ocean` biome, for example. If you add up all the weights for all the entities + you get a total of 540. Enderman has a weight of 10 here, so it gets 10/540 chance of winning the rng roll. + + There are still other rules to be met before a mob is spawned. Each entity has their own set of rules, which can be + learned by researching the official minecraft wiki or google. But, for example, lets say a water location was chosen + to spawn a mob at random and enderman won the rng roll. The enderman will _not_ spawn because it's in water. This tick + the spawn chance gets skipped and nothing spawns. The rng roll happens every tick until the mob cap has been reached, so + keep all this in mind when creating your weights. + + The minimum and maximum group values are exactly as they sound. It is the number of mobs of this type that will spawn + from this attempt. + +.. note:: + The default biomes.yml file matches perfectly with the vanilla gameplay. If you find something not right, please let me + know on discord. + +More biome specific customizations are planned for the future. diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index 248414295..7354eea18 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -10,6 +10,8 @@ This page details the various configuration settings exposed by Purpur in the pu :depth: 1 :local: +If you are looking for details on biome specific settings found in biomes.yml click here :doc:`biomes`. + If you want information on settings in paper.yml, spigot.yml, and bukkit.yml you should see their respective documentation pages. diff --git a/docs/source/index.rst b/docs/source/index.rst index 1d5d65b13..959cc5209 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,4 +24,5 @@ changes to suit our server that are deemed too wild to be included directly upst configuration permissions + biomes contact