Skip to content

Commit 32b51e7

Browse files
committed
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.
1 parent a2384ef commit 32b51e7

File tree

1 file changed

+11
-11
lines changed
  • docs/paper/admin/reference/configuration

1 file changed

+11
-11
lines changed

docs/paper/admin/reference/configuration/README.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ you have not manually overridden it.
3535
### Per-world values
3636

3737
To set a value for a specific world, edit `paper-world.yml` within the world folder. For example, if
38-
you wanted to disable `spawn.keep-spawn-loaded` for a world named `resource`, you would edit
38+
you wanted to enable `lootables.auto-replenish` for a world named `resource`, you would edit
3939
`paper-world.yml` within the `resource` folder like so:
4040

4141
```yaml title=resource/paper-world.yml
4242
_version: 28
4343

4444
# highlight-start
45-
spawn:
46-
keep-spawn-loaded: false
45+
lootables:
46+
auto-replenish: true
4747
# highlight-end
4848
```
4949

@@ -59,10 +59,12 @@ individual `paper-world.yml`. You **do not need to and should not** copy the ent
5959
`paper-world-default.yml` file into each `paper-world.yml` file you want to modify. Only copy the
6060
exact value you want to change.
6161

62-
For a more complex real-world example: setting both different `spawn-limits` and `keep-spawn-loaded`
62+
For a more complex real-world example: setting both different `spawn-limits` and `auto-replenish`
6363
in two worlds.
6464

6565
```yaml title="paper-world-defaults.yml"
66+
lootables:
67+
auto-replenish: true
6668
entities:
6769
spawning:
6870
spawn-limits:
@@ -73,8 +75,6 @@ entities:
7375
underground_water_creature: 5
7476
water_ambient: 5
7577
water_creature: 20
76-
spawn:
77-
keep-spawn-loaded: true
7878
```
7979
8080
```yaml title="world_nether/paper-world.yml"
@@ -85,31 +85,31 @@ entities:
8585
```
8686
8787
```yaml title="resource_world/paper-world.yml"
88+
lootables:
89+
auto-replenish: false
8890
entities:
8991
spawning:
9092
spawn-limits:
9193
axolotls: 8
9294
creature: 15
9395
monster: 2
94-
spawn:
95-
keep-spawn-loaded: false
9696
```
9797
9898
This example demonstrates the concept of inheritance. For each world, this is the effective
9999
configuration which will be applied:
100100
101101
| Configuration Key | world | world_nether | world_the_end | resource_world |
102102
|-------------------------------------------------------------|--------|--------------|---------------|----------------|
103+
| `lootables.auto-replenish` | `true` | `true` | `true` | `false` |
103104
| `entities.spawning.spawn-limits.ambient` | `15` | `15` | `15` | `15` |
104105
| `entities.spawning.spawn-limits.axolotls` | `5` | `5` | `5` | `8` |
105106
| `entities.spawning.spawn-limits.creature` | `10` | `10` | `10` | `15` |
106107
| `entities.spawning.spawn-limits.monster` | `70` | `90` | `70` | `2` |
107108
| `entities.spawning.spawn-limits.underground_water_creature` | `5` | `5` | `5` | `5` |
108109
| `entities.spawning.spawn-limits.water_ambient` | `20` | `20` | `20` | `20` |
109110
| `entities.spawning.spawn-limits.water_creature` | `5` | `5` | `5` | `5` |
110-
| `spawn.keep-spawn-loaded` | `true` | `true` | `true` | `false` |
111111

112112
Notice that `world_the_end/paper-world.yml` was never modified. Because of this, it inherits all the
113-
configuration options from `config/paper-world-defaults.yml`. Additionally, `keep-spawn-loaded` was
113+
configuration options from `config/paper-world-defaults.yml`. Additionally, `auto-replenish` was
114114
only disabled in `resource_world/paper-world.yml` because in `config/paper-world-defaults.yml`,
115-
`keep-spawn-loaded` is set to `true`.
115+
`auto-replenish` is set to `true`.

0 commit comments

Comments
 (0)