Skip to content

Commit

Permalink
chore: port over the existing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Citymonstret committed Nov 28, 2023
1 parent e804a14 commit d83ef9a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 3 deletions.
37 changes: 36 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# Cloud

Hello :)
Cloud is a JVM framework for creating user commands.
A command is a chain of parsed arguments and a handler that gets invoked with the parsed values.
Cloud is not made to be used in any specific software, but it has modules with support for Minecraft
(Bukkit/Paper, BungeeCord, Velocity, Fabric, CloudBurst, Sponge & NeoForge), Discord (JavaCord & JDA)
and IRC (PIrcBotX).

Cloud allows you to write commands either using builders or annotated methods, and has special support for Kotlin.
Cloud allows you to customize the command execution pipeline by injecting custom behavior along the entire
execution path.

This document does not aim to cover every single detail of Cloud, but will instead introduce you to various different
concepts and explain how they can be used in your software
For technical details, we ask you to look at the [JavaDoc](https://javadocs.dev/cloud.commandframework).

We have a set of examples that introduce some useful Cloud concepts.
They are written for the Bukkit Minecraft API but the examples are not specific to Minecraft:
[example-bukkit](https://github.com/Incendo/cloud/tree/iCLOUD_BASE_BRANCHi/examples/example-bukkit).

## Structure

The documentation is split into different sections for the different Cloud modules.
It is highly recommended that you get started with the [cloud-core](./core/index.md) docs before you delve into the
platform-specific docs.
If you want to use annotated command methods, then you should start out with [cloud-core](./core/index.md) and then
move over to [cloud-annotations](./annotations/index.md).

## Development Builds

Development builds of Cloud are available on the Sonatype Snapshots Repository:

```xml
<repository>
<id>sonatype-snapshots</id>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
</repository>
```
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@ site_url: https://cloud.incendo.org/
repo_url: https://github.com/incendo/cloud-docs
repo_name: cloud-docs
nav:
- Home: index.md
- Cloud:
- Home: index.md
- cloud-core:
- Information: core/index.md
- cloud-annotations:
- Information: annotations/index.md
- cloud-kotlin:
- Information: kotlin/index.md
- Annotations: kotlin/annotations.md
- Coroutines: kotlin/coroutines.md
- Extensions: kotlin/extensions.md
- cloud-discord:
- Information: discord/index.md
- cloud-javacord: discord/javacord.md
Expand Down
6 changes: 5 additions & 1 deletion placeholder-plugin.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
placeholders:
CLOUD_BASE_VERSION: 2.0.0-dev
CLOUD_BASE_VERSION:
default: 2.0.0-dev
CLOUD_BASE_BRANCH:
default: 2.0.0-dev
replace_everywhere: true
settings:
auto_placeholder_tables: false

0 comments on commit d83ef9a

Please sign in to comment.