Document files, folders, advanced, extras configs, add todos for rema…

…ining 2
GlowstoneMC · Apr 16, 2018 · b67db9b · b67db9b
1 parent 7e52509
commit b67db9b
Showing 1 changed file with 159 additions and 0 deletions.
diff --git a/Configuration_Guide/glowstone_yml/index.rst b/Configuration_Guide/glowstone_yml/index.rst
@@ -96,6 +96,117 @@ Settings for in-game features.
 | resource-pack-hash             | text *(optional)* | *(Blank)*                      | The hash of the resource pack for data integrity purposes.  |
 +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
 
+creatures
+=========
+
+:todo: document this
+
+
+folders
+=======
+
+Settings for server folder names.
+
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| Key                            | Type              | Default                        | Description                                                 |
++================================+===================+================================+=============================================================+
+| plugins                        | text              | plugins                        | The plugins directory relative to server root.              |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| update                         | text              | update                         | The directory relative to 'plugins' to copy updates from    |
+|                                |                   |                                | on startup.                                                 |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| worlds                         | text              | worlds                         | The world container relative to server root.                |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| libraries                      | text              | lib                            | The libraries directory relative to server root.            |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+
+files
+=====
+
+Settings for server file names. **These files are relative to the config directory.**
+
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| Key                            | Type              | Default                        | Description                                                 |
++================================+===================+================================+=============================================================+
+| permissions                    | text              | permissions.yml                | The file to read custom permissions from.                   |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| commands                       | text              | commands.yml                   | The file to read command aliases from.                      |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| help                           | text              | help.yml                       | The file to read help topics from.                          |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+
+advanced
+========
+
+Advanced server configuration options.
+
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| Key                                           | Type               | Default                        | Description                                                 |
++===============================================+====================+================================+=============================================================+
+| connection-throttle                           | integer            | 4000                           | Time in milliseconds a client must wait before reconnecting.|
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| idle-timeout                                  | integer            | 0                              | How long until an idle (AFK) player is kicked (0 for never).|
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| warn-on-overload                              | true/false         | true                           | Whether to show warnings if the server is overloaded.       |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| exact-login-location                          | true/false         | false                          | Whether to skip fixing block collisions on player login.    |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| plugin-profiling                              | true/false         | false                          | Whether the :code:`timings` command is enabled.             |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| deprecated-verbose                            | true/false/default | false                          | Whether to always, never, or only sometimes show deprecation|
+|                                               |                    |                                | warnings for plugins.                                       |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| compression-threshold                         | integer            | 256                            | The minimum packet size to compress. -1 to disable, 0 to    |
+|                                               |                    |                                | compress everything.                                        |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| proxy-support                                 | true/false         | false                          | Whether proxy (e.g. BungeeCord) support is enabled, granting|
+|                                               |                    |                                | access to the real IP and UUID of proxied players. Requires |
+|                                               |                    |                                | the proxy to be configured correctly.                       |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| player-sample-count                           | integer            | 12                             | How many online players can be shown in the server list.    |
++------------------+----------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+|                  | enable                     | true/false         | false                          | Whether GPU-based computations are enabled.                 |
+| graphics-compute +----------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+|                  | use-any-device             | true/false         | false                          | Whether any device can be used for OpenCL computations.     |
++------------------+----------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+|                  | cache-size                 | integer            | 256                            | The region file cache size, in MB.                          |
+| region-file      +----------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+|                  | compression                | true/false         | true                           | Whether region files should be compressed.                  |
++------------------+----------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| profile-lookup-timeout                        | integer            | 5                              | Timeout for Mojang profile lookups, in seconds.             |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| suggest-player-name-when-null-tab-completions | true/false         | true                           | Checks if player names should be suggested when a           |
+|                                               |                    |                                | command returns null as their tab completion result.        |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+
+extras
+======
+
+Extra services which Glowstone can optionally provide.
+
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| Key                            | Type              | Default                        | Description                                                 |
++================================+===================+================================+=============================================================+
+| query-enabled                  | true/false        | false                          | Whether the query_ server is enabled.                       |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| query-port                     | integer           | 25614                          | The port the query server runs on.                          |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| query-plugins                  | true/false        | true                           | Whether the query response includes plugin info.            |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| rcon-enabled                   | true/false        | false                          | Whether the rcon_ server is enabled.                        |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| rcon-password                  | text              | glowstone                      | The rcon password.                                          |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| rcon-port                      | integer           | 25575                          | The port the rcon server runs on.                           |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+| rcon-colors                    | true/false        | true                           | Whether the server should send color-codes to the           |
+|                                |                   |                                | rcon client.                                                |
++--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
+
+.. _query: http://wiki.vg/Query
+.. _rcon: http://wiki.vg/Rcon
+
+
 world
 =====
 
@@ -140,3 +251,51 @@ For advanced world configuration, a plugin such as Multiverse may be appropriate
 | disable-generation             | true/false        | false                          | Disables world generation.                                  |
 +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+
 
+database
+========
+
+:todo: document this
+
+libraries
+=========
+
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| Key                                           | Type               | Default                        | Description                                                 |
++===============================================+====================+================================+=============================================================+
+| checksum-validation                           | true/false         | true                           | Whether downloaded libraries should be validated using their|
+|                                               |                    |                                | checksum.                                                   |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| repository-url                                | text               | *Glowstone repo, see below*    | The repository URL to download libraries from.              |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| download-attempts                             | integer            | 2                              | The maximum amount of attempts to download each library.    |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| compatibility-bundle                          | text *(enum)*      | CRAFTBUKKIT                    | The compatibility bundle to use. Only CRAFTBUKKIT and NONE  |
+|                                               |                    |                                | are supported. See the `Library Management`_ section.       |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+| list                                          | list               | *Empty array*                  | A list of extra libraries to download on server startup.    |
+|                                               | *(of libraries)*   |                                | See below for the content structure of this list.           |
++-----------------------------------------------+--------------------+--------------------------------+-------------------------------------------------------------+
+
+**Note**: the default Glowstone library repository is :code:`https://repo.glowstone.net/service/local/repositories/central/content/`.
+
+Library format
+--------------
+
+Each element of the library list (:code:`libraries.list` key) is an object with the following structure:
+
++-----------------------------------------------+--------------------+-------------------------------------------------------------+
+| Key                                           | Type               | Description                                                 |
++===============================================+====================+=============================================================+
+| group-id                                      | text               | The group ID of the library.                                |
++-----------------------------------------------+--------------------+-------------------------------------------------------------+
+| idle-timeout                                  | text               | The artifact ID of the library.                             |
++-----------------------------------------------+--------------------+-------------------------------------------------------------+
+| version                                       | text               | The version of the library.                                 |
++------------------+----------------------------+--------------------+-------------------------------------------------------------+
+| checksum         | type                       | text *(enum)*      | The algorithm for the checksum. Only SHA-1 (:code:`sha1`)   |
+| *(optional)*     |                            |                    | and MD5 (:code:`md5`) are supported.                        |
+|                  +----------------------------+--------------------+-------------------------------------------------------------+
+|                  | value                      | text               | The checksum of the library.                                |
++------------------+----------------------------+--------------------+-------------------------------------------------------------+
+
+Again, more information about these fields and library management can be found in the `Library Management`_ section.