docs: Polish docs for FancyDialogs

This commit is contained in:
Oliver
2025-11-23 11:05:15 +01:00
parent d6dc456f2a
commit 169ec91269
4 changed files with 28 additions and 21 deletions

View File

@@ -0,0 +1,19 @@
---
icon: dot
order: 2
---
![](../../static/changelog_v1_x_x.png)
#
## v1.0.0 [!badge variant="info" text="2025-11-23"]
- Create dialogs using the [JSON schema](https://docs.fancyinnovations.com/fancydialogs/tutorials/json-schema/)
- PlaceholderAPI and MiniMessage support in dialog texts
- Execute actions when dialog buttons are clicked
- Open a dialog when the user joins the server for the first time (see `welcome_dialog_id` in the config)
- A quick actions dialog which can be opened with the `/qa` or `/quickactions` commands
- FancyNpcs ingegration to open dialogs when interacting with NPCs (see [docs](https://docs.fancyinnovations.com/fancydialogs/tutorials/open-dialog-npc-action/))
- API for other plugins to open dialogs (see [docs](https://docs.fancyinnovations.com/fancydialogs/api/getting-started/))

View File

@@ -71,7 +71,7 @@ Unregisters a dialog by its ID.
## Joined Players Cache ## Joined Players Cache
## Clear joined players cache ### Clear joined players cache
Clears the cache of players who have joined a dialog. Clears the cache of players who have joined a dialog.

View File

@@ -1,5 +1,5 @@
--- ---
title: FancyDialogs [WIP] title: FancyDialogs
icon: browser icon: browser
order: 90 order: 90
--- ---
@@ -21,11 +21,6 @@ FancyDialogs uses the new dialog feature, Minecraft introduced in **1.21.6** and
The plugin will only for **Paper** servers on **1.21.6** or newer! The plugin will only for **Paper** servers on **1.21.6** or newer!
!!! !!!
!!!warning
FancyDialogs is still in development and some features are not yet implemented.
See the [TODO](#todo) section for more information.
!!!
**Core advantages of FancyDialogs:** **Core advantages of FancyDialogs:**
- Simple custom dialog creation (in JSON format or in code) - Simple custom dialog creation (in JSON format or in code)
- A lot of different dialog components (text, buttons, input fields, etc.) - A lot of different dialog components (text, buttons, input fields, etc.)
@@ -52,17 +47,3 @@ Common use cases are:
- Confirmation dialogs for critical actions - Confirmation dialogs for critical actions
- Shop UIs (replacing inventories UIs) - Shop UIs (replacing inventories UIs)
- Dialogs for quests - Dialogs for quests
## TODO
- [X] Create dialogs in JSON format
- [X] Create dialogs in code
- [X] Customize dialog content and buttons
- [X] Open dialogs for players (via commands or code)
- [X] Welcome dialog for new players
- [X] FancyNpcs integration (open_dialog action)
- [X] Confirmation and notice dialogs (API)
- [x] Add button action system
- [ ] Add support for the quick action hotkey
- [ ] Add tutorial features
- [ ] Add input controls

View File

@@ -0,0 +1,7 @@
- Create dialogs using the [JSON schema](https://docs.fancyinnovations.com/fancydialogs/tutorials/json-schema/)
- PlaceholderAPI and MiniMessage support in dialog texts
- Execute actions when dialog buttons are clicked
- Open a dialog when the user joins the server for the first time (see `welcome_dialog_id` in the config)
- A quick actions dialog which can be opened with the `/qa` or `/quickactions` commands
- FancyNpcs ingegration to open dialogs when interacting with NPCs (see [docs](https://docs.fancyinnovations.com/fancydialogs/tutorials/open-dialog-npc-action/))
- API for other plugins to open dialogs (see [docs](https://docs.fancyinnovations.com/fancydialogs/api/getting-started/))