Add world config docs, short descriptions for sections.

GlowstoneMC · Apr 16, 2018 · b9a4696 · b9a4696
1 parent 45054c1
commit b9a4696
Showing 1 changed file with 51 additions and 0 deletions.
diff --git a/Configuration_Guide/glowstone_yml/index.rst b/Configuration_Guide/glowstone_yml/index.rst
@@ -9,6 +9,8 @@ to move around.
 server
 ======
 
+Basic server settings.
+
 +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
 | Key                            | Type              | Default                        | Description                                                 |
 +================================+===================+================================+=============================================================+
@@ -45,6 +47,8 @@ server
 console
 =======
 
+Settings for the console (terminal) output.
+
 +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
 | Key                            | Type              | Default                        | Description                                                 |
 +================================+===================+================================+=============================================================+
@@ -61,6 +65,8 @@ console
 game
 ====
 
+Settings for in-game features.
+
 +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
 | Key                            | Type              | Default                        | Description                                                 |
 +================================+===================+================================+=============================================================+
@@ -89,3 +95,48 @@ game
 +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
 | resource-pack-hash             | text *(optional)* | *(Blank)*                      | The hash of the resource pack for data integrity purposes.  |
 +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+
+world
+=====
+
+Used to choose how the default worlds are configured.
+For advanced world configuration, a plugin such as Multiverse may be appropriate.
+
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| Key                            | Type              | Default                        | Description                                                 |
++================================+===================+================================+=============================================================+
+| name                           | text              | world                          | The name of the main world.                                 |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| seed                           | text *(optional)* | *(Blank)*                      | The seed to use for the main world, or blank for random.    |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| level-type                     | text *(enum)*     | DEFAULT                        | The world type to use for the main world, one of            |
+|                                |                   |                                | DEFAULT, FLAT, DEFAULT_1_1, LARGEBIOMES, or AMPLIFIED.      |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| spawn-radius                   | integer           | 16                             | The radius around a world's spawn point to protect          |
+|                                |                   |                                | from damage, or 0 to disable.                               |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| view-distance                  | integer           | 8                              | The radius of the area of chunks to send to players.        |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| gen-structures                 | true/false        | true                           | Whether structures (villages, strongholds, etc.) are        |
+|                                |                   |                                | generated.                                                  |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| allow-nether                   | true/false        | true                           | Whether a Nether world is created by default.               |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| allow-end                      | true/false        | true                           | Whether an End world is created by default.                 |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| keep-spawn-loaded              | true/false        | true                           | Whether chunks around world spawns are kept                 |
+|                                |                   |                                | loaded by default.                                          |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| populate-anchored-chunks       | true/false        | false                          | Whether anchored chunks, like world spawns, are             |
+|                                |                   |                                | populated as soon as they are loaded. False means           |
+|                                |                   |                                | that these chunks will wait to be populated until a         |
+|                                |                   |                                | player loads those chunks for the first time, resulting     |
+|                                |                   |                                | in a long "Downloading terrain" wait time, and server       |
+|                                |                   |                                | stutter on first world join.                                |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| classic-style-water            | true/false        | false                          | Changes the water flow behavior to be finite with a         |
+|                                |                   |                                | moving source.                                              |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| disable-generation             | true/false        | false                          | Disables world generation.                                  |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+