[Brigadier] Add a simple example

Abierto
#529 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Área
documentation

Línea de trabajo

Revisa las páginas de documentación existentes de Brigadier y elige un ejemplo de comando que demuestre permisos, argumentos o literales anidados, ejecutores reutilizados y un cambio visible en el juego. Crea una guía paso a paso para principiantes, enlazando las páginas detalladas de cada concepto; se considerará terminado cuando la guía presente un comando completo y fácil de usar sin necesidad de conocimientos previos de Brigadier.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

[!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.

Lenguaje dominante
MDX
Estrellas
73
Forks
280
Merge medio
16 h 42 min
PR fusionados (30 d)
5

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PaperMC/docs

Todos los issues de PaperMC/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.