-
-# cloud command framework
-
-
-
-[](https://search.maven.org/search?q=cloud.commandframework)
-
-Cloud is a general-purpose Java command dispatcher & framework. It allows programmers to define command chains that are then parsed and invoked from user-supplied string inputs, to execute pre-defined actions.
-
-Cloud commands consist out of deterministic chains of strongly typed arguments. When you define a command,
-you know exactly what type of data you're going to be working with, and you know that there will be no
-ambiguity at runtime. Cloud promotes writing reusable code, making it very easy to define new commands.
-
-Cloud allows for commands to be defined using builder patterns, like this:
-```java
-manager.command(
- manager.commandBuilder("command", Description.of("Test cloud command using a builder"), "alias")
- .argument(StringArgument.of("input"))
- .argument(IntegerArgument.builder("number").withMin(1).withMax(100).build())
- .handler(context -> {
- String input = context.get("input");
- int number = context.get("number");
- context.getSender().sendMessage(String.format(
- "I am %d%% hyped for %s!",
- number,
- input
- ));
- })
-);
-```
-or using annotated methods, like this:
-```java
-@CommandDescription("Test cloud command using @CommandMethod")
-@CommandMethod("command|alias ")
-private void yourCommand(
- CommandSender sender,
- @Argument("input") String input,
- @Argument("number") @Range(min = "1", max = "100") int number
-) {
- sender.sendMessage(String.format(
- "I am %d%% hyped for %s!",
- number,
- input
- ));
-}
-```
-depending on your preference.
-
-Cloud is built to be very customisable, in order to fit your needs. You can inject handlers and processors
-along the entire command chain. If the pre-existing command parsers aren't enough for your needs, you're easily
-able to create your own parsers. If you use the annotation parsing system, you can also define your own annotations
-and register them to further customise the behaviour of the library.
-
-Cloud by default ships with implementations and mappings for the most common Minecraft server platforms, JDA and javacord for
-Discord bots and PircBotX for IRC.
-The core module allows you to use Cloud anywhere, simply by implementing the CommandManager for the platform of your choice.
-
-The code is based on a (W.I.P) paper that can be found [here](https://github.com/Sauilitired/Sauilitired/blob/master/AS_2020_09_Commands.pdf).
-
-## nomenclature
-- **sender**: someone who is able to produce input
-- **argument**: an argument is something that can be parsed from a string
-- **required argument**: a required argument is an argument that must be provided by the sender
-- **optional argument**: an optional argument is an argument that can be omitted (may have a default value)
-- **static argument**: a string literal
-- **command**: a command is a chain of arguments and a handler that acts on the parsed arguments
-- **command tree**: structure that contains all commands and is used to parse input into arguments
-
-## modules
-- **cloud-core**: Core module containing most of the cloud API, and shared implementations
-- **cloud-annotations**: Annotation parsing code that allows you to use annotated methods rather than builders - Now also
- includes several compile-time annotation processors
-- **cloud-services**: Services for cloud
-- **cloud-kotlin/cloud-kotlin-extensions**: Kotlin extensions for cloud
-- **cloud-kotlin/cloud-kotlin-coroutines**: Coroutine support for cloud
-- **cloud-kotlin/cloud-kotlin-coroutines-annotations**: Coroutine support for cloud-annotations
-- **cloud-minecraft/cloud-brigadier**: Brigadier mappings for cloud
-- **cloud-minecraft/cloud-bukkit**: Bukkit 1.8.8+ implementation of cloud
-- **cloud-minecraft/cloud-paper**: Module that extends cloud-bukkit to add special support for Paper 1.8.8+
-- **cloud-minecraft/cloud-bungee**: BungeeCord 1.8.8+ implementation of Cloud
-- **cloud-minecraft/cloud-velocity**: Velocity v1.1.0 implementation of cloud
-- **cloud-minecraft/cloud-cloudburst**: Cloudburst v1.0.0+ implementation of cloud
-- **cloud-minecraft/cloud-fabric**: Fabric implementation of Cloud
-- **cloud-minecraft/cloud-minecraft-extras**: Opinionated Extra Features for cloud-minecraft
-- **cloud-discord/cloud-jda**: JDA v4.2.0_209+ implementation of cloud
-- **cloud-discord/cloud-javacord**: Javacord v3.1.1+ implementation of cloud
-- **cloud-irc/cloud-pircbotx**: PircBotX 2.0+ implementation of cloud
-
-## links
-
-- JavaDoc: https://javadoc.io/doc/cloud.commandframework
-- Docs: https://github.com/Incendo/cloud/blob/master/docs/README.adoc
-- Discord: https://discord.gg/aykZu32
-
-## develop & build
-
-To clone the repository, use `git clone https://github.com/Incendo/cloud.git`.
-
-To then build it, use `./gradlew clean build`. If you want to build the examples as well, use `./gradlew clean build
--Pcompile-examples`.
-
-## use
-
-To use `cloud` you will first need to add it as a dependency to your project.
-
-Release builds of Cloud are available through the Maven central repository.
-Snapshot builds of Cloud are available through the [Sonatype OSS Snapshot repository](https://oss.sonatype.org/content/repositories/snapshots).
-
-**maven**:
-```xml
-
- cloud.commandframework
- cloud-PLATFORM
- 1.8.4
-
-
-
- cloud.commandframework
- cloud-annotations
- 1.8.4
-
-```
-
-```xml
-
-
- sonatype-snapshots
- https://oss.sonatype.org/content/repositories/snapshots
-
-```
-
-If you are shading in cloud, it is highly recommended that you relocate all of our classes to prevent issues
-with conflicting dependencies:
-
-```xml
-
-
-
- org.apache.maven.plugins
- maven-shade-plugin
- 3.2.4
-
-
- package
-
- shade
-
-
- false
-
-
-
-
- ${project.build.directory}/dependency-reduced-pom.xml
-
-
- cloud.commandframework
- YOUR.PACKAGE.HERE.shaded.cloud
-
-
- io.leangen.geantyref
- YOUR.PACKAGE.HERE.shaded.typetoken
-
-
-
-
-
-
-```
-
-**gradle**:
-```kotlin
-repositories {
- mavenCentral()
- maven("https://oss.sonatype.org/content/repositories/snapshots") // For snapshot builds
-}
-```
-
-```kotlin
-dependencies {
- implementation("cloud.commandframework", "cloud-PLATFORM", "1.8.4")
-}
-```
-
-To shade and relocate cloud use [Gradle Shadow](https://github.com/johnrengelman/shadow).
-
-Replace `PLATFORM` with your platform of choice. We currently support: `bukkit`, `paper`, `bungee` and `velocity`for minecraft and `jda` and `javacord` for discord. All modules use the same versions.
-More information about the Minecraft specific modules can be found [here](https://github.com/Incendo/cloud/tree/master/cloud-minecraft).
-
-## attributions, links & acknowledgements
-
-This library is licensed under the MIT license, and the code copyright belongs to Alexander Söderberg. The implementation is based on a paper written by the copyright holder, and this paper exists under the CC Attribution 4 license.
-
-The Cloud icon was created by
-Thanga Vignesh P on Iconscout and Digital rights were purchased under a premium plan.
-
-## projects using cloud
-
-Here are some projects that are using cloud:
-
-- [Sauilitired/YouTrackDiscordBot](https://github.com/Sauilitired/YouTrackDiscordBot): Discord bot for linking YouTrack issues
-- [Incendo/bot](https://github.com/Incendo/bot): IRC bot for #incendo on esper.net
-- [Incendo/ban](https://github.com/Incendo/ban): Velocity punishment suite
-- [broccolai/tickets](https://github.com/broccolai/tickets): Minecraft ticket system
-- [jpenilla/squaremap](https://github.com/jpenilla/squaremap): Minimalistic and lightweight world map viewer for Minecraft servers
-- [bergerhealer/TrainCarts](https://github.com/bergerhealer/TrainCarts): Minecraft plugin that links carts together to form trains you can control
-- [PEXPlugins/PermissionsEx](https://github.com/PEXPlugins/PermissionsEx): Minecraft permissions plugin
+This is a fork of the Cloud. Upstream: https://github.com/Incendo/cloud.
+In development...
-