Skip to content

feat: Dialog API documentation #621

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: Dialog API documentation #621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
72f1703
Document dialog API
Strokkur424 Jul 10, 2025
ac6e072
Add dialog resource key to Brigadier registry argument documentation
Strokkur424 Jul 10, 2025
c7f2c99
Rename build-in to built-in
Strokkur424 Jul 17, 2025
114a4ef
Clarify null return from registry access
Strokkur424 Jul 17, 2025
0cc9b16
Clarify dialog list dialog type
Strokkur424 Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ export default defineConfig({
"paper/dev/plugin-configurations",
"paper/dev/lifecycle",
"paper/dev/registries",
"paper/dev/dialogs",
"paper/dev/recipes",
"paper/dev/folia-support",
"paper/dev/roadmap",
Expand Down
Binary file added src/content/docs/paper/dev/api/assets/dialogs/confirmation-dialog.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/content/docs/paper/dev/api/assets/dialogs/dialog-showcase.mp4
View file
Open in desktop
Binary file not shown.
Binary file added src/content/docs/paper/dev/api/assets/dialogs/input-boolean.mp4
View file
Open in desktop
Binary file not shown.
Binary file added src/content/docs/paper/dev/api/assets/dialogs/input-dialog-showcase.mp4
View file
Open in desktop
Binary file not shown.
Binary file added src/content/docs/paper/dev/api/assets/dialogs/input-multi-options.mp4
View file
Open in desktop
Binary file not shown.
Binary file added src/content/docs/paper/dev/api/assets/dialogs/input-number-range.mp4
View file
Open in desktop
Binary file not shown.
Binary file added src/content/docs/paper/dev/api/assets/dialogs/input-text.mp4
View file
Open in desktop
Binary file not shown.
Binary file added src/content/docs/paper/dev/api/assets/dialogs/notice-dialog.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...nt/docs/paper/dev/api/command-api/arguments/assets/registry-arguments/resource-dialog.mp4
View file
Open in desktop
Binary file not shown.
83 changes: 44 additions & 39 deletions src/content/docs/paper/dev/api/command-api/arguments/registry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import ResourceChickenVariant from "./assets/registry-arguments/resource-chicken
import ResourceCowVariant from "./assets/registry-arguments/resource-cow-variant.mp4";
import ResourceDamageType from "./assets/registry-arguments/resource-damage-type.mp4";
import ResourceDataComponentType from "./assets/registry-arguments/resource-data-component-type.mp4";
import ResourceDialog from "./assets/registry-arguments/resource-dialog.mp4";
import ResourceEnchantment from "./assets/registry-arguments/resource-enchantment.mp4";
import ResourceEntityType from "./assets/registry-arguments/resource-entity-type.mp4";
import ResourceFluid from "./assets/registry-arguments/resource-fluid.mp4";
Expand Down Expand Up @@ -197,42 +198,43 @@ input and be able to retrieve the backed instance without much trouble, that is

The following `RegistryKeys` exist:

| RegistryKeys Field | Return Value | Preview Video |
|------------------------|------------------------|---------------------------------------------|
| ATTRIBUTE | Attribute | [Attribute](#attribute) |
| BANNER_PATTERN | PatternType | [Banner Pattern](#banner-pattern) |
| BIOME | Biome | [Biome](#biome) |
| BLOCK | BlockType | [Block](#block) |
| CAT_VARIANT | Cat.Type | [Cat Variant](#cat-variant) |
| CHICKEN_VARIANT | Chicken.Variant | [Chicken Variant](#chicken-variant) |
| COW_VARIANT | Cow.Variant | [Cow Variant](#cow-variant) |
| DAMAGE_TYPE | DamageType | [Damage Type](#damage-type) |
| DATA_COMPONENT_TYPE | DataComponentType | [Data Component Type](#data-component-type) |
| ENCHANTMENT | Enchantment | [Enchantment](#enchantment) |
| ENTITY_TYPE | EntityType | [Entity Type](#entity-type) |
| FLUID | Fluid | [Fluid](#fluid) |
| FROG_VARIANT | Frog.Variant | [Frog Variant](#frog-variant) |
| GAME_EVENT | GameEvent | [Game Event](#game-event) |
| INSTRUMENT | MusicInstrument | [Instrument](#instrument) |
| ITEM | ItemType | [Item](#item) |
| JUKEBOX_SONG | JukeboxSong | [Jukebox Song](#jukebox-song) |
| MAP_DECORATION_TYPE | MapCursor.Type | [Map Decoration Type](#map-decoration-type) |
| MEMORY_MODULE_TYPE | MemoryKey\<?> | [Memory Module Type](#memory-module-type) |
| MENU | MenuType | [Menu](#menu) |
| MOB_EFFECT | PotionEffectType | [Mob effect](#mob-effect) |
| PAINTING_VARIANT | Art | [Painting variant](#painting-variant) |
| PARTICLE_TYPE | Particle | [Particle](#particle) |
| PIG_VARIANT | Pig.Variant | [Pig Variant](#pig-variant) |
| POTION | PotionType | [Potion](#potion) |
| SOUND_EVENT | Sound | [Sound](#sound) |
| STRUCTURE | Structure | [Structure](#structure) |
| STRUCTURE_TYPE | StructureType | [Structure Type](#structure-type) |
| TRIM_MATERIAL | TrimMaterial | [Trim Material](#trim-material) |
| TRIM_PATTERN | TrimPattern | [Trim Pattern](#trim-pattern) |
| VILLAGER_PROFESSION | Villager.Profession | [Villager Profession](#villager-profession) |
| VILLAGER_TYPE | Villager.Type | [Villager Type](#villager-type) |
| WOLF_SOUND_VARIANT | Wolf.SoundVariant | [Wolf Sound Variant](#wolf-sound-variant) |
| WOLF_VARIANT | Wolf.Variant | [Wolf Variant](#wolf-variant) |
| RegistryKeys Field | Return Value | Preview Video |
|---------------------|---------------------|---------------------------------------------|
| ATTRIBUTE | Attribute | [Attribute](#attribute) |
| BANNER_PATTERN | PatternType | [Banner Pattern](#banner-pattern) |
| BIOME | Biome | [Biome](#biome) |
| BLOCK | BlockType | [Block](#block) |
| CAT_VARIANT | Cat.Type | [Cat Variant](#cat-variant) |
| CHICKEN_VARIANT | Chicken.Variant | [Chicken Variant](#chicken-variant) |
| COW_VARIANT | Cow.Variant | [Cow Variant](#cow-variant) |
| DAMAGE_TYPE | DamageType | [Damage Type](#damage-type) |
| DATA_COMPONENT_TYPE | DataComponentType | [Data Component Type](#data-component-type) |
| DIALOG | Dialog | [Dialog](#dialog) |
| ENCHANTMENT | Enchantment | [Enchantment](#enchantment) |
| ENTITY_TYPE | EntityType | [Entity Type](#entity-type) |
| FLUID | Fluid | [Fluid](#fluid) |
| FROG_VARIANT | Frog.Variant | [Frog Variant](#frog-variant) |
| GAME_EVENT | GameEvent | [Game Event](#game-event) |
| INSTRUMENT | MusicInstrument | [Instrument](#instrument) |
| ITEM | ItemType | [Item](#item) |
| JUKEBOX_SONG | JukeboxSong | [Jukebox Song](#jukebox-song) |
| MAP_DECORATION_TYPE | MapCursor.Type | [Map Decoration Type](#map-decoration-type) |
| MEMORY_MODULE_TYPE | MemoryKey\<?> | [Memory Module Type](#memory-module-type) |
| MENU | MenuType | [Menu](#menu) |
| MOB_EFFECT | PotionEffectType | [Mob effect](#mob-effect) |
| PAINTING_VARIANT | Art | [Painting variant](#painting-variant) |
| PARTICLE_TYPE | Particle | [Particle](#particle) |
| PIG_VARIANT | Pig.Variant | [Pig Variant](#pig-variant) |
| POTION | PotionType | [Potion](#potion) |
| SOUND_EVENT | Sound | [Sound](#sound) |
| STRUCTURE | Structure | [Structure](#structure) |
| STRUCTURE_TYPE | StructureType | [Structure Type](#structure-type) |
| TRIM_MATERIAL | TrimMaterial | [Trim Material](#trim-material) |
| TRIM_PATTERN | TrimPattern | [Trim Pattern](#trim-pattern) |
| VILLAGER_PROFESSION | Villager.Profession | [Villager Profession](#villager-profession) |
| VILLAGER_TYPE | Villager.Type | [Villager Type](#villager-type) |
| WOLF_SOUND_VARIANT | Wolf.SoundVariant | [Wolf Sound Variant](#wolf-sound-variant) |
| WOLF_VARIANT | Wolf.Variant | [Wolf Variant](#wolf-variant) |

### Attribute
<Video src={ResourceAttributes} />
Expand All @@ -258,15 +260,18 @@ The following `RegistryKeys` exist:
### Damage type
<Video src={ResourceDamageType} />

### Data component type
<Video src={ResourceDataComponentType} />

### Dialog
<Video src={ResourceDialog} />

### Enchantment
<Video src={ResourceEnchantment} />

### Entity type
<Video src={ResourceEntityType} />

### Data component type
<Video src={ResourceDataComponentType} />

### Fluid
<Video src={ResourceFluid} />

Expand Down
Loading
Loading