fix: update config references (#488)

Zoriot · web-flow · commit 139c670bec75 · 2024-10-13T14:01:42.000+02:00
* style: reorder configuration settings for consistency Reorders the configuration settings in the documentation to match the order in new installations, making it easier to locate the settings. * feat: add world-container Bukkit setting Added the `world-container` setting to the documentation, specifying the folder where world files are saved. This setting allows for easier management of world directories. * feat: replace spawn.keep-spawn-loaded with lootables.auto-replenish Removed `spawn.keep-spawn-loaded` from the documentation, as it is now a game rule, and replaced it with `lootables.auto-replenish`. Closes #457.
diff --git a/config-specs/paper/bukkit.yml b/config-specs/paper/bukkit.yml
@@ -1,21 +1,31 @@
-aliases:
-  default: now-in-commands.yml
-  description: Static value from converting old versions to the new commands.yml format.
-chunk-gc:
-  period-in-ticks:
-    default: "600"
-    description: >-
-      How long chunks loaded by plugins should last for. Capped by Paper to be
-      20 ticks (1 second).
 settings:
   allow-end:
     default: "true"
     description: Whether to load end-type dimensions.
+  warn-on-overload:
+    default: "true"
+    description: Allows disabling the "Can't keep up!" message.
+  permissions-file:
+    default: permissions.yml
+    description: >-
+      File to load server permissions from. Use of this feature has mostly been
+      replaced by permission plugins.
+  update-folder:
+    default: update
+    description: >-
+      Path to replace new plugin versions with.
+      See [Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
+  plugin-profiling:
+    default: "false"
+    description: "This option does not operate, as it is disabled by a Paper patch."
   connection-throttle:
     default: "4000"
     description: >-
       How long of a delay to enforce between connections from an IP address.
       Measured in milliseconds since last attempt.
+  query-plugins:
+    default: "true"
+    description: Whether to send plugins in the GS4 Query protocol response.
   deprecated-verbose:
     default: default
     description: >
@@ -25,118 +35,114 @@ settings:
       is true.
 
       Valid values are "true", "false", or "default".
+  shutdown-message:
+    default: Server closed
+    description: |
+      The kick message for the player when the server shuts down.
+      The message is formatted with legacy "§" style formatting.
   minimum-api:
     default: none
     description: >
       Minimum plugin [api-version](/paper/dev/plugin-yml#api-version). A string
       containing the server version, ignoring minor part, from 1.13 to 1.20. If
       below this, or not specified, the plugin is prevented from loading.
-  permissions-file:
-    default: permissions.yml
-    description: >-
-      File to load server permissions from. Use of this feature has mostly been
-      replaced by permission plugins.
-  plugin-profiling:
-    default: "false"
-    description: "This option does not operate, as it is disabled by a Paper patch."
-  query-plugins:
-    default: "true"
-    description: Whether to send plugins in the GS4 Query protocol response.
-  shutdown-message:
-    default: Server closed
-    description: |
-      The kick message for the player when the server shuts down.
-      The message is formatted with legacy "§" style formatting.
-  update-folder:
-    default: update
-    description: >-
-      Path to replace new plugin versions with.
-      See [Updating Plugins](/paper/updating#step-2-update-plugins) for more information.
   use-map-color-cache:
     default: "true"
     description: >-
       Whether to build and save mappings from RGB colors to the closest map
       palette color.
-  warn-on-overload:
-    default: "true"
-    description: Allows disabling the "Can't keep up!" message.
+  world-container:
+    default: "N/A"
+    description: >-
+      Specifies the path to the folder where world files are saved. By default, this is the folder where the server JAR file is located.
+      Note: Worlds must be manually moved to this folder for the server to recognize them.
+
 spawn-limits:
-  ambient:
-    default: "15"
+  monsters:
+    default: "70"
     description: >-
-      Set the spawn-limits for ambient mobs. This can be overridden by the
-      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
+      Set the spawn-limits for monsters. This can be overridden by the
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
   animals:
     default: "10"
     description: >-
       Set the spawn-limits for animals. This can be overridden by the
       [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_creature).
-  axolotls:
+  water-animals:
     default: "5"
     description: >-
-      Set the spawn-limits for axolotls. This can be overridden by the
-      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
-  monsters:
-    default: "70"
-    description: >-
-      Set the spawn-limits for monsters. This can be overridden by the
-      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_monster).
+      Set the spawn-limits for water animals. This can be overridden by the
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
   water-ambient:
     default: "20"
     description: >-
       Set the spawn-limits for water ambient mobs. This can be overridden by the
       [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_ambient).
-  water-animals:
-    default: "5"
-    description: >-
-      Set the spawn-limits for water animals. This can be overridden by the
-      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_water_creature).
   water-underground-creature:
     default: "5"
     description: >-
       Set the spawn-limits for water underground creatures. This can be
       overridden by the [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_underground_water_creature).
-ticks-per:
-  ambient-spawns:
-    default: "1"
+  axolotls:
+    default: "5"
     description: >-
-      Number of ticks between each ambient mob spawn attempt. Set to -1 to use
-      default.
+      Set the spawn-limits for axolotls. This can be overridden by the
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_axolotls).
+  ambient:
+    default: "15"
+    description: >-
+      Set the spawn-limits for ambient mobs. This can be overridden by the
+      [Paper world config](/paper/reference/world-configuration#entities_spawning_spawn_limits_ambient).
+chunk-gc:
+  period-in-ticks:
+    default: "600"
+    description: >-
+      How long chunks loaded by plugins should last for. Capped by Paper to be
+      20 ticks (1 second).
+ticks-per:
   animal-spawns:
     default: "400"
     description: >-
       Number of ticks between each animal spawn attempt. Set to -1 to use
       default.
-  autosave:
-    default: "6000"
-    description: >-
-      Number of ticks between each full auto-save. Set to -1 to disable
-      auto-save.
-  axolotl-spawns:
+  monster-spawns:
     default: "1"
     description: >-
-      Number of ticks between each axolotl spawn attempt. Set to -1 to use
+      Number of ticks between each monster spawn attempt. Set to -1 to use
       default.
-  monster-spawns:
+  water-spawns:
     default: "1"
     description: >-
-      Number of ticks between each monster spawn attempt. Set to -1 to use
+      Number of ticks between each water-animal spawn attempt. Set to -1 to use
       default.
   water-ambient-spawns:
     default: "1"
     description: >-
       Number of ticks between each water-ambient mob spawn attempt. Set to -1 to
       use default.
-  water-spawns:
-    default: "1"
-    description: >-
-      Number of ticks between each water-animal spawn attempt. Set to -1 to use
-      default.
   water-underground-creature-spawns:
     default: "1"
     description: >-
       Number of ticks between each water-underground-creature spawn attempt. Set
       to -1 to use default.
+  axolotl-spawns:
+    default: "1"
+    description: >-
+      Number of ticks between each axolotl spawn attempt. Set to -1 to use
+      default.
+  ambient-spawns:
+    default: "1"
+    description: >-
+      Number of ticks between each ambient mob spawn attempt. Set to -1 to use
+      default.
+  autosave:
+    default: "6000"
+    description: >-
+      Number of ticks between each full auto-save. Set to -1 to disable
+      auto-save.
+aliases:
+  default: now-in-commands.yml
+  description: Static value from converting old versions to the new commands.yml format.
 worlds:
   <world>:
     biome-provider:
diff --git a/docs/paper/admin/reference/configuration/README.mdx b/docs/paper/admin/reference/configuration/README.mdx
@@ -35,15 +35,15 @@ you have not manually overridden it.
 ### Per-world values
 
 To set a value for a specific world, edit `paper-world.yml` within the world folder. For example, if
-you wanted to disable `spawn.keep-spawn-loaded` for a world named `resource`, you would edit
+you wanted to enable `lootables.auto-replenish` for a world named `resource`, you would edit
 `paper-world.yml` within the `resource` folder like so:
 
 ```yaml title=resource/paper-world.yml
 _version: 28
 
 # highlight-start
-spawn:
-  keep-spawn-loaded: false
+lootables:
+  auto-replenish: true
 # highlight-end
 ```
 
@@ -59,10 +59,12 @@ individual `paper-world.yml`. You **do not need to and should not** copy the ent
 `paper-world-default.yml` file into each `paper-world.yml` file you want to modify. Only copy the
 exact value you want to change.
 
-For a more complex real-world example: setting both different `spawn-limits` and `keep-spawn-loaded`
+For a more complex real-world example: setting both different `spawn-limits` and `auto-replenish`
 in two worlds.
 
 ```yaml title="paper-world-defaults.yml"
+lootables:
+  auto-replenish: true
 entities:
   spawning:
     spawn-limits:
@@ -73,8 +75,6 @@ entities:
       underground_water_creature: 5
       water_ambient: 5
       water_creature: 20
-spawn:
-  keep-spawn-loaded: true
 ```
 
 ```yaml title="world_nether/paper-world.yml"
@@ -85,31 +85,31 @@ entities:
 ```
 
 ```yaml title="resource_world/paper-world.yml"
+lootables:
+  auto-replenish: false
 entities:
   spawning:
     spawn-limits:
       axolotls: 8
       creature: 15
       monster: 2
-spawn:
-  keep-spawn-loaded: false
 ```
 
 This example demonstrates the concept of inheritance. For each world, this is the effective
 configuration which will be applied:
 
 | Configuration Key                                           | world  | world_nether | world_the_end | resource_world |
 |-------------------------------------------------------------|--------|--------------|---------------|----------------|
+| `lootables.auto-replenish`                                  | `true` | `true`       | `true`        | `false`        |
 | `entities.spawning.spawn-limits.ambient`                    | `15`   | `15`         | `15`          | `15`           |
 | `entities.spawning.spawn-limits.axolotls`                   | `5`    | `5`          | `5`           | `8`            |
 | `entities.spawning.spawn-limits.creature`                   | `10`   | `10`         | `10`          | `15`           |
 | `entities.spawning.spawn-limits.monster`                    | `70`   | `90`         | `70`          | `2`            |
 | `entities.spawning.spawn-limits.underground_water_creature` | `5`    | `5`          | `5`           | `5`            |
 | `entities.spawning.spawn-limits.water_ambient`              | `20`   | `20`         | `20`          | `20`           |
 | `entities.spawning.spawn-limits.water_creature`             | `5`    | `5`          | `5`           | `5`            |
-| `spawn.keep-spawn-loaded`                                   | `true` | `true`       | `true`        | `false`        |
 
 Notice that `world_the_end/paper-world.yml` was never modified. Because of this, it inherits all the
-configuration options from `config/paper-world-defaults.yml`. Additionally, `keep-spawn-loaded` was
+configuration options from `config/paper-world-defaults.yml`. Additionally, `auto-replenish` was
 only disabled in `resource_world/paper-world.yml` because in `config/paper-world-defaults.yml`,
-`keep-spawn-loaded` is set to `true`.
+`auto-replenish` is set to `true`.
