Skip to content

Commit

Permalink
feat(minecraft): better screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Citymonstret committed Jan 23, 2024
1 parent a70e8d1 commit 90e3561
Show file tree
Hide file tree
Showing 11 changed files with 39 additions and 4 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/assets/images/minecraft/mce_help_index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/minecraft/brigadier.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,28 @@
[Brigadier](https://github.com/mojang/brigadier) is Mojang's command system. Cloud integrates with Brigadier on platforms
where this is supported. Unless you want to create a platform integration it is unlikely that you will want to depend
on `cloud-brigadier` directly. Instead, you are able to interact with Brigadier through the platform integration.

Where possible Cloud will map to platform-native argument types. Consult the documentation for your platform
implementation to find out what mappings exist. You may provide your own mappings to Brigadier argument types
through the `CloudBrigadierManager` that is available from the platform's `CommandManager`.

<figure markdown>
![Brigadier Native Arguments](../assets/images/minecraft/brigadier_native_types.png)
<figcaption>Native Brigadier Argument Types</figcaption>
</figure>

Custom argument types are mapped to Brigadier strings. Cloud suggestions are fully supported and will behave
like Brigadier-native suggestions.

<figure markdown>
![Brigadier Custom Arguments](../assets/images/minecraft/brigadier_custom_types.png)
<figcaption>Custom Argument Types</figcaption>
</figure>

Cloud commands map very accurately to Brigadier commands, which means that you get to benefit from
per-argument validation, coloring and syntax hinting.

<figure markdown>
![Brigadier Separate Arguments](../assets/images/minecraft/brigadier_separate_args.png)
<figcaption>Accurate Command Structure</figcaption>
</figure>
18 changes: 14 additions & 4 deletions docs/minecraft/minecraft-extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,20 @@ Cloud Minecraft Extras is available through [Maven Central](https://search.maven
`MinecraftHelp` is an opinionated implementation of the [help system](../core/index.md#help-generation) using
Adventure components for styling and click handling.

![Minecraft Help 1](../assets/images/mce_help_1_dark.png#only-dark)
![Minecraft Help 1](../assets/images/mce_help_1_light.png#only-light)
![Minecraft Help 2](../assets/images/mce_help_2_dark.png#only-dark)
![Minecraft Help 2](../assets/images/mce_help_2_light.png#only-light)
<!--![Minecraft Help 1](../assets/images/minecraft/mce_help_1_dark.png#only-dark)
![Minecraft Help 1](../assets/images/minecraft/mce_help_1_light.png#only-light)
![Minecraft Help 2](../assets/images/minecraft/mce_help_2_dark.png#only-dark)
![Minecraft Help 2](../assets/images/minecraft/mce_help_2_light.png#only-light)-->

<figure markdown>
![Minecraft Help Index](../assets/images/minecraft/mce_help_index.png)
<figcaption>Index View</figcaption>
</figure>

<figure markdown>
![Minecraft Help Verbose](../assets/images/minecraft/mce_help_verbose.png)
<figcaption>Verbose View</figcaption>
</figure>

All interactions with the Minecraft help system will take place through a `MinecraftHelp` instance.

Expand Down

0 comments on commit 90e3561

Please sign in to comment.