Skip to content

Commit 1fc84f4

Browse files
committed
Document default config value changes
1 parent acdec13 commit 1fc84f4

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/en/user-setup/config.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,20 @@ use-latest-nms-version: false
5555
# Keep in mind that implementations may vary and actually updating the CommandAPI might be necessary.
5656
be-lenient-for-minor-versions: false
5757

58-
# Hook into Paper's ServerResourcesReloadedEvent (default: true)
58+
# Hook into Paper's ServerResourcesReloadedEvent (default: false)
5959
# If "true", and the CommandAPI detects it is running on a Paper server, it will
6060
# hook into Paper's ServerResourcesReloadedEvent to detect when /minecraft:reload is run.
6161
# This allows the CommandAPI to automatically call its custom datapack-reloading
6262
# function which allows CommandAPI commands to be used in datapacks.
6363
# If you set this to false, CommandAPI commands may not work inside datapacks after
6464
# reloading datapacks.
65-
hook-paper-reload: true
65+
hook-paper-reload: false
6666

67-
# Skips the initial datapack reload when the server loads (default: false)
67+
# Skips the initial datapack reload when the server loads (default: true)
6868
# If "true", the CommandAPI will not reload datapacks when the server has finished
6969
# loading. Datapacks will still be reloaded if performed manually when "hook-paper-reload"
7070
# is set to "true" and /minecraft:reload is run.
71-
skip-initial-datapack-reload: false
71+
skip-initial-datapack-reload: true
7272

7373
# Plugins to convert (default: [])
7474
# Controls the list of plugins to process for command conversion.
@@ -209,40 +209,40 @@ be-lenient-for-minor-versions: true
209209

210210
Controls whether the CommandAPI hooks into the Paper-exclusive `ServerResourcesReloadedEvent` when available.
211211

212-
When the CommandAPI detects it is running on a Paper-based server, its default behavior will be to hook into the `ServerResourcesReloadedEvent`, which triggers when `/minecraft:reload` is run. During this event, the CommandAPI runs a custom datapack reloading sequence that helps commands registered with the CommandAPI work within datapacks. See [Reloading datapacks](../internal/internal#reloading-datapacks) for more information on this process.
212+
When the CommandAPI detects it is running on a Paper-based server, this config option controls if the CommandAPI hooks into the `ServerResourcesReloadedEvent`, which triggers when `/minecraft:reload` is run. During this event, the CommandAPI runs a custom datapack reloading sequence that helps commands registered with the CommandAPI work within datapacks. See [Reloading datapacks](../internal/internal#reloading-datapacks) for more information on this process.
213213

214-
By default, this value is set to `true` and the CommandAPI will hook into the `ServerResourcesReloadedEvent`. If you want, you can set this to `false`, and the CommandAPI will not hook into this event.
214+
By default, this value is set to `false` and the CommandAPI will not hook into the `ServerResourcesReloadedEvent`. If you want, you can set this to `true`, and the CommandAPI will hook into this event.
215215

216216
**Default value**
217217

218218
```yaml
219-
hook-paper-reload: true
219+
hook-paper-reload: false
220220
```
221221

222222
**Example value**
223223

224224
```yaml
225-
hook-paper-reload: false
225+
hook-paper-reload: true
226226
```
227227

228228
### `skip-initial-datapack-reload`
229229

230230
Controls whether the CommandAPI should perform its initial datapack reload when the server has finished loading.
231231

232-
The CommandAPI automatically reloads all datapacks in a similar fashion to `/minecraft:reload` in order to propagate CommandAPI commands into datapack functions and tags. This operation may cause a slight delay to server startup and is not necessary if you aren’t using datapacks or functions that use CommandAPI commands. This operation can be skipped by setting this value to `true`.
232+
If set to `false`, the CommandAPI reloads all datapacks in a similar fashion to `/minecraft:reload` in order to propagate CommandAPI commands into datapack functions and tags. This operation may cause a slight delay to server startup and is not necessary if you aren’t using datapacks or functions that use CommandAPI commands.
233233

234234
Note that datapacks will still be reloaded if performed manually when `hook-paper-reload` is set to `true` and you run `/minecraft:reload`.
235235

236236
**Default value**
237237

238238
```yaml
239-
skip-initial-datapack-reload: false
239+
skip-initial-datapack-reload: true
240240
```
241241

242242
**Example value**
243243

244244
```yaml
245-
skip-initial-datapack-reload: true
245+
skip-initial-datapack-reload: false
246246
```
247247

248248
### `plugins-to-convert`

0 commit comments

Comments
 (0)