10000 Be more lenient with version checks when updating the minor version of the game by DerEchtePilz · Pull Request #594 · CommandAPI/CommandAPI · GitHub
[go: up one dir, main page]

Skip to content

Be more lenient with version checks when updating the minor version of the game #594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 14, 2024
Prev Previous commit
Next Next commit
Update documentation and changelog
  • Loading branch information
DerEchtePilz committed Aug 12, 2024
commit 3573fecf4535946691527777c9bb5351dea455c6
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,15 @@ This is the current roadmap for the CommandAPI (as of 30th April 2024):
</tr>
</thead>
<tbody>
<tr>
<td valign="top"><b>9.6.0</b></td>
<td valign="top">???</td>
<td valign="top">
<ul>
<li>https://github.com/JorelAli/CommandAPI/pull/594 Adds a config option to allow the CommandAPI to be more lenient when updating to a new minor version (e. g. from 1.21 to 1.21.1)</li>
</ul>
</td>
</tr>
<tr>
<td valign="top"><b>9.5.3</b></td>
<td valign="top">August 2024</td>
Expand Down
14 changes: 14 additions & 0 deletions docssrc/src/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,20 @@ use-latest-nms-version: true

-----

### `lenient-for-minor-versions`

Controls whether the CommandAPI should be more lenient when updating to a new Minecraft version.

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.

<div class="warning">

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.

</div>

-----

### `hook-paper-reload`

Controls whether the CommandAPI hooks into the Paper-exclusive `ServerResourcesReloadedEvent` when available.
Expand Down
1 change: 1 addition & 0 deletions docssrc/src/setup_shading.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public class CommandAPIConfig {
CommandAPIConfig verboseOutput(boolean value); // Enables verbose logging
CommandAPIConfig silentLogs(boolean value); // Disables ALL logging (except errors)
CommandAPIConfig useLatestNMSVersion(boolean value); // Whether the latest NMS implementation should be used or not
CommandAPIConfig lenientForMinorVersions(boolean value); // Whether the CommandAPI should be more lenient with minor Minecraft versions
CommandAPIConfig missingExecutorImplementationMessage(String value); // Set message to display when executor implementation is missing
CommandAPIConfig dispatcherFile(File file); // If not null, the CommandAPI will create a JSON file with Brigadier's command tree
CommandAPIConfig setNamespace(String namespace); // The namespace to use when the CommandAPI registers a command
Expand Down
Loading
0