mirror of
https://github.com/FancyInnovations/FancyPlugins.git
synced 2025-12-06 07:43:36 +00:00
fancydialogs: Add docs for fancydialogs
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: FancyAnalytics
|
||||
icon: graph
|
||||
order: 90
|
||||
order: 80
|
||||
---
|
||||
|
||||
#
|
||||
|
||||
2
docs/src/fancydialogs/api/api.yml
Normal file
2
docs/src/fancydialogs/api/api.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
icon: code
|
||||
order: 6
|
||||
53
docs/src/fancydialogs/api/getting-started.md
Normal file
53
docs/src/fancydialogs/api/getting-started.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
icon: dot
|
||||
---
|
||||
|
||||
# Getting started
|
||||
|
||||
## Include the API in your project
|
||||
|
||||
To include the FancyNPCs API in your project, you need to add the following dependency to your `build.gradle.kts` or `pom.xml` file.
|
||||
|
||||
**Gradle:**
|
||||
```kotlin
|
||||
repositories {
|
||||
maven("https://repo.fancyinnovations.com/releases")
|
||||
}
|
||||
```
|
||||
|
||||
```kotlin
|
||||
dependencies {
|
||||
compileOnly("de.oliver:FancyDialogs:VERSION")
|
||||
}
|
||||
```
|
||||
|
||||
**Maven:**
|
||||
```xml
|
||||
<repository>
|
||||
<id>fancyinnovations-releases</id>
|
||||
<name>FancyInnovations Repository</name>
|
||||
<url>https://repo.fancyinnovations.com/releases</url>
|
||||
</repository>
|
||||
```
|
||||
|
||||
```xml
|
||||
<dependency>
|
||||
<groupId>de.oliver</groupId>
|
||||
<artifactId>FancyDialogs</artifactId>
|
||||
<version>VERSION</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
Replace `VERSION` with the version of the API you want to use. You can find the latest version on the download pages or in the GitHub releases.
|
||||
|
||||
## Create a new dialog
|
||||
|
||||
TODO
|
||||
|
||||
## JavaDocs and help
|
||||
|
||||
You can find the JavaDocs for the FancyNpcs API [here](https://repo.fancyinnovations.com/javadoc/releases/de/oliver/FancyNpcs/latest).
|
||||
|
||||
Join the [FancyInnovations Discord](https://discord.gg/ZUgYCEJUEx) for help and support. There is a dedicated channel for help about the api (`#npcs-dev`).
|
||||
```
|
||||
2
docs/src/fancydialogs/changelog/changelog.yml
Normal file
2
docs/src/fancydialogs/changelog/changelog.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
icon: log
|
||||
order: 5
|
||||
9
docs/src/fancydialogs/changelog/v1.md
Normal file
9
docs/src/fancydialogs/changelog/v1.md
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
icon: dot
|
||||
order: 1
|
||||
---
|
||||
|
||||

|
||||
|
||||
#
|
||||
|
||||
2
docs/src/fancydialogs/commands/commands.yml
Normal file
2
docs/src/fancydialogs/commands/commands.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
order: 9
|
||||
icon: command-palette
|
||||
10
docs/src/fancydialogs/commands/dialog.md
Normal file
10
docs/src/fancydialogs/commands/dialog.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
icon: dot
|
||||
order: 10
|
||||
---
|
||||
|
||||

|
||||
|
||||
# /Dialog
|
||||
|
||||
The `/dialog` command is the main command for managing dialogs.
|
||||
13
docs/src/fancydialogs/commands/fancydialogs.md
Normal file
13
docs/src/fancydialogs/commands/fancydialogs.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
icon: dot
|
||||
order: 9
|
||||
---
|
||||
|
||||

|
||||
|
||||
# /FancyDialogs
|
||||
|
||||
### Version
|
||||
|
||||
- **Syntax**: `/fancydialogs version`
|
||||
- **Permissions**: `fancydialogs.commands.fancydialogs.version`
|
||||
49
docs/src/fancydialogs/fancydialogs.md
Normal file
49
docs/src/fancydialogs/fancydialogs.md
Normal file
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: FancyDialogs
|
||||
icon: browser
|
||||
order: 90
|
||||
---
|
||||
|
||||
#
|
||||
|
||||

|
||||
|
||||
!!!
|
||||
Simple and lightweight dialogs plugin for Paper servers and other plugin developers.
|
||||
!!!
|
||||
|
||||
## Features
|
||||
|
||||
With this plugin you can create fancy dialogs for your server or plugin.
|
||||
FancyDialogs uses the new dialog feature, Minecraft introduced in **1.21.6** and combines it with the power of packets.
|
||||
|
||||
!!!warning
|
||||
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.)
|
||||
- MiniMessages and PlaceholderAPI support
|
||||
|
||||
### For servers
|
||||
|
||||
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
|
||||
|
||||
### 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.
|
||||
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.
|
||||
|
||||
Common use cases are:
|
||||
- Help dialogs (e.g. for commands or features)
|
||||
- Confirmation dialogs for critical actions
|
||||
- Shop UIs (replacing inventories UIs)
|
||||
- Dialogs for quests
|
||||
10
docs/src/fancydialogs/faq.md
Normal file
10
docs/src/fancydialogs/faq.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
order: 6
|
||||
icon: book
|
||||
---
|
||||
# FAQ
|
||||
|
||||
### Are older versions of Minecraft supported?
|
||||
|
||||
No, FancyDialogs only supports 1.21.6 or newer. FancyDialogs uses the new dialogs, which only exist in 1.21.6 and newer.
|
||||
|
||||
27
docs/src/fancydialogs/getting-started.md
Normal file
27
docs/src/fancydialogs/getting-started.md
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
order: 10
|
||||
icon: info
|
||||
---
|
||||
# Getting started
|
||||
|
||||
!!! danger
|
||||
Be aware, that only Paper and Folia is supported, but the plugin should work on any of its forks (like Purpur or Pufferfish). Spigot, Bukkit, Sponge and Fabric is not supported.
|
||||
!!!
|
||||
|
||||
## Installation
|
||||
|
||||
To install FancyDialogs, you need to download the latest version from one of the following sources:
|
||||
|
||||
[!button size="s" icon="download" iconAlign="left" text="Modrinth" target="blank"](https://modrinth.com/plugin/fancydialogs/versions)
|
||||
|
||||
[!button size="s" icon="download" iconAlign="left" text="Hangar" target="blank"](https://hangar.papermc.io/Oliver/FancyDialogs/versions)
|
||||
|
||||
After downloading the plugin, you can install it by placing the downloaded file in the `plugins` folder of your server.
|
||||
|
||||
Restart your server and you are ready to go!
|
||||
|
||||
To check if the plugin is installed correctly, you can use the command `/fancydialogs version`. If the plugin is installed correctly, it will show you the version of the plugin.
|
||||
|
||||
## Create your first dialog
|
||||
|
||||
TODO
|
||||
10
docs/src/fancydialogs/inspiration.md
Normal file
10
docs/src/fancydialogs/inspiration.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
order: 8
|
||||
icon: image
|
||||
---
|
||||
|
||||
# Inspiration
|
||||
|
||||
The following examples show how to use FancyDialogs in different ways. They are meant to give you an idea of what you can do with the plugin.
|
||||
|
||||
Almost all examples are made by the community. If you have a nice example that you want to share, feel free come to our discord server and show it to us.
|
||||
2
docs/src/fancydialogs/tutorials/tutorials.yml
Normal file
2
docs/src/fancydialogs/tutorials/tutorials.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
order: 7
|
||||
icon: mortar-board
|
||||
Reference in New Issue
Block a user