Merge pull request CommandAPI#609 from JorelAli/release/9.6.0

Release/9.6.0

Author: JorelAli

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -20,6 +20,9 @@ body:
       description: What version of Minecraft are you using? _(If using a minor version that isn't specified, such as 1.18.1, just select the latest version below it such as 1.18)_
       multiple: false
       options:
+        - "1.21.3"
+        - "1.21.2"
+        - "1.21.1"
         - "1.21"
         - "1.20.6"
         - "1.20.5"

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = CommandAPI
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 9.5.3
+PROJECT_NUMBER         = 9.6.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -53,23 +53,24 @@ The list of what version of the CommandAPI you'll need to run on a specific vers
 | **1.16.2**         | v4.0 - 5.12, 8.3.0  - 9.4.2 | 9.4.2                        | 16                                                        |
 | **1.16.3**         | v4.2 - 5.12, 8.3.0  - 9.4.2 | 9.4.2                        | 16                                                        |
 | **1.16.4**         | v5.2 - 5.12, 8.3.0  - 9.4.2 | 9.4.2                        | 16                                                        |
-| **1.16.5**         | v5.7 - 7.0.0, 8.3.0 - 9.5.3 | 9.5.3                        | 16                                                        |
-| **1.17**           | 6.0.x - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.17.1**         | 6.1.x - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.18, 1.18.1**   | 6.5.2 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.18.2**         | 6.5.4 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.19**           | 8.3.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.19.1**         | 8.5.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.19.2**         | 8.5.1 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.19.3**         | 8.7.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.19.4**         | 8.8.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.20**           | 9.0.2 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.20.1**         | 9.0.3 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.20.2**         | 9.2.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.20.3, 1.20.4** | 9.3.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.20.5, 1.20.6** | 9.4.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.21**           | 9.5.0 - 9.5.3               | 9.5.3                        | 16                                                        |
-| **1.21.1**         | 9.5.2 - 9.5.3               | 9.5.3                        | 16                                                        |
+| **1.16.5**         | v5.7 - 7.0.0, 8.3.0 - 9.6.0 | 9.6.0                        | 16                                                        |
+| **1.17**           | 6.0.x - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.17.1**         | 6.1.x - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.18, 1.18.1**   | 6.5.2 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.18.2**         | 6.5.4 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.19**           | 8.3.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.19.1**         | 8.5.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.19.2**         | 8.5.1 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.19.3**         | 8.7.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.19.4**         | 8.8.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.20**           | 9.0.2 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.20.1**         | 9.0.3 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.20.2**         | 9.2.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.20.3, 1.20.4** | 9.3.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.20.5, 1.20.6** | 9.4.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.21**           | 9.5.0 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.21.1**         | 9.5.2 - 9.6.0               | 9.6.0                        | 16                                                        |
+| **1.21.2, 1.21.3** | 9.6.0                       | 9.6.0                        | 16                                                        |
 
 -----
 
@@ -409,6 +410,21 @@ 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">October 2024</td>
+            <td valign="top">
+                <b>Minecraft Version Changes:</b>
+                <ul>
+                    <li>Adds support for Minecraft 1.21.2 and 1.21.3</li>
+                </ul>
+                <b>CommandAPI Changes:</b>
+                <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>
+                    <li>https://github.com/JorelAli/CommandAPI/pull/596, https://github.com/JorelAli/CommandAPI/pull/605 The plugin's <code>config.yml</code> file will be updated when config options are added or removed</li>
+                </ul>
+            </td>
+        </tr>
         <tr>
             <td valign="top"><b>9.5.3</b></td>
             <td valign="top">August 2024</td>

commandapi-annotations/pom.xml

@@ -18,7 +18,7 @@
 	<parent>
 		<groupId>dev.jorel</groupId>
 		<artifactId>commandapi</artifactId>
-		<version>9.5.3</version>
+		<version>9.6.0</version>
 	</parent>
 
 	<artifactId>commandapi-annotations</artifactId>

commandapi-codecov/pom.xml

@@ -20,7 +20,7 @@
 	<parent>
 		<groupId>dev.jorel</groupId>
 		<artifactId>commandapi</artifactId>
-		<version>9.5.3</version>
+		<version>9.6.0</version>
 	</parent>
 
 	<artifactId>commandapi-codecov</artifactId>
@@ -40,6 +40,16 @@
 			<artifactId>commandapi-bukkit-core</artifactId>
 			<version>${project.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>dev.jorel</groupId>
+			<artifactId>commandapi-plugin</artifactId>
+			<version>${project.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>dev.jorel</groupId>
+			<artifactId>commandapi-bukkit-plugin-common</artifactId>
+			<version>${project.version}</version>
+		</dependency>
 
 		<!-- Code coverage the tests -->
 		<dependency>

commandapi-core/pom.xml

@@ -19,7 +19,7 @@
 	<parent>
 		<artifactId>commandapi</artifactId>
 		<groupId>dev.jorel</groupId>
-		<version>9.5.3</version>
+		<version>9.6.0</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 

commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPI.java

@@ -109,8 +109,10 @@ public static void onLoad(CommandAPIConfig<?> config) {
 			CommandAPI.config = new InternalConfig(config);
 
 			// Initialize handlers
-			CommandAPIPlatform<?, ?, ?> platform = CommandAPIVersionHandler.getPlatform();
+			LoadContext loadContext = CommandAPIVersionHandler.getPlatform();
+			CommandAPIPlatform<?, ?, ?> platform = loadContext.platform();
 			new CommandAPIHandler<>(platform);
+			loadContext.context().run();
 
 			// Log platform load
 			final String platformClassHierarchy;

commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPIConfig.java

@@ -39,6 +39,7 @@ public abstract class CommandAPIConfig<Impl
 	boolean verboseOutput = false;
 	boolean silentLogs = false;
 	boolean useLatestNMSVersion = false;
+	boolean beLenientForMinorVersions = false;
 	String missingExecutorImplementationMessage = "This command has no implementations for %s";
 
 	File dispatcherFile = null;
@@ -90,6 +91,21 @@ public Impl useLatestNMSVersion(boolean value) {
 		return instance();
 	}
 
+	/**
+	 * Sets whether the CommandAPI should load a (potentially unsupported) NMS version
+	 * when updating to a minor release of Minecraft. 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.
+	 * Unlike {@link #useLatestNMSVersion(boolean)}, this setting does
+	 * not blindly load the latest NMS version, but will prefer loading the correct NMS implementation when available.
+	 *
+	 * @param value whether the CommandAPI should assume that minor Minecraft releases do not cause incompatibilities
+	 * @return this CommandAPIConfig
+	 */
+	public Impl beLenientForMinorVersions(boolean value) {
+		this.beLenientForMinorVersions = value;
+		return instance();
+	}
+
 	/**
 	 * Sets the message to display to users when a command has no executor.
 	 * Available formatting parameters are:

commandapi-core/src/main/java/dev/jorel/commandapi/CommandAPIVersionHandler.java

@@ -12,7 +12,7 @@ public interface CommandAPIVersionHandler {
 	 *
 	 * @return an instance of CommandAPIPlatform which can run on the currently active server
 	 */
-	static CommandAPIPlatform<?, ?, ?> getPlatform() {
+	static LoadContext getPlatform() {
 		throw new IllegalStateException("You have the wrong copy of the CommandAPI! If you're shading, did you use commandapi-core instead of commandapi-{platform}-shade?");
 	}
 }

commandapi-core/src/main/java/dev/jorel/commandapi/InternalConfig.java

@@ -40,6 +40,8 @@ public class InternalConfig {
 	// Whether we should use the latest NMS version (which may not be compatible)
 	private final boolean useLatestNMSVersion;
 
+	private final boolean beLenientForMinorVersions;
+
 	// The message to display when an executor implementation is missing
 	private final String messageMissingExecutorImplementation;
 
@@ -65,6 +67,7 @@ public InternalConfig(CommandAPIConfig<?> config) {
 		this.verboseOutput = config.verboseOutput;
 		this.silentLogs = config.silentLogs;
 		this.useLatestNMSVersion = config.useLatestNMSVersion;
+		this.beLenientForMinorVersions = config.beLenientForMinorVersions;
 		this.messageMissingExecutorImplementation = config.missingExecutorImplementationMessage;
 		this.dispatcherFile = config.dispatcherFile;
 		this.skipSenderProxy = config.skipSenderProxy;
@@ -94,6 +97,13 @@ public boolean shouldUseLatestNMSVersion() {
 		return this.useLatestNMSVersion;
 	}
 
+	/**
+	 * @return Whether the CommandAPI should assume that minor versions of officially unsupported versions do not cause incompatibilities
+	 */
+	public boolean shouldBeLenientForMinorVersions() {
+		return this.beLenientForMinorVersions;
+	}
+
 	/**
 	 * @return The message to display if a command executor does not have an
 	 *         implementation for a given type