diff --git a/README.md b/README.md index d140fe9ed..305290506 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,55 @@ +# Bergerhealer Cloud Enhancements (Cloud 1.8.4) + +This repository hosts some improvements to the cloud command framework. +These changes are critical to make integrating cloud in other projects a success. + +To use this version of cloud, use the following repository: +```xml + + MG-Dev Jenkins CI Maven Repository + https://ci.mg-dev.eu/plugin/repository/everything + +``` + +And the following group id: `org.bergerhealer.cloud.commandframework`. For example: +```xml + + org.bergerhealer.cloud.commandframework + cloud-paper + 1.8.4 + + + org.bergerhealer.cloud.commandframework + cloud-annotations + 1.8.4 + +``` + +## Changes +This fork adds the following features/fixes + +### Simple coordinator fix +Fixes exceptions not caught or handled when using the simple coordinator. + +### InitializationMethod annotation +Makes it easier to register parsers / suggestion providers through annotations. +The annotation parser and/or the command manager can be passed to the method. +```java +@InitializationMethod +private void init(AnnotationParser parser, CommandManager manager) { + // Do your things here +} +``` + +### Prepend and append command handlers +Makes it possible to run code before and/or after a command is executed. +Useful in combination with command builder modifiers to, for example, check for +permissions before executing a command.
- + # cloud command framework ![license](https://img.shields.io/github/license/Incendo/cloud.svg) diff --git a/build-logic/src/main/kotlin/cloud.parent-build-logic.gradle.kts b/build-logic/src/main/kotlin/cloud.parent-build-logic.gradle.kts index 5636af6be..4f2065a32 100644 --- a/build-logic/src/main/kotlin/cloud.parent-build-logic.gradle.kts +++ b/build-logic/src/main/kotlin/cloud.parent-build-logic.gradle.kts @@ -1,5 +1,4 @@ plugins { - id("net.kyori.indra.publishing.sonatype") id("com.diffplug.spotless") } diff --git a/build-logic/src/main/kotlin/cloud.publishing-conventions.gradle.kts b/build-logic/src/main/kotlin/cloud.publishing-conventions.gradle.kts index 214f96a82..6b827ca4e 100644 --- a/build-logic/src/main/kotlin/cloud.publishing-conventions.gradle.kts +++ b/build-logic/src/main/kotlin/cloud.publishing-conventions.gradle.kts @@ -2,13 +2,15 @@ plugins { id("net.kyori.indra.publishing") } -signing { - val signingKey: String? by project - val signingPassword: String? by project - useInMemoryPgpKeys(signingKey, signingPassword) -} - indra { + // Need to specify in environment (or gradle.properties): + // - MGDevUsername + // - MGDevPassword + // - MGDevSigningKey + // - MGDevSigningPassword + publishAllTo("MGDev", "https://ci.mg-dev.eu/plugin/repository/everything") + signWithKeyFromPrefixedProperties("MGDev") + github("Incendo", "cloud") { ci(true) } @@ -27,3 +29,4 @@ indra { } } } + diff --git a/gradle.properties b/gradle.properties index 72e1e5d18..47a269a5c 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,4 +1,4 @@ -group=cloud.commandframework +group=org.bergerhealer.cloud.commandframework version=1.8.4 description=Command framework and dispatcher for the JVM diff --git a/gradle/libs.versions.yml b/gradle/libs.versions.yml index 70452c195..7201302d6 100644 --- a/gradle/libs.versions.yml +++ b/gradle/libs.versions.yml @@ -62,7 +62,7 @@ versions: compileTesting: "0.20" # build-logic - indra: 3.0.1 + indra: 3.1.0 gradleTestLogger: 3.2.0 gradleErrorprone: 3.0.1 spotless: *spotless