From 2aa14f4c8198005ee7c3dfda6149f73aecf62f71 Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 15 Jun 2025 20:34:28 +0200 Subject: [PATCH] docs: Update fancydialogs.md --- docs/src/fancydialogs/fancydialogs.md | 6 +-- plugins/fancydialogs/README.md | 63 --------------------------- 2 files changed, 3 insertions(+), 66 deletions(-) delete mode 100644 plugins/fancydialogs/README.md diff --git a/docs/src/fancydialogs/fancydialogs.md b/docs/src/fancydialogs/fancydialogs.md index 376eda97..e0aec9a7 100644 --- a/docs/src/fancydialogs/fancydialogs.md +++ b/docs/src/fancydialogs/fancydialogs.md @@ -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. diff --git a/plugins/fancydialogs/README.md b/plugins/fancydialogs/README.md deleted file mode 100644 index 84fc98f6..00000000 --- a/plugins/fancydialogs/README.md +++ /dev/null @@ -1,63 +0,0 @@ -
- -![Banner](../../docs/src/static/logos-and-banners/fancydialogs-banner.png) - -[![Supports Folia](https://img.shields.io/badge/folia-supported-%23F9D879?labelColor=%2313154E&color=%234A44A6)](https://papermc.io/software/folia) -[![Discord](https://img.shields.io/discord/899740810956910683?cacheSeconds=3600&logo=discord&logoColor=white&label=%20&labelColor=%235865F2&color=%23707BF4)](https://discord.gg/ZUgYCEJUEx) -[![Modrinth Downloads](https://img.shields.io/modrinth/dt/fancyholograms?logo=modrinth&logoColor=white&label=downloads&labelColor=%23139549&color=%2318c25f)](https://modrinth.com/plugin/fancydialogs) - -[![Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/fancydialogs) -[![Hangar](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/hangar_vector.svg)](https://hangar.papermc.io/Oliver/FancyDialogs) - -
- -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. - -
- -## 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)**