Skip to content

Commit a3b2790

Browse files
committed
Finish config page
1 parent 759a92c commit a3b2790

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

docs/en/user-setup/config.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -196,52 +196,51 @@ create-dispatcher-json: false
196196
create-dispatcher-json: true
197197
```
198198

199-
### `use-latest-nms-version`
199+
### `fallback-to-latest-nms`
200200

201-
Controls whether the CommandAPI should use the latest NMS implementation for command registration and execution.
201+
Controls whether the CommandAPI should use the latest NMS implementation for command registration and execution if no matching CommandAPI implementation for the version used is found.
202202

203203
This setting can be used to run the CommandAPI on Minecraft versions higher than it can support. For example, if the CommandAPI supports Minecraft 1.18 and Minecraft 1.18.1 comes out, you can use this to enable support for 1.18.1 before an official CommandAPI release comes out that supports 1.18.1.
204204

205-
:::danger
205+
<div class="paper">
206206

207-
This feature is very experimental and should only be used if you know what you’re doing. In almost every case, it is better to wait for an official CommandAPI release that supports the latest version of Minecraft. Using `use-latest-nms-version` is _not_ guaranteed to work and can cause unexpected side effects!
207+
:::warning
208+
209+
Using `fallback-to-latest-nms` is _not_ guaranteed to work and can cause unexpected side effects! However, since we expect very few major breaking changes, we decided to set this value to `true` by default.
208210

209211
:::
210212

211213
**Default value**
212214

213215
```yaml
214-
use-latest-nms-version: false
216+
fallback-to-latest-nms: true
215217
```
216218

217219
**Example value**
218220

219221
```yaml
220-
use-latest-nms-version: true
222+
fallback-to-latest-nms: false
221223
```
222224

223-
### `be-lenient-for-minor-versions`
224-
225-
Controls whether the CommandAPI should be more lenient when updating to a new Minecraft version.
226-
227-
Similar to the [`use-latest-nms-version`](#use-latest-nms-version) setting, this can allow the CommandAPI to run on a version higher than it officially supports. As an example, this setting can allow updating to 1.21.2 from 1.21.1 but doesn't allow updating to 1.22 from 1.21.2.
225+
</div>
226+
<div class="spigot">
228227

229228
:::danger
230229

231-
Take the warning from the [`use-latest-nms-version`](#use-latest-nms-version) and apply it here too. This is _not_ guaranteed to work either and also may cause unexpected side effects.
230+
This feature is very experimental and should only be used if you know what you’re doing. In almost every case, it is better to wait for an official CommandAPI release that supports the latest version of Minecraft. Using `fallback-to-latest-nms` is _not_ guaranteed to work and can cause unexpected side effects!
232231

233232
:::
234233

235234
**Default value**
236235

237236
```yaml
238-
be-lenient-for-minor-versions: false
237+
fallback-to-latest-nms: false
239238
```
240239

241240
**Example value**
242241

243242
```yaml
244-
be-lenient-for-minor-versions: true
243+
fallback-to-latest-nms: true
245244
```
246245

247246
### `skip-initial-datapack-reload`
@@ -264,6 +263,8 @@ skip-initial-datapack-reload: true
264263
skip-initial-datapack-reload: false
265264
```
266265

266+
</div>
267+
267268
### `plugins-to-convert`
268269

269270
Controls the list of plugins to process for command conversion. See [Command conversion](command-conversion/conversion) for more information.

0 commit comments

Comments
 (0)