Repository files navigation

cloud command framework

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 noambiguity at runtime. Cloud promotes writing reusable code, making it very easy to define new commands.

Cloud allows you to build commands in many different ways, according to your preferences:

Cloud is built to be very customisable, in order to fit your needs. You can inject handlers and processorsalong the entire command chain. If the pre-existing command parsers aren't enough for your needs, you're easilyable to create your own parsers. If you use the annotation parsing system, you can also define your own annotationsand 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,Discord4J, JDA4, JDA5, Kord and Javacord forDiscord bots, PircBotX for IRC andcloud-spring for Spring Shell.The core module allows you to use Cloud anywhere, simply by implementing the CommandManager for the platform of your choice.

• JavaDoc:https://javadoc.io/doc/org.incendo
• Docs:https://cloud.incendo.org
• Incendo Discord:https://discord.gg/aykZu32

• cloud - main repository
• cloud-minecraft - cloud implementations for minecraft
• cloud-minecraft-modded - cloud implementations for modded minecraft
• cloud-discord - cloud implementations for discord
• cloud-spring - cloud implementation for spring-shell
• cloud-processors - extra pre- & postprocessors
• cloud-build-logic - gradle plugin for building cloud
• cloud-docs - documentation sources

To clone the repository, usegit 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.

This library is licensed under theMIT 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 theCC Attribution 4 license.

TheCloud icon was created byThanga Vignesh P onIconscout and Digital rights were purchased under a premium plan.