Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Incendo/Cloud

Command framework & dispatcher for the JVM
https://github.com/Incendo/Cloud

command-dispatcher commands hacktoberfest java java-command-framework java-commands

Last synced: 14 days ago
JSON representation

Command framework & dispatcher for the JVM

Awesome Lists containing this project

README 

        







cloud command framework



![license](https://img.shields.io/github/license/incendo/cloud.svg)

[![central](https://img.shields.io/maven-central/v/org.incendo/cloud-core)](https://search.maven.org/search?q=org.incendo)

![build](https://img.shields.io/github/actions/workflow/status/incendo/cloud/build.yml?logo=github)

[![docs](https://img.shields.io/readthedocs/incendocloud?logo=readthedocs)](https://cloud.incendo.org)




> [!NOTE]

> Cloud 2 is a major update with many significant changes. Cloud 2 is _not_ compatible with version 1.

> You can find the changelog [here](https://cloud.incendo.org/cloud-v2/).



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 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 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, 

Discord4J, JDA4, JDA5, Kord and Javacord for

Discord bots, PircBotX for IRC and [cloud-spring](https://github.com/incendo/cloud-spring) for Spring Shell.

The core module allows you to use Cloud anywhere, simply by implementing the CommandManager for the platform of your choice.



## links  



- JavaDoc: https://javadoc.io/doc/org.incendo

- Docs: https://cloud.incendo.org

- Incendo Discord: https://discord.gg/aykZu32



### repositories



- [cloud](https://github.com/incendo/cloud) - main repository

- [cloud-minecraft](https://github.com/incendo/cloud-minecraft) - cloud implementations for minecraft

- [cloud-minecraft-modded](https://github.com/incendo/cloud-minecraft-modded) - cloud implementations for modded minecraft

- [cloud-discord](https://github.com/incendo/cloud-discord) - cloud implementations for discord

- [cloud-spring](https://github.com/incendo/cloud-spring) - cloud implementation for spring-shell

- [cloud-processors](https://github.com/incendo/cloud-processors) - extra pre- & postprocessors

- [cloud-build-logic](https://github.com/incendo/cloud-build-logic) - gradle plugin for building cloud

- [cloud-docs](https://github.com/incendo/cloud-docs) - documentation sources

  

## 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`.



## 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.