diff --git a/docs/src/fancycore/api/api.yml b/docs/src/fancycore/api/api.yml new file mode 100644 index 00000000..f9bb072b --- /dev/null +++ b/docs/src/fancycore/api/api.yml @@ -0,0 +1,2 @@ +icon: code +order: 6 \ No newline at end of file diff --git a/docs/src/fancycore/api/getting-started.md b/docs/src/fancycore/api/getting-started.md new file mode 100644 index 00000000..6660f645 --- /dev/null +++ b/docs/src/fancycore/api/getting-started.md @@ -0,0 +1,50 @@ +--- +icon: dot +--- + +# Getting started + +## Include the API in your project + +To include the FancyCore 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("com.fancyinnovations:FancyCore:VERSION") +} +``` + +**Maven:** +```xml + + fancyinnovations-releases + FancyInnovations Repository + https://repo.fancyinnovations.com/releases + +``` + +```xml + + com.fancyinnovations + FancyCore + VERSION + provided + +``` + +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. + + +## JavaDocs and help + +You can find the JavaDocs for the FancyDialogs API [here](https://repo.fancyinnovations.com/javadoc/releases/com/fancyinnovations/FancyCore/latest). + +Join the [FancyInnovations Discord](https://discord.gg/ZUgYCEJUEx) for help and support. There is a dedicated channel for help about the api (`#core-api`). +``` \ No newline at end of file diff --git a/docs/src/fancycore/changelog/changelog.yml b/docs/src/fancycore/changelog/changelog.yml new file mode 100644 index 00000000..ee9a3264 --- /dev/null +++ b/docs/src/fancycore/changelog/changelog.yml @@ -0,0 +1,2 @@ +icon: log +order: 5 \ No newline at end of file diff --git a/docs/src/fancycore/changelog/v0.md b/docs/src/fancycore/changelog/v0.md new file mode 100644 index 00000000..172f1db7 --- /dev/null +++ b/docs/src/fancycore/changelog/v0.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: V0 +order: 1 +--- + +# FancyCore v0.x.x + + diff --git a/docs/src/fancycore/commands/chat.md b/docs/src/fancycore/commands/chat.md new file mode 100644 index 00000000..92673c9f --- /dev/null +++ b/docs/src/fancycore/commands/chat.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: Chat +order: 8 +--- + +![](../../static/commands.png) + +# Commands for the chat system diff --git a/docs/src/fancycore/commands/commands.yml b/docs/src/fancycore/commands/commands.yml new file mode 100644 index 00000000..4aaae68a --- /dev/null +++ b/docs/src/fancycore/commands/commands.yml @@ -0,0 +1,2 @@ +order: 9 +icon: command-palette \ No newline at end of file diff --git a/docs/src/fancycore/commands/economy.md b/docs/src/fancycore/commands/economy.md new file mode 100644 index 00000000..a191f27a --- /dev/null +++ b/docs/src/fancycore/commands/economy.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: Economy +order: 9 +--- + +![](../../static/commands.png) + +# Commands for the economy system diff --git a/docs/src/fancycore/commands/moderation.md b/docs/src/fancycore/commands/moderation.md new file mode 100644 index 00000000..6525bc21 --- /dev/null +++ b/docs/src/fancycore/commands/moderation.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: Moderation +order: 7 +--- + +![](../../static/commands.png) + +# Commands for the moderation system diff --git a/docs/src/fancycore/commands/permissions.md b/docs/src/fancycore/commands/permissions.md new file mode 100644 index 00000000..d45b7b2c --- /dev/null +++ b/docs/src/fancycore/commands/permissions.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: Permissions +order: 10 +--- + +![](../../static/commands.png) + +# Commands for the permissions system diff --git a/docs/src/fancycore/commands/player.md b/docs/src/fancycore/commands/player.md new file mode 100644 index 00000000..082e856a --- /dev/null +++ b/docs/src/fancycore/commands/player.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: Player +order: 4 +--- + +![](../../static/commands.png) + +# Commands for the player system diff --git a/docs/src/fancycore/commands/server.md b/docs/src/fancycore/commands/server.md new file mode 100644 index 00000000..9111cbe8 --- /dev/null +++ b/docs/src/fancycore/commands/server.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: Server +order: 3 +--- + +![](../../static/commands.png) + +# Commands for the server system diff --git a/docs/src/fancycore/commands/teleportation.md b/docs/src/fancycore/commands/teleportation.md new file mode 100644 index 00000000..a8d1c0ac --- /dev/null +++ b/docs/src/fancycore/commands/teleportation.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: Teleportation +order: 5 +--- + +![](../../static/commands.png) + +# Commands for the teleportation system diff --git a/docs/src/fancycore/commands/world.md b/docs/src/fancycore/commands/world.md new file mode 100644 index 00000000..24c72274 --- /dev/null +++ b/docs/src/fancycore/commands/world.md @@ -0,0 +1,9 @@ +--- +icon: dot +title: World +order: 6 +--- + +![](../../static/commands.png) + +# Commands for the world management system diff --git a/docs/src/fancycore/fancycore.md b/docs/src/fancycore/fancycore.md new file mode 100644 index 00000000..ecd02d86 --- /dev/null +++ b/docs/src/fancycore/fancycore.md @@ -0,0 +1,32 @@ +--- +title: FancyCore [Hytale] +icon: package +order: 90 +--- + +# + +![](../static/logos-and-banners/fancycore-banner.png) + +!!! +Essential feature every Hytale server needs. From permission management over world management to economy and more. +!!! + +## Features + +With FancyCore, you get a wide variety of features that are essential for running a Hytale server: + +- **Permissions**: permission management system to control access to commands and features +- **Economy**: robust economy system with virtual currency, shops, and trading +- **Chat**: advanced chat management with channels, formatting, nicknames and msgs +- **Moderation**: tools for server admins including bans, kicks, warnings, and logs +- **World**: create and manage multiple worlds with different settings and environments +- **Teleportation**: spawn point, warps, player homes, and teleport requests +- **Player**: utility commands such as fly, speed, gamemode, heal, and more +- **Server**: view server stats and manage plugins +- **API**: comprehensive API for developers to extend and customize FancyCore +- **And much more!** + +FancyCore is designed to provide all the essential features needed to build a successful Hytale server, while being easy to use and highly customizable. +We are trying to get a usable version out as soon as possible. +If you don't want to miss any updates, join our [Discord](https://discord.gg/ZUgYCEJUEx) and assign yourself the "FancyCore" role. \ No newline at end of file diff --git a/docs/src/fancycore/faq.md b/docs/src/fancycore/faq.md new file mode 100644 index 00000000..8a8125f0 --- /dev/null +++ b/docs/src/fancycore/faq.md @@ -0,0 +1,10 @@ +--- +order: 6 +icon: book +--- +# FAQ + +### Is FancyCore available for Minecraft? + +No, FancyCore is a Hytale only plugin. There are no plans to make it available for Minecraft at this time. + diff --git a/docs/src/fancycore/getting-started.md b/docs/src/fancycore/getting-started.md new file mode 100644 index 00000000..e51ed2cb --- /dev/null +++ b/docs/src/fancycore/getting-started.md @@ -0,0 +1,24 @@ +--- +order: 10 +icon: info +--- +# Getting started + +!!!danger +Be aware that this plugin is only made for Hytale servers. Only the latest version of Hytale is supported. +!!! + +## Installation + +To install FancyCore, you need to download the latest version from one of the following sources: + +[!button size="s" icon="download" iconAlign="left" text="Curseforge" target="blank"](https://www.curseforge.com/members/real_oliver/projects) + +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 `/fancycore version`. If the plugin is installed correctly, it will show you the version of the plugin. + +You can now learn more about the commands in the `Commands` section of the documentation or learn how to configure the plugin in the `Tutorials` section. +The API documentation can be found in the `Api` section. \ No newline at end of file diff --git a/docs/src/fancycore/tutorials/tutorials.yml b/docs/src/fancycore/tutorials/tutorials.yml new file mode 100644 index 00000000..59986be3 --- /dev/null +++ b/docs/src/fancycore/tutorials/tutorials.yml @@ -0,0 +1,2 @@ +order: 7 +icon: mortar-board \ No newline at end of file