Add docs

docs/Dockerfile

@@ -0,0 +1,8 @@
+FROM mcr.microsoft.com/dotnet/sdk:7.0 AS builder
+WORKDIR /build
+COPY . /build
+RUN dotnet tool install retypeapp --tool-path /bin
+RUN retype build --output .docker-build/
+
+FROM httpd:latest
+COPY --from=builder /build/.docker-build/ /usr/local/apache2/htdocs/

docs/README.md

@@ -0,0 +1,10 @@
+# Documentation
+
+Here is the documentation for all plugins and libraries located. The documentation is written in Markdown and is rendered using [Retype](https://retype.com/).
+
+## Run locally
+
+```bash
+npm install retypeapp --global
+retype start
+```

docs/retype.yml

@@ -0,0 +1,41 @@
+input: src
+output: .retype
+url: https://fancyinnovations.com
+branding:
+  title: Fancy Innovations
+  logo: /static/favicon.png
+favicon: /static/favicon.png
+links:
+- text: Home
+  icon: home
+  link: /
+- text: Website
+  icon: globe
+  link: https://fancyinnovations.com
+- text: Download
+  icon: download
+  link: https://modrinth.com/user/oliver
+- text: GitHub
+  icon: mark-github
+  link: https://github.com/fancyinnovations
+- text: Discord
+  icon: megaphone
+  link: https://discord.gg/ZUgYCEJUEx
+- text: Blog
+  icon: rss
+  link: blog
+footer:
+  copyright: "© Copyright {{ year }}. All rights reserved."
+  links:
+    - text: Website
+      icon: globe
+      link: https://fancyinnovations.com
+    - text: GitHub
+      icon: mark-github
+      link: https://github.com/fancyinnovations
+    - text: Discord
+      icon: megaphone
+      link: https://discord.gg/ZUgYCEJUEx
+    - text: Blog
+      icon: rss
+      link: blog

docs/src/blog/the-story-about-fancynpcs.md

@@ -0,0 +1 @@
+# The story about FancyNpcs

docs/src/fancynpcs/api/api.md

@@ -0,0 +1,6 @@
+---
+redirect: getting-started.md
+icon: code
+order: 6
+---
+# API usage

docs/src/fancynpcs/commands/commands.md

@@ -0,0 +1,5 @@
+---
+order: 9
+icon: command-palette
+redirect: npc.md
+---

docs/src/fancynpcs/commands/fancynpcs.md

@@ -0,0 +1,25 @@
+---
+order: 9
+---
+
+# /FancyNpcs
+
+### Version
+
+- **Syntax**:  `/fancynpcs version`
+- **Permissions**: `fancynpcs.command.fancynpcs.version`
+
+### Feature Flags
+
+- **Syntax**:  `/fancynpcs feature_flags`
+- **Permissions**: `fancynpcs.command.fancynpcs.feature_flags`
+
+### Reload
+
+- **Syntax**:  `/fancynpcs reload`
+- **Permissions**: `fancynpcs.command.fancynpcs.reload`
+
+### Save
+
+- **Syntax**:  `/fancynpcs save`
+- **Permissions**: `fancynpcs.command.fancynpcs.save`

docs/src/fancynpcs/commands/npc.md

@@ -0,0 +1,261 @@
+---
+order: 10
+---
+
+# /Npc
+
+The `/npc` command is the main command for managing NPCs. It allows you to create, modify, and remove NPCs. You can also customize NPCs by changing their type, skin, equipment, and more.
+
+## Manage npcs
+
+### Help about commands
+
+Shows help about all commands.
+
+- **Syntax**:  `/npc help [page]`
+- **Permissions**: `fancynpcs.command.npc.help`
+
+### Create npc
+
+Creates a new NPC. Can be customized with flags.
+
+- **Syntax**: `/npc create (name) [--position (x y z)] [--world (world)] [--type (type)]`
+- **Permissions**: `fancynpcs.command.npc.create`
+- Name check is now more strict and only allows `A-Z a-z 0-9 _ - /` characters.
+
+### Copy npc
+
+Copies (duplicates) specified NPC.
+
+- **Syntax**: `/npc copy (npc) (new_name)`
+- **Permissions**: `fancynpcs.command.npc.copy`
+- Name check is now more strict and only allows `A-Z a-z 0-9 _ - /` characters.
+
+### Remove npc
+
+Removes the specified NPC.
+
+- **Syntax**: `/npc remove (npc)`
+- **Permissions**: `fancynpcs.command.npc.remove`
+
+### List all npcs
+
+Lists all NPCs in all worlds. Can be filtered and sorted.
+
+- **Syntax**:  `/npc list [--type (type)] [--sort (sort)]`
+- **Permissions**: `fancynpcs.command.npc.list`
+
+### Get npc information
+
+Shows information about specified NPC.
+
+- **Syntax**:  `/npc info (npc)`
+- **Permissions**: `fancynpcs.command.npc.info`
+
+
+## Customize npcs
+
+### Set type
+
+Changes the type of the NPC.
+
+- **Syntax**:  `/npc type (npc) (type)`
+- **Permissions**: `fancynpcs.command.npc.type`
+
+### Set display name
+
+Changes displayname of the NPC. Supports MiniMessage, PlaceholderAPI and MiniPlaceholders.
+
+- **Syntax**:  `/npc displayname (npc) (@none | name)`
+- **Permissions**: `fancynpcs.command.npc.displayname`
+- Empty message placeholder is `@none`
+
+### Set skin
+
+Changes skin of the NPC.
+
+- **Syntax**:  `/npc skin (npc) (@none | @mirror | name | url | file name) [--slim]`
+
+``@none`` - Removes skin.
+
+``@mirror`` - Mirrors the skin of the player viewing the npc.
+
+``name`` / ``uuid`` - Changes skin to the specified player's skin.
+
+``url`` - Changes skin to the specified URL. The URL must point to a valid skin-image.
+
+``file name`` - Changes skin to the specified image. The image must be located in the ``plugins/FancyNpcs/skins``
+directory. Please only provide the file name (e. g. "cool-skin.png").
+
+``--slim`` - Only works for skins set by an URL or file.
+
+- **Permissions**: `fancynpcs.command.npc.skin`
+
+### Set equipment
+
+``set`` - Sets equipment slot of the NPC to item currently held in main hand, none or a specific item type.
+
+``clear`` - Clears equipment slot of the NPC.
+
+``list`` - Lists all equipment slots of the NPC.
+
+- **Syntax**: `/npc equipment (npc) (set | clear | list)`
+- **Permissions**: `fancynpcs.command.npc.equipment.(sub)`
+- Accepts either `@none`, `@hand` or valid item type as an argument.
+
+### Toggle glowing
+
+Changes glowing state and color of the NPC.
+
+- **Syntax**:  `/npc glowing (npc) [disabled | color]`
+- **Permissions**: `fancynpcs.command.npc.glowing`
+
+### Show npc in tab
+
+Changes whether the NPC is shown in the player-list. This works only on NPCs of PLAYER type.
+
+Re-connecting to the server might be required for changes to take effect.
+
+- **Syntax**:  `/npc show_in_tab (npc) [state]`
+- **Permissions**: `fancynpcs.command.npc.show_in_tab`
+
+### Toggle collidable
+
+Changes whether the NPC can collide with other entities.
+
+- **Syntax**:  `/npc collidable (npc) [state]`
+- **Permissions**: `fancynpcs.command.npc.collidable`
+
+### Edit size
+
+Changes the scale of the size of the NPC.
+
+- **Syntax**:  `/npc scale (npc) (factor)`
+- **Permissions**: `fancynpcs.command.npc.scale`
+
+### Set attributes
+
+Sets an attribute of the NPC.
+
+- **Syntax**:  `/npc attribute (npc) (set | list)`
+- **Permissions**: `fancynpcs.command.npc.attribute.(sub)`
+
+## Npc location and rotation
+
+### Turn npc to player
+
+Changes whether the NPC should turn to the player when in range.
+
+- **Syntax**:  `/npc turn_to_player (npc) [state]`
+- **Permissions**: `fancynpcs.command.npc.turn_to_player`
+
+### Move npc to your location
+
+Teleports specified NPC to your location.
+
+- **Syntax**:  `/npc move_here (npc)`
+- **Permissions**: `fancynpcs.command.npc.move_to`
+
+### Move npc to a location
+
+Teleports NPC to specified location.
+
+- **Syntax**:  `/npc move_to (npc) (x) (y) (z) [world] [--look-in-my-direction]`
+- **Permissions**: `fancynpcs.command.npc.move_to`
+
+### Show nearby npcs
+
+Lists all NPCs in your world. Can be filtered and sorted.
+
+- **Syntax**:  `/npc nearby [--radius (radius)] [--type (type)] [--sort (sort)]`
+- **Permissions**: `fancynpcs.command.npc.nearby`
+
+### Teleport to npc
+
+Teleports you to the specified NPC.
+
+- **Syntax**:  `/npc teleport (npc)`
+- **Permissions**: `fancynpcs.command.npc.teleport`
+- Now **teleports sender** to the NPC. Teleportng **the NPC** to specified location is now handled by `/npc move_to`
+  command.
+
+## Manage interactions
+
+### Add action
+
+Adds an action to the specified NPC's trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) add (actionType) [value]`
+- **Permissions**: `fancynpcs.command.npc.action.add`
+
+### Add action before
+
+Adds an action before the specified index in the NPC's action list for the given trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) add_before (index) (actionType) [value]`
+- **Permissions**: `fancynpcs.command.npc.action.addBefore`
+
+### Add action after
+
+Adds an action after the specified index in the NPC's action list for the given trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) add_after (index) (actionType) [value]`
+- **Permissions**: `fancynpcs.command.npc.action.addAfter`
+
+### Set action
+
+Sets an action at the specified number in the NPC's action list for the given trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) set (number) (actionType) [value]`
+- **Permissions**: `fancynpcs.command.npc.action.set`
+
+### Remove action
+
+Removes an action from the NPC's action list based on the specified number for the given trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) remove (number)`
+- **Permissions**: `fancynpcs.command.npc.action.remove`
+
+### Move action up
+
+Moves the action at the specified number up in the NPC's action list for the given trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) move_up (number)`
+- **Permissions**: `fancynpcs.command.npc.action.moveUp`
+
+### Move action down
+
+Moves the action at the specified number down in the NPC's action list for the given trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) move_down (number)`
+- **Permissions**: `fancynpcs.command.npc.action.moveDown`
+
+### Clear actions
+
+Clears all actions from the NPC for the given trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) clear`
+- **Permissions**: `fancynpcs.command.npc.action.clear`
+
+### List actions
+
+Lists all actions for the specified NPC and trigger.
+
+- **Syntax**: `/npc action (npc) (trigger) list`
+- **Permissions**: `fancynpcs.command.npc.action.list`
+
+### Interaction cooldown
+
+Changes duration between interactions (cooldown) of the NPC.
+
+- **Syntax**:  `/npc interaction_cooldown (npc) (disabled | cooldown)`
+- **Permissions**: `fancynpcs.command.npc.interaction_cooldown`
+- Formerly known as `/npc interactionCooldown`.
+- Uses time duration instead of a number of seconds eg. `2min`. Supported units:
+    - milliseconds: `ms`
+    - seconds: `s`
+    - minutes: `min`
+    - hours: `h`
+    - days: `d`
+    - months: `mo`
+    - years: `y`

docs/src/fancynpcs/fancynpcs.md

@@ -0,0 +1,24 @@
+---
+title: FancyNpcs
+icon: accessibility
+expanded: true
+order: 2
+---
+
+#
+
+![](/static/fancynpcs/banner.png)
+
+!!!
+Simple, lightweight and feature-rich NPC plugin for Paper and Folia servers using packets.
+!!!
+
+## Features
+
+With this plugin you can create fancy looking NPCs with ease. You can customize properties like:
+- **Type** (Player, Cow, Pig, Zombie, etc.)
+- **Skin** (Username, UUID, URL or File)
+- **Glowing** (in all colors)
+- **Equipment** (Helmet, Chestplate, Leggings, Boots, Hand and Offhand)
+- **Interact** (Commands, Messages, Actions)
+- **Attributes** (Pose, Variants, Visibility, etc.)

docs/src/fancynpcs/faq.md

@@ -0,0 +1,22 @@
+---
+order: 7
+icon: book
+---
+# FAQ
+
+### Does FancyNpcs support Shopkeepers?
+
+- There is no official integration or addon for Shopkeepers
+- But you can use the "/shopkeeper remote" as console_command actions
+- Example `/npc action MY_NPC any_click add console_command shopkeeper remote SHOPKEEPER_ID {player}`
+- SHOPKEEPER_ID: the display name of the shopkeeper
+
+### Does FancyNpcs support ModelEngine 4?
+
+No, currently there is no support for ModelEngine 4 or any other model engine. Since this is a highly requested feature, it might be added in the future (no promises or estimates). Keep an eye on the discord server for updates.
+
+### Can I make the npc move?
+
+FancyNpcs does not have a movement system yet. This is a highly requested feature and might be added in the future. Keep an eye on the discord server for updates.
+
+We already made plans for a waypoint system, but it is not yet implemented. If you have any suggestions or ideas, feel free to share them on the discord server.

docs/src/fancynpcs/getting-started.md

@@ -0,0 +1,35 @@
+---
+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 FancyNpcs, 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/fancynpcs/versions)
+
+[!button size="s" icon="download" iconAlign="left" text="Hangar" target="blank"](https://hangar.papermc.io/Oliver/FancyNpcs/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 `/fancynpcs version`. If the plugin is installed correctly, it will show you the version of the plugin.
+
+## Create your first npc
+
+1. To create your first npc, you can use the command `/npc create myNpc`. This will create a new npc with the given name.
+2. To edit the display name, you can use the command `/npc displayname myNpc <green>My first npc</green>`.
+3. To edit the skin of the npc, you can use the command `/npc skin myNpc Notch`.
+4. To move the npc to your current location, you can use the command `/npc move_here myNpc`.
+
+!!!
+You can use MiniMessages in the display name to format the text. For more information about MiniMessages, you can visit the [MiniMessage documentation](https://docs.advntr.dev/minimessage/format.html).
+!!!

docs/src/fancynpcs/tutorials/mineskin-api-key.md

@@ -0,0 +1,16 @@
+# MineSkin API Key
+
+When you have many npcs with skins (especially skins by file or url), you will notice that it takes a while once they
+are all loaded. The reason for that is the rate-limit by MineSkin. We use MineSkin to generate the necessary skin data.
+At the moment they have a limit of **10 skins per minute**. Using an MineSkin API Key does increase the limit to **30
+skins per minute**. So if you have many skins, I recommend to get a MineSkin API key and use it.
+
+### How to get a MineSkin API Key
+
+1. Login on the [MineSkin Website](https://account.mineskin.org/keys/)
+2. Click on the plus icon to create a new key
+3. Give the key a name (can be anything)
+4. Copy the key
+5. Open the `plugins/FancyNpcs/config.yml` config file
+6. Set the key at `mineskin_api_key`
+7. Restart the Minecraft server

docs/src/fancynpcs/tutorials/multiple-lines.md

@@ -0,0 +1,12 @@
+# Multiple display name lines
+
+To have multiple lines as the display name of an NPC follow the following steps:
+
+1. Download the [FancyHolograms](https://modrinth.com/plugin/fancyholograms/versions) plugin and put it in the `plugins`
+   folder
+2. Start your server and make sure the FancyNpcs and FancyHolograms plugin have both loaded
+3. Create a hologram with multiple lines
+4. Create a npc
+5. Link the hologram with the npc `/hologram edit <hologram> linkWithNpc <npc>`
+6. You can now move the npc around and the hologram will always follow
+7. To unlink simply run `/hologram edit <hologram> unlinkWithNpc`

docs/src/fancynpcs/tutorials/sitting-npcs.md

@@ -0,0 +1,9 @@
+# Sitting NPCs
+
+You can make a NPC sit by following these steps:
+
+1. Create a NPC
+2. Make sure the type is PLAYER (`/npc type <npc> PLAYER`)
+3. Run `/npc attribute <npc> pose sitting`
+
+You can make the npc stand again by running `/npc attribute <npc> pose standing`

docs/src/fancynpcs/tutorials/tutorials.md

@@ -0,0 +1,7 @@
+---
+order: 8
+icon: mortar-board
+---
+# Tutorials
+
+In this section you will find many tutorials for specific use cases and examples of how to use FancyNPCs. If you have any suggestions for tutorials, please let us know on our discord server.

docs/src/fancynpcs/tutorials/using-minimessages.md

@@ -0,0 +1,13 @@
+# Using MiniMessages
+
+Everywhere, where you can set a text (e.g. npc display_name or hologram lines), you can either use legacy color codes (
+&a &6 &l ...) or the MiniMessage format.
+
+MiniMessage is a format that allows you to use a more advanced formatting system. It supports gradients, hover events,
+click events, and more.
+
+### Links
+
+MiniMessage docs: [https://docs.advntr.dev/minimessage/format.html](https://docs.advntr.dev/minimessage/format.html)
+
+MiniMessage viewer: [https://webui.advntr.dev/](https://webui.advntr.dev/)

docs/src/index.md

@@ -0,0 +1,6 @@
+---
+icon: home
+---
+# Welcome
+
+Welcome to the Fancy Innovations documentation! This is the place where you can find all the information you need to get started with our products.