mirror of
https://github.com/FancyInnovations/FancyPlugins.git
synced 2025-12-06 07:43:36 +00:00
docs: Add tutorial about the json schema for dialogs
This commit is contained in:
Oliver
@@ -27,74 +27,4 @@ To check if the plugin is installed correctly, you can use the command `/fancydi
|
||||
FancyDialogs come with some default dialogs, which you can use to get started. You can find them in the `plugins/FancyDialogs/data/dialogs` folder.
|
||||
You can also create your own dialogs by creating a new file in this folder.
|
||||
|
||||
FancyDialogs uses a simple JSON format to define dialogs. Here is an example of a simple dialog:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "my_dialog",
|
||||
"title": "My Fancy Dialog",
|
||||
"canCloseWithEscape": true,
|
||||
"body": [
|
||||
{ "text": "This is my first dialog created with FancyDialogs!" }
|
||||
],
|
||||
"inputs": {
|
||||
"textFields": [
|
||||
{
|
||||
"key": "fav_color",
|
||||
"order": 1,
|
||||
"label": "<color:#ff7300>What is your favorite color?</color>",
|
||||
"placeholder": "gold",
|
||||
"maxLength": 50,
|
||||
"maxLines": 1
|
||||
}
|
||||
]
|
||||
},
|
||||
"buttons": [
|
||||
{
|
||||
"label": "Show favorite color",
|
||||
"tooltip": "Click to show your favorite color",
|
||||
"actions": [
|
||||
{
|
||||
"name": "message",
|
||||
"data": "Your favorite color is: <color:{fav_color}>{fav_color}</color>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The fields in this dialog are as follows:
|
||||
|
||||
- `id`: The unique identifier for the dialog, which is used to reference the dialog in commands or other dialogs
|
||||
- `title`: The title of the dialog, which is displayed at the top of the dialog (supports MiniMessage & PlaceholderAPI)
|
||||
- `canCloseWithEscape`: Whether the dialog can be closed with the Escape key (default: true)
|
||||
- `body`: The body of the dialog, which can contain text (and items soon)
|
||||
- `text`: The text to display in the body of the dialog (supports MiniMessage & PlaceholderAPI)
|
||||
- `inputs`: The inputs of the dialog, which can contain text fields
|
||||
- `textFields`: A list of text fields that can be used to collect input from the player
|
||||
- `key`: The key to use to store the input value (can be used as a placeholder in actions)
|
||||
- `order`: The order of the text field in the dialog
|
||||
- `label`: The label to display above the text field (supports MiniMessage & PlaceholderAPI)
|
||||
- `placeholder`: The initial text to display in the text field
|
||||
- `maxLength`: The maximum length of the input
|
||||
- `maxLines`: The maximum number of lines for the input (greater than 1 will create a multiline text field)
|
||||
- `selects`: A list of text fields that can be used to collect input from the player
|
||||
- `key`: The key to use to store the input value (can be used as a placeholder in actions)
|
||||
- `order`: The order of the text field in the dialog
|
||||
- `label`: The label to display above the text field (supports MiniMessage & PlaceholderAPI)
|
||||
- `options`: A list of options that can be selected by the player
|
||||
- `value`: The value that will be returned when the player selects this option
|
||||
- `display`: The text to display in the select field (supports MiniMessage & PlaceholderAPI)
|
||||
- `initial`: Whether this option is selected by default (default: false)
|
||||
- `buttons`: The buttons of the dialog, which can contain text, tooltips and actions
|
||||
- `label`: The text to display on the button (supports MiniMessage & PlaceholderAPI)
|
||||
- `tooltip`: The tooltip to display when hovering over the button (supports MiniMessage & PlaceholderAPI)
|
||||
- `actions`: The actions to perform when the button is clicked
|
||||
- `name`: The name of the action, which can be one of the following:
|
||||
- `message`: Sends a message to the player
|
||||
- `console_command`: Executes a command as the console
|
||||
- `player_command`: Executes a command as the player
|
||||
- `open_dialog`: Opens another dialog
|
||||
- `send_to_server`: Sends the player to another server (requires BungeeCord or Velocity)
|
||||
- `data`: The data for the action, which depends on the action type (e.g. for `message`, it is the message to send or for `open_dialog`, it is the ID of the dialog to open)
|
||||
FancyDialogs uses a simple JSON format to define dialogs. Read the [JSON Schema](tutorials/json-schema.md) tutorial to learn more about the format.
|
||||
130
docs/src/fancydialogs/tutorials/json-schema.md
Normal file
130
docs/src/fancydialogs/tutorials/json-schema.md
Normal file
@@ -0,0 +1,130 @@
|
||||
---
|
||||
icon: dot
|
||||
order: 10
|
||||
---
|
||||
|
||||
# JSON Schema
|
||||
|
||||
In this tutorial, we will explore the JSON schema used by FancyDialogs to define dialogs.
|
||||
This schema provides a structured way to create fancy dialogs.
|
||||
|
||||
## Example Dialog
|
||||
|
||||
The easiest way to create a new dialog is to copy an existing dialog and modify it to suit your needs.
|
||||
You can find some example dialogs in the `plugins/FancyDialogs/data/dialogs` folder on your server.
|
||||
|
||||
Below is an example of a simple dialog defined using the FancyDialogs JSON schema:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "my_dialog",
|
||||
"title": "My Fancy Dialog",
|
||||
"canCloseWithEscape": true,
|
||||
"body": [
|
||||
{ "text": "This is my first dialog created with FancyDialogs!" }
|
||||
],
|
||||
"inputs": {
|
||||
"textFields": [
|
||||
{
|
||||
"key": "fav_color",
|
||||
"order": 1,
|
||||
"label": "<color:#ff7300>What is your favorite color?</color>",
|
||||
"placeholder": "gold",
|
||||
"maxLength": 50,
|
||||
"maxLines": 1
|
||||
}
|
||||
]
|
||||
},
|
||||
"buttons": [
|
||||
{
|
||||
"label": "Show favorite color",
|
||||
"tooltip": "Click to show your favorite color",
|
||||
"actions": [
|
||||
{
|
||||
"name": "message",
|
||||
"data": "Your favorite color is: <color:{fav_color}>{fav_color}</color>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Fields Explained
|
||||
|
||||
### Common Fields
|
||||
|
||||
`id`: The unique identifier for the dialog, which is used to reference the dialog in commands or other dialogs
|
||||
|
||||
`title`: The title of the dialog, which is displayed at the top of the dialog (supports MiniMessage & PlaceholderAPI)
|
||||
|
||||
`canCloseWithEscape`: Whether the dialog can be closed with the Escape key (default: true)
|
||||
|
||||
`body`: The body of the dialog - see [Body Section](#body-fields) for details
|
||||
|
||||
`inputs`: The inputs of the dialog - see [Input Section](#input-fields) for details
|
||||
|
||||
`buttons`: The buttons of the dialog - see [Button Section](#button-fields) for details
|
||||
|
||||
### Body fields
|
||||
|
||||
`text`: The text to display in the body of the dialog (supports MiniMessage & PlaceholderAPI)
|
||||
|
||||
!!!info
|
||||
Items will be supported in the body section in a future release.
|
||||
!!!
|
||||
|
||||
### Input fields
|
||||
|
||||
`textFields`: A list of text fields - see [Text Fields](#text-fields) for details
|
||||
|
||||
`selects`: A list of select fields - see [Select Fields](#select-fields) for details
|
||||
|
||||
!!!info
|
||||
More input types will be added in future releases, such as checkboxes and number sliders.
|
||||
!!!
|
||||
|
||||
#### Text Fields
|
||||
|
||||
`key`: The key to use to store the input value (can be used as a placeholder in actions)
|
||||
|
||||
`order`: The order of the text field in the dialog
|
||||
|
||||
`label`: The label to display above the text field (supports MiniMessage & PlaceholderAPI)
|
||||
|
||||
`placeholder`: The initial text to display in the text field
|
||||
|
||||
`maxLength`: The maximum length of the input
|
||||
|
||||
`maxLines`: The maximum number of lines for the input (greater than 1 will create a multiline text field)
|
||||
|
||||
#### Select Fields
|
||||
|
||||
`key`: The key to use to store the input value (can be used as a placeholder in actions)
|
||||
|
||||
`order`: The order of the select field in the dialog
|
||||
|
||||
`label`: The label to display above the select field (supports MiniMessage & PlaceholderAPI)
|
||||
|
||||
`options`: A list of options that can be selected by the player
|
||||
- `value`: The value that will be returned when the player selects this option
|
||||
- `display`: The text to display in the select field (supports MiniMessage & PlaceholderAPI)
|
||||
- `initial`: Whether this option is selected by default (default: false)
|
||||
|
||||
### Button fields
|
||||
|
||||
- `label`: The text to display on the button (supports MiniMessage & PlaceholderAPI)
|
||||
- `tooltip`: The tooltip to display when hovering over the button (supports MiniMessage & PlaceholderAPI)
|
||||
- `actions`: A list of actions that will be executed when the button is clicked - see [Actions](#actions) for details
|
||||
|
||||
#### Actions
|
||||
|
||||
- `name`: The name of the action (see below for a list of available actions)
|
||||
- `data`: The data for the action, which depends on the action type
|
||||
|
||||
Available actions include:
|
||||
- `message`: Sends a message to the player (set `data` to the message)
|
||||
- `console_command`: Executes a command as the console (set `data` to the command)
|
||||
- `player_command`: Executes a command as the player (set `data` to the command)
|
||||
- `open_dialog`: Opens another dialog (set `data` to the ID of the dialog to open)
|
||||
- `send_to_server`: Sends the player to another server (requires BungeeCord or Velocity) (set `data` to the server name)
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
icon: dot
|
||||
order: 9
|
||||
---
|
||||
|
||||
# Open dialog npc action
|
||||
|
||||
!!!warning
|
||||
|
||||
Reference in New Issue
Block a user