Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Brigadier] Add a simple example #529

Open
Strokkur424 opened this issue Jan 22, 2025 · 0 comments
Open

[Brigadier] Add a simple example #529

Strokkur424 opened this issue Jan 22, 2025 · 0 comments

Comments

@Strokkur424
Copy link
Contributor

Note

This issue is part of a series of issues regarding the extension of the Paper documentation regarding Paper's Brigadier API.

Currently, the documentation documents the separate aspects of Brigadier, but doesn't really bring all of them together in a real command. Therefore, it would be great if the documentation had a step-by-step creation of an actual user-friendly and refined command which provides some more logic. The command should display the usage of the following aspects:

  • Permissions (using requirements)
  • Nested arguments/literals
  • Reused command executors (E.g. default value if an argument is not provided)
  • Some visible change in-game

An example could be a skull-giving command, which has the following structure:

/skull
/skull <offline-player>
/skull <offline-player> <amount>

Warning

The command example really isn't a great one. I would appreciate it if somebody who has a better idea could suggest it here

It should be made sure that this guide helps even a beginner go through the process of building up a command, but it doesn't have to go into detail of what the separate steps mean precisely. For this, it can just be linked to their respective pages where they are described in more detail.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant