mirror of
https://github.com/FancyInnovations/FancyPlugins.git
synced 2025-12-06 07:43:36 +00:00
docs: Update fancydialogs.md
This commit is contained in:
@@ -23,8 +23,8 @@ The plugin will only for **Paper** servers on **1.21.6** or newer!
|
||||
|
||||
**Core advantages of FancyDialogs:**
|
||||
- Simple custom dialog creation (in JSON format or in code)
|
||||
- Many different dialog types (simple, notice, confirmation, form, etc.)
|
||||
- A lot of different dialog components (text, buttons, input fields, etc.)
|
||||
- Custom button actions (e.g. run commands, give items, open other dialogs)
|
||||
- MiniMessages and PlaceholderAPI support
|
||||
|
||||
### For servers
|
||||
@@ -32,13 +32,13 @@ The plugin will only for **Paper** servers on **1.21.6** or newer!
|
||||
If you use FancyDialogs as a plugin, you can take advantage of the following features:
|
||||
- Dialog as welcome-screen for players joining the first time
|
||||
- Custom tutorial dialogs
|
||||
- Integration with FancyNpcs and FancyAnalytics
|
||||
- FancyNpcs 'open_dialog' action for NPCs
|
||||
|
||||
### For plugin developers
|
||||
|
||||
If you are a plugin developer and want to spice up your plugin with dialogs, you can use FancyDialogs as a library.
|
||||
|
||||
You can define default dialogs, which will be persisted in the `plugins/FancyDialogs/dialogs` folder.
|
||||
You can define default dialogs, which will be persisted in the `plugins/FancyDialogs/data/dialogs` folder.
|
||||
This allows server administrators to customize the dialogs for their server.
|
||||
You can then use the dialogs in your plugin and show them to the players whenever you want.
|
||||
|
||||
|
||||
@@ -1,63 +0,0 @@
|
||||
<div align="center">
|
||||
|
||||

|
||||
|
||||
[](https://papermc.io/software/folia)
|
||||
[](https://discord.gg/ZUgYCEJUEx)
|
||||
[](https://modrinth.com/plugin/fancydialogs)
|
||||
|
||||
[](https://modrinth.com/plugin/fancydialogs)
|
||||
[](https://hangar.papermc.io/Oliver/FancyDialogs)
|
||||
|
||||
<br />
|
||||
|
||||
Simple and lightweight plugin to create and manage the new dialogs.
|
||||
Because the dialogs were added in 1.21.6, only players on 1.21.6 or newer can view them.
|
||||
|
||||
You can create create dialogs (in JSON files) and then assign them to many cool features.
|
||||
|
||||
</div>
|
||||
|
||||
## Features
|
||||
|
||||
- Welcome dialog: shows when a player joins for the first time
|
||||
- Tutorials: explain how your amazing server works in multiple chapters
|
||||
- Quick action: assign one dialog to the quick-action hotkey ('G' by default)
|
||||
- MiniMessage formatting is supported
|
||||
- You can use placeholders by PlaceholderAPI and MiniPlaceholders
|
||||
- Awesome API for other plugin developers to use
|
||||
|
||||
## Dialog structure
|
||||
|
||||
There are four different dialog types, you can choose from:
|
||||
|
||||
- Notice
|
||||
- Confirmation
|
||||
- Multi action
|
||||
- Dialog list
|
||||
|
||||
Each dialog has the following properties:
|
||||
|
||||
- Title: will be shown at the top of the screen
|
||||
- External title: will be shown when a button refers on this dialog
|
||||
- Can close with tab: true / false
|
||||
- Body: text and/or items
|
||||
- Inputs: see section below
|
||||
|
||||
Input controls:
|
||||
|
||||
- Checkbox: can be true or false
|
||||
- Slider (numbers): configure min, max and how many steps
|
||||
- Combobox: choose one element from a list
|
||||
- Text: the user can type any text (multiline boxes are supported)
|
||||
|
||||
## Installation
|
||||
|
||||
Paper **1.21.6** with **Java 21** (or higher) is required. Plugin should also work on **Paper** forks.
|
||||
|
||||
**Spigot** is **not** supported.
|
||||
|
||||
### Download
|
||||
|
||||
- **[Modrinth](https://modrinth.com/plugin/fancydialogs)**
|
||||
- **[Hangar](https://hangar.papermc.io/Oliver/FancyDialogs)**
|
||||
Reference in New Issue
Block a user