Fancy Innovations

https://docs.fancyinnovations.com/
Admin
Fancy Innovations offers a collection of tools and plugins, likely for Minecraft, that enable...
Tokens:23,908
Snippets:225
Trust Score:4.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Fancy NPCs Plugin

Source: https://docs.fancyinnovations.com/fancynpcs/getting-started

Instructions for installing the Fancy NPCs plugin. Download the plugin file from Modrinth or Hangar and place it in the server's plugins folder. Restart the server to complete the installation.

```text
1. Download the latest Fancy NPCs plugin version from Modrinth or Hangar.
2. Place the downloaded .jar file into the `/plugins` folder of your Minecraft server.
3. Restart your server.
```

--------------------------------

### Show Notice Dialog (Java)

Source: https://docs.fancyinnovations.com/fancydialogs/api/getting-started

Examples of how to display a simple notice dialog to a Minecraft player using the FancyDialogs API. Supports both a static and an instance-based method.

```java
new NoticeDialog("title", "message").show(player);
// or
NoticeDialog.show(player, "message");
```

--------------------------------

### Verify Fancy NPCs Plugin Installation

Source: https://docs.fancyinnovations.com/fancynpcs/getting-started

Command to check if the Fancy NPCs plugin is installed correctly on the server. This command will output the plugin's version if it's successfully loaded.

```minecraft
/fancynpcs version
```

--------------------------------

### Create and Configure First NPC with Commands

Source: https://docs.fancyinnovations.com/fancynpcs/getting-started

Commands to create, rename, change skin, and move your first NPC. Supports MiniMessages for display name formatting. Requires the Fancy NPCs plugin to be installed.

```minecraft
/npc create myNpc
```

```minecraft
/npc displayname myNpc <green>My first npc</green>
```

```minecraft
/npc skin myNpc Notch
```

```minecraft
/npc move_here myNpc
```

--------------------------------

### Project Setup

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

Instructions on how to include the FancyNpcs API in your project using Gradle or Maven.

```APIDOC
## Project Setup

### Description
Instructions on how to include the FancyNpcs API in your project using Gradle or Maven.

### Gradle

```
repositories {
    maven("https://repo.fancyinnovations.com/releases")
}

dependencies {
    compileOnly("de.oliver:FancyNpcs:VERSION")
}
```

### Maven

```xml
<repository>
    <id>fancyinnovations-releases</id>
    <name>FancyInnovations Repository</name>
    <url>https://repo.fancyinnovations.com/releases</url>
</repository>

<dependency>
    <groupId>de.oliver</groupId>
    <artifactId>FancyNpcs</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>
```

**Note:** Replace `VERSION` with the desired API version.
```

--------------------------------

### Show Confirmation Dialog (Java)

Source: https://docs.fancyinnovations.com/fancydialogs/api/getting-started

This Java code demonstrates how to present a confirmation dialog to a player, allowing them to choose to confirm or cancel an action. It includes callbacks for both outcomes.

```java
new ConfirmationDialog("Are you sure you want to reload the configuration?")
    .withTitle("Confirm reload")
    .withOnConfirm(() -> player.sendMessage("Reloading configuration..."))
    .withOnCancel(() -> player.sendMessage("Reload cancelled."))
    .ask(player);
```

--------------------------------

### Install FancyHolograms Plugin

Source: https://docs.fancyinnovations.com/fancyholograms/getting-started

Instructions for installing the FancyHolograms plugin. This involves downloading the plugin file from Modrinth or Hangar and placing it in the server's 'plugins' folder. A server restart is required after installation.

```plaintext
1. Download the latest version from Modrinth or Hangar.
2. Place the downloaded file in the `plugins` folder of your Minecraft server.
3. Restart your server.
```

--------------------------------

### Add FancyDialogs API Dependency (Gradle)

Source: https://docs.fancyinnovations.com/fancydialogs/api/getting-started

This snippet shows how to add the FancyDialogs API as a dependency in your Gradle project. It configures the repository to fetch the library and adds the compileOnly dependency.

```gradle
repositories {
    maven("https://repo.fancyinnovations.com/releases")
}

dependencies {
    compileOnly("de.oliver:FancyDialogs:VERSION")
}
```

--------------------------------

### Verify FancyHolograms Installation

Source: https://docs.fancyinnovations.com/fancyholograms/getting-started

Command to verify if the FancyHolograms plugin has been installed correctly. Executing this command in-game or via the server console will display the plugin's version if it's properly installed and loaded.

```bash
/fancyholograms version
```

--------------------------------

### Add FancyDialogs API Dependency (Maven)

Source: https://docs.fancyinnovations.com/fancydialogs/api/getting-started

This snippet demonstrates how to include the FancyDialogs API in your Maven project. It configures the custom repository and adds the dependency with a 'provided' scope.

```xml
<repository>
    <id>fancyinnovations-releases</id>
    <name>FancyInnovations Repository</name>
    <url>https://repo.fancyinnovations.com/releases</url>
</repository>

<dependency>
    <groupId>de.oliver</groupId>
    <artifactId>FancyDialogs</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>
```

--------------------------------

### Create a new hologram

Source: https://docs.fancyinnovations.com/fancyholograms/api/getting-started

A step-by-step guide on how to create and register a new hologram using the FancyHolograms API.

```APIDOC
## Create a new hologram

### Description
This section details the process of creating, configuring, and registering a hologram.

### 1. Create the hologram data
Use `TextHologramData` (or `ItemHologramData`, `EntityHologramData`) to define hologram properties.

```java
// Example for TextHologramData
Location location = ...; // Define the hologram's location
TextHologramData hologramData = new TextHologramData("hologram_name", location);
hologramData.setBackground(TextColor.color(100, 255, 79));
hologramData.setBillboard(Display.Billboard.FIXED);
```

### 2. Create the hologram
Utilize the `HologramManager` to create the hologram instance from the data.

```java
HologramManager manager = FancyHologramsPlugin.get().getHologramManager();
Hologram hologram = manager.create(hologramData);
```

### 3. Register the hologram
Add the created hologram to the `HologramManager` to enable persistence and automatic handling.

```java
manager.addHologram(hologram);

// To make the hologram non-persistent:
hologram.setPersistent(false);
```
```

--------------------------------

### Initialize ApiClient for Java SDK

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/java-sdk

Example of initializing the ApiClient for the FancyAnalytics Java SDK. This client is used to interact with the FancyAnalytics API. Requires the API endpoint, an empty string for a tenant ID, and your API token.

```java
ApiClient fancyAnalytics = new ApiClient("https://api.fancyanalytics.net", "", "YOUR API TOKEN");
```

--------------------------------

### Command: Set NPC Attributes (Command Line)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Demonstrates commands for setting various attributes on NPCs, including pose, glowing color, and more. Examples cover sitting pose, glowing color, and general attribute management.

```bash
/npc attribute pose sitting
/npc glowingColor (npc) (color)
```

--------------------------------

### Initialize FancyAnalytics API for Minecraft Plugins

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/minecraft-plugins

Initialize the FancyAnalytics API within your Minecraft plugin using your project ID and API token. Register Minecraft plugin metrics and call the initialize method to start data collection.

```java
FancyAnalyticsAPI fancyAnalytics = new FancyAnalyticsAPI("project-id", "api-token");
fancyAnalytics.registerMinecraftPluginMetrics();
fancyAnalytics.initialize();
```

--------------------------------

### Example Alert Conditions

Source: https://docs.fancyinnovations.com/fancyanalytics/features/alerts

Illustrates various conditions that can be monitored by the Fancy Innovations alert system, including metrics, events, errors, and logs.

```plaintext
metrics — e.g. `cpu_usage_percent > 90`
events — e.g. `event == 'minecraft_server_crashed'`
errors — e.g. `5+ errors in 10s`
logs — e.g. `ERROR logs > 10 in 1 minute`
```

--------------------------------

### Send Events with Java SDK

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/java-sdk

Example of sending events using the FancyAnalytics Java SDK. Creates an 'Event' object with a name and properties, then sends it via the event service. Useful for tracking user interactions or application occurrences.

```java
Event event = new Event("event name", new HashMap<>());
event.withProperty("prop key", "prop value");

fancyAnalytics.getEventService().createEvent("project id", event);
```

--------------------------------

### Open Dialog NPC Action - FancyNpcs

Source: https://docs.fancyinnovations.com/fancydialogs/tutorials/open-dialog-npc-action

This action allows opening a dialog when interacting with an NPC, requiring both FancyDialogs and FancyNpcs plugins to be installed. The action is added to an NPC's behavior using a specific command.

```minecraft-commands
/npc action (npc) ANY_CLICK add open_dialog (dialogId)
```

--------------------------------

### Example FancyDialogs JSON Schema

Source: https://docs.fancyinnovations.com/fancydialogs/tutorials/json-schema

This is a sample JSON object demonstrating the structure and fields required to define a simple dialog using the FancyDialogs schema. It includes fields for dialog identification, title, closability, body content, input fields, and buttons with associated actions.

```json
{
  "id": "my_dialog",
  "title": "My Fancy Dialog",
  "canCloseWithEscape": true,
  "body": [
    { "text": "This is my first dialog created with FancyDialogs!" }
  ],
  "inputs": {
    "textFields": [
      {
        "key": "fav_color",
        "order": 1,
        "label": "<color:#ff7300>What is your favorite color?</color>",
        "placeholder": "gold",
        "maxLength": 50,
        "maxLines": 1
      }
    ]
  },
  "buttons": [
    {
      "label": "Show favorite color",
      "tooltip": "Click to show your favorite color",
      "actions": [
        {
          "name": "message",
          "data": "Your favorite color is: <color:{fav_color}>{fav_color}</color>"
        }
      ]
    }
  ]
}
```

--------------------------------

### Link Hologram with NPC using FancyHolograms

Source: https://docs.fancyinnovations.com/fancynpcs/tutorials/multiple-lines

This guide explains how to link a multi-line hologram with an NPC using the FancyHolograms plugin. Ensure both FancyNpcs and FancyHolograms plugins are loaded. The process involves creating a hologram, creating an NPC, and then linking them using a command.

```command
/hologram edit <hologram> linkWithNpc <npc>
```

```command
/hologram edit <hologram> unlinkWithNpc
```

--------------------------------

### Commit Message Format Example

Source: https://docs.fancyinnovations.com/development-guidelines/monorepo

This snippet demonstrates the required format for commit messages within the monorepo. It specifies a scope for the affected component and a short description of the change, ensuring consistency in version control.

```git-commit
<scope>: <short description>
```

```git-commit
fancynpcs: Fix NPE in teleport command
```

--------------------------------

### Register Custom Number and String Metrics with FancyAnalytics

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/minecraft-plugins

Send custom metrics to the FancyAnalytics server from your Minecraft plugin. This example shows how to register a number metric for NPC count and a string metric for the current language. Ensure metric names match those defined on the website.

```java
// Register a number metric to track the amount of npcs
fancyAnalytics.registerNumberMetric(new MetricSupplier<>("amount_npcs", () -> npcManager.getNpcs().size()));

// Register a string metric to track the used language
fancyAnalytics.registerStringMetric(new MetricSupplier<>("language", () -> languageManager.getLanguage()));
```

--------------------------------

### Get and Modify an Existing NPC

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

This Java code demonstrates how to retrieve an existing NPC by its name and modify its properties. It includes fetching the NPC object, accessing its data, updating display name and skin, and then updating the NPC for all players.

```java
Npc npc = FancyNpcsPlugin.get().getNpcManager().getNpc("myNpc");
NpcData data = npc.getData();

data.setDisplayName("<green>new displayname</green>");
data.setSkin("https://url-to-skin.com/skin.png");

pc.updateForAll();
```

--------------------------------

### API: Get NPC by ID (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Provides a method to retrieve an NPC instance using its unique identifier. This is useful for interacting with specific NPCs programmatically within the plugin or as a library.

```java
NpcManager#getNpcById
```

--------------------------------

### JavaDocs and Support

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

Information on accessing JavaDocs and seeking help.

```APIDOC
## JavaDocs and Support

### Description
Information on accessing JavaDocs and seeking help.

### JavaDocs

Access the JavaDocs for the FancyNpcs API here: [Link to JavaDocs]

### Support

Join the FancyInnovations Discord for help and support, particularly in the `#npcs-api` channel.
```

--------------------------------

### Create New NPC

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

Steps to create and register a new NPC using the FancyNpcs API.

```APIDOC
## Create New NPC

### Description
Steps to create and register a new NPC using the FancyNpcs API.

### 1. Create NPC Data

```java
// Replace creatorUUID and location with actual values
NpcData data = new NpcData("myNpc", creatorUUID, location);
data.setSkin("OliverHD"); // Use skin of the player OliverHD
data.setDisplayName("<red>cool displayname</red>");
```

### 2. Create NPC Instance

```java
Npc npc = FancyNpcsPlugin.get().getNpcAdapter().apply(data);
```

### 3. Register NPC

**Important:** Do not register NPCs immediately after server start. Wait at least 10 seconds or listen for `NpcsLoadedEvent`.

```java
FancyNpcsPlugin.get().getNpcManager().registerNpc(npc);
```

To prevent persistence:

```java
pc.setSaveToFile(false);
```

### 4. Spawn NPC for all players

```java
pc.create();
pc.spawnForAll();
```
```

--------------------------------

### Get and Modify an Existing Hologram in Java

Source: https://docs.fancyinnovations.com/fancyholograms/api/getting-started

Retrieve a hologram by its unique name using the HologramManager. Once obtained, you can modify its associated HologramData, such as changing the billboard type or text alignment, and then apply these changes.

```java
HologramManager manager = FancyHologramsPlugin.get().getHologramManager();
Hologram hologram = manager.getHologram("hologram_name").orElse(null);
if (hologram == null) {
    // hologram not found
    return;
}

HologramData hologramData = hologram.getData();
hologramData.setBillboard(Display.Billboard.CENTER);

if (hologramData instanceof TextHologramData textData) {
        textData.setTextAlignment(TextDisplay.TextAlignment.LEFT);
}

hologram.forceUpdate();
```

--------------------------------

### Create and Register an NPC

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

This Java code illustrates the process of creating a new NPC using the FancyNPCs API. It covers creating NPC data, instantiating the NPC using the adapter, and registering it with the NPC manager.

```java
NpcData data = new NpcData("myNpc", creatorUUID, location);
data.setSkin("OliverHD"); // use skin of the player OliverHD
data.setDisplayName("<red>cool displayname</red>");

Npc npc = FancyNpcsPlugin.get().getNpcAdapter().apply(data);
FancyNpcsPlugin.get().getNpcManager().registerNpc(npc);

// Ensure not to register immediately after server start. Wait at least 10 seconds or use NpcsLoadedEvent.
// To prevent persistence:
// npc.setSaveToFile(false);
```

--------------------------------

### Open Quick Actions Dialog Command

Source: https://docs.fancyinnovations.com/fancydialogs/commands/quickactions

Opens the quick actions dialog for players to perform actions. Requires the 'fancydialogs.commands.quickactions' permission.

```minecraft
/quickactions
/qa
```

--------------------------------

### Minecraft Plugin Configuration (YAML)

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/minecraft-servers

Configuration file for the FancyAnalytics Minecraft plugin. Requires 'project_id' and 'api_key' obtained from the FancyAnalytics website. 'enable_default_events' controls the emission of predefined events.

```yaml
project_id: "your project id"
api_key: "your api key"
enable_default_events: false
```

--------------------------------

### Include Java SDK with Gradle

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/java-sdk

Instructions to add the FancyAnalytics Java SDK to a Gradle project. Requires configuring the repository and adding the SDK as a dependency. Ensure the API is shaded into your application.

```gradle
repositories {
    maven("https://repo.fancyinnovations.com/releases")
}

dependencies {
    implementation("de.oliver.fancyanalytics:java-sdk:VERSION")
}
```

--------------------------------

### Include the API in your project

Source: https://docs.fancyinnovations.com/fancyholograms/api/getting-started

Instructions on how to add the FancyHolograms API dependency to your project using Gradle or Maven.

```APIDOC
## Include the API in your project

### Description
Add the FancyHolograms API dependency to your `build.gradle.kts` or `pom.xml` file.

### Gradle
```kotlin
repositories {
    maven("https://repo.fancyinnovations.com/releases")
}

dependencies {
    compileOnly("de.oliver:FancyHolograms:VERSION")
}
```

### Maven
```xml
<repository>
    <id>fancyinnovations-releases</id>
    <name>FancyInnovations Repository</name>
    <url>https://repo.fancyinnovations.com/releases</url>
</repository>

<dependency>
    <groupId>de.oliver</groupId>
    <artifactId>FancyHolograms</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>
```

**Note:** Replace `VERSION` with the desired API version.
```

--------------------------------

### Execute Server Command with Placeholder

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v1

Allows executing a server command as if typed in the console, with support for player-specific placeholders. Useful for making NPCs interact with the game world or players in custom ways. This command replaces the older '/npc command'.

```plaintext
/npc serverCommand testNpc say Hello, {player}!
```

--------------------------------

### PlaceholderAPI Integration

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Adds support for PlaceholderAPI, allowing developers to utilize placeholders within NPC messages and interactions. This enhances dynamic content and information display.

```java
// Example of PlaceholderAPI integration in FancyNpcs
public class PlaceholderHook extends PlaceholderExpansion {
    @Override
    public String onPlaceholderRequest(Player player, String identifier) {
        if (identifier.equals("example_placeholder")) {
            return "Some dynamic value";
        }
        return null;
    }
}
```

--------------------------------

### Command: Dynamic Skin Mirroring (Command Line)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Introduces a '/npc mirrorSkin (npcName) (true/false)' command for dynamically controlling skin mirroring on NPCs. This allows for visual adjustments to NPC appearances.

```bash
/npc mirrorSkin (npcName) (true/false)
```

--------------------------------

### Configuring Hologram Text Update Interval

Source: https://docs.fancyinnovations.com/fancyholograms/changelog/v2

This shows examples of how to configure the text update interval for holograms in FancyHolograms. It supports disabling updates with 'never', 'off', or 'none', and allows specifying intervals using seconds ('10s') or minutes ('1m') instead of just raw ticks. This provides more granular control over dynamic text holograms.

```plaintext
never
off
none
10s
1m
```

--------------------------------

### Bug Fix: ShowInTab Not Applying (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Fixes a bug where setting 'showInTab' to false did not take effect immediately for NPCs.

```java
Fixed setting showInTab to false not applying right away
```

--------------------------------

### Spawn an NPC for All Players

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

This Java code snippet shows how to initially spawn a registered NPC for all connected players. It utilizes the `create()` and `spawnForAll()` methods provided by the NPC object.

```java
npc.create();
pc.spawnForAll();
```

--------------------------------

### Create a Text Hologram

Source: https://docs.fancyinnovations.com/fancyholograms/getting-started

Command to create a new text hologram. This command initializes a hologram with a specified name, which can then be further customized with text and other properties.

```bash
/hologram create text myHologram
```

--------------------------------

### Send Metric Data with Java SDK

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/java-sdk

Demonstrates how to send metric data using the FancyAnalytics Java SDK. Creates a 'Record' object with sender ID, project ID, timestamp, and custom entries, then sends it via the record service.

```java
Record record = new Record("unique sender id", "project id", timestamp, new HashMap<>());
record.withEntry("metric name", "metric value");

fancyAnalytics.getRecordService().createRecord("project id", record);
```

--------------------------------

### Include Java SDK with Maven

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/java-sdk

Instructions to add the FancyAnalytics Java SDK to a Maven project. Involves configuring the repository and declaring the dependency. It's crucial to shade the API into your application.

```maven
<repository>
    <id>fancyplugins-releases</id>
    <name>FancyPlugins Repository</name>
    <url>https://repo.fancyinnovations.com/releases</url>
</repository>

<dependency>
    <groupId>de.oliver.FancyAnalytics</groupId>
    <artifactId>java-sdk</artifactId>
    <version>VERSION</version>
</dependency>
```

--------------------------------

### Add FancyNPCs API Dependency (Gradle)

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

This snippet shows how to add the FancyNPCs API as a dependency in your project using Gradle. It includes configuring the Maven repository and adding the compileOnly dependency.

```gradle
repositories {
    maven("https://repo.fancyinnovations.com/releases")
}

dependencies {
    compileOnly("de.oliver:FancyNpcs:VERSION")
}
```

--------------------------------

### Manage NPCs with Fancy Innovations Commands

Source: https://docs.fancyinnovations.com/fancynpcs/commands/npc

This section details the core commands for managing NPCs. It includes commands for creating, copying, removing, listing, and retrieving information about NPCs. Permissions are specified for each command.

```bash
`/npc help [page]`
`/npc create (name) [--position (x y z)] [--world (world)] [--type (type)]`
`/npc copy (npc) (new_name)`
`/npc remove (npc)`
`/npc list [--type (type)] [--sort (sort)]`
`/npc info (npc)`
```

--------------------------------

### API: Include Sources and Javadocs (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Indicates that the API package now includes source code and Javadocs. This aids developers in understanding and utilizing the API effectively by providing direct access to implementation details and documentation.

```java
Include sources and javadocs in api
```

--------------------------------

### Performance: Color and Placeholder Parsing (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Improvements have been made to the performance of parsing colors and placeholders. This leads to faster processing of text elements within the plugin.

```java
Improved color and placeholder parsing performance
```

--------------------------------

### Add FancyHolograms Dependency to Gradle Project

Source: https://docs.fancyinnovations.com/fancyholograms/api/getting-started

Include the FancyHolograms API as a compile-only dependency in your Gradle Kotlin DSL build file. This ensures the API is available at compile time without being bundled into your plugin.

```gradle
repositories {
    maven("https://repo.fancyinnovations.com/releases")
}

dependencies {
    compileOnly("de.oliver:FancyHolograms:VERSION")
}
```

--------------------------------

### Set NPC Skin from URL

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v1

Allows setting an NPC's skin by providing a URL to a Minecraft skin resource. This enables dynamic skin changes for NPCs, enhancing their visual customization. Supports both player and mob NPCs.

```plaintext
/npc skin (npc) (url to skin)
```

--------------------------------

### Manage FancyNpcs Commands

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v1

Provides a central command for managing FancyNpcs plugin functionalities, including version checking, saving NPCs, and reloading configurations. It also allows for moving NPCs to their own configuration file (`npcs.yml`).

```plaintext
/fancynpcs version
```

```plaintext
/fancynpcs save
```

```plaintext
/fancynpcs reload
```

--------------------------------

### Include FancyAnalytics API using Gradle

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/minecraft-plugins

Add the FancyAnalytics API dependency to your Minecraft plugin project using Gradle. This involves configuring the Maven repository and adding the `mc-api` dependency to your build file.

```gradle
repositories {
    maven("https://repo.fancyinnovations.com/releases")
}

dependencies {
    implementation("de.oliver.fancyanalytics:mc-api:VERSION")
}
```

--------------------------------

### Command: NPC Information (Command Line)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Introduces the '/npc info (npc)' command to retrieve information about a specific NPC. This is useful for debugging and understanding NPC properties.

```bash
/npc info (npc)
```

--------------------------------

### Dialog Management API

Source: https://docs.fancyinnovations.com/fancydialogs/commands/dialog

This section covers the API endpoints for managing dialogs, including listing all dialogs and opening a specific dialog for a player.

```APIDOC
## GET /dialog/list

### Description
Lists all registered dialogs.

### Method
GET

### Endpoint
/dialog/list

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "GET /dialog/list"
}
```

### Response
#### Success Response (200)
- **dialogs** (array) - A list of registered dialog IDs.

#### Response Example
```json
{
  "dialogs": [
    "dialog1",
    "dialog2"
  ]
}
```

## POST /dialog/open

### Description
Opens a dialog (for a player) by its ID.

### Method
POST

### Endpoint
/dialog/open

### Parameters
#### Query Parameters
None

#### Request Body
- **id** (string) - Required - The ID of the dialog to open.
- **player** (string) - Optional - The name or UUID of the player to open the dialog for. Defaults to the sender if not specified.

### Request Example
```json
{
  "id": "fancyDialogs",
  "player": "playerName"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the dialog was opened.

#### Response Example
```json
{
  "message": "Dialog 'fancyDialogs' opened for player 'playerName'."
}
```
```

--------------------------------

### Include FancyAnalytics API using Maven

Source: https://docs.fancyinnovations.com/fancyanalytics/getting-started/minecraft-plugins

Add the FancyAnalytics API dependency to your Minecraft plugin project using Maven. This involves configuring the repository and adding the `mc-api` dependency to your POM file. Remember to shade the API into your plugin.

```xml
<repository>
    <id>fancyplugins-releases</id>
    <name>FancyPlugins Repository</name>
    <url>https://repo.fancyinnovations.com/releases</url>
</repository>

<dependency>
    <groupId>de.oliver.FancyAnalytics</groupId>
    <artifactId>mc-api</artifactId>
    <version>VERSION</version>
</dependency>
```

--------------------------------

### Add NPC Copy Command

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Introduces a new command to copy existing NPCs, allowing for easier duplication and management within the game. This functionality enhances the workflow for server administrators.

```plaintext
/npc copy (npc) (new name)
```

--------------------------------

### Multi-Version Support

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

This update revamps the project structure to support multiple Minecraft versions within a single JAR file. It ensures compatibility with both newer (1.19.4, 1.20.1) and older versions of Minecraft.

```java
// Plugin code compiled for multiple Minecraft versions.
// Example: Dependency injection or version-specific logic handling.
public class FancyNpcsPlugin {
    // ... methods to handle different Minecraft versions ...
}
```

--------------------------------

### Send to Server Action for NPCs (Minecraft Plugin)

Source: https://docs.fancyinnovations.com/fancynpcs/tutorials/action-system

Sends the interacting player to a different server within a proxy environment like Velocity. Requires plugin-messaging support.

```plaintext
/npc action (npc) (trigger) add send_to_server skyblock
```

--------------------------------

### Compatibility: Minecraft Version Support (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Updates detailing the addition of support for various Minecraft versions, including 1.19.4, 1.20, 1.20.1, 1.20.2, 1.20.4, 1.20.5, 1.20.6, 1.21, and 1.21.1. This ensures the plugin functions correctly with the latest game updates.

```java
Added support for 1.21.1
Added support for 1.21
Added support for 1.20.5 and 1.20.6
Fix npcs not showing in 1.20.1
Added support for 1.20.2
Added support for 1.20.4
Fixed npc interaction for 1.19.4
Fixed player npcs not spawning in 1.19.4
Added invisible attribute for 1.19.4
```

--------------------------------

### FancyHolograms Folia Support Information

Source: https://docs.fancyinnovations.com/fancyholograms/changelog/v1

Provides critical information for users intending to use the FancyHolograms plugin with the Folia environment. It emphasizes the need for backups due to potential bugs and clarifies that separate JAR files will be provided for Paper and Folia, with the Folia version being incompatible with Paper servers.

```text
Folia support:
Please make backups when using this plugin with Folia. There might accure bugs. In the future there will be two jar files, one for Paper and one for Folia. You can not use the Folia version on a Paper server.
```

--------------------------------

### Command: Manage NPC Messages (Command Line)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Details commands for managing messages displayed by NPCs, including adding, setting, removing, and clearing messages. Supports legacy colors in display names.

```bash
/Npc message (npc name) add (message)
/Npc message (npc name) set (index) (message)
/Npc message (npc name) remove (index)
/Npc message (npc name) clear
```

--------------------------------

### List Dialogs Command - FancyDialogs

Source: https://docs.fancyinnovations.com/fancydialogs/commands/dialog

This command lists all registered dialogs within the Fancy Innovations system. It requires the 'fancydialogs.commands.dialog.list' permission to execute.

```plaintext
/dialog list
```

--------------------------------

### Add FancyHolograms Dependency to Maven Project

Source: https://docs.fancyinnovations.com/fancyholograms/api/getting-started

Integrate the FancyHolograms API into your Maven project by adding the repository and dependency to your pom.xml. The dependency scope is set to 'provided' as it's expected to be available on the server.

```xml
<repository>
    <id>fancyinnovations-releases</id>
    <name>FancyInnovations Repository</name>
    <url>https://repo.fancyinnovations.com/releases</url>
</repository>

<dependency>
    <groupId>de.oliver</groupId>
    <artifactId>FancyHolograms</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>
```

--------------------------------

### Console Command Action for NPCs (Minecraft Plugin)

Source: https://docs.fancyinnovations.com/fancynpcs/tutorials/action-system

Executes a command on the server console when triggered by NPC interaction. Useful for server-side operations. Supports a {player} placeholder for the interacting player's name.

```plaintext
/npc action (npc) (trigger) add console_command give {player} diamond 1
```

--------------------------------

### Metrics API

Source: https://docs.fancyinnovations.com/blog/fa-dev-log-2

Defines how to configure metrics within FancyAnalytics, supporting both push-based and pull-based approaches.

```APIDOC
## POST /api/metrics

### Description
This endpoint allows the creation and configuration of new metrics within FancyAnalytics. You can define whether a metric is push-based or pull-based, and configure associated parameters like aggregation intervals and endpoint URLs.

### Method
POST

### Endpoint
/api/metrics

### Parameters
#### Request Body
- **project_id** (string) - Required - The unique identifier for the project the metric belongs to.
- **metric_id** (string) - Required - A unique identifier for the metric.
- **name** (string) - Required - A human-readable name for the metric.
- **multi_sender** (boolean) - Optional - If true, multiple clients can send data for this metric. Defaults to false.
- **aggregation_interval** (integer) - Optional - The interval in seconds at which data should be aggregated for multi-sender metrics. Defaults to 0.
- **apply_extra_aggregation** (boolean) - Optional - If true, extra aggregation functions (sum, avg, min, max, count) can be applied. Defaults to false.
- **pull_metric** (boolean) - Optional - If true, the metric is pull-based. Defaults to false.
- **pull_interval** (integer) - Optional - The interval in seconds at which FancyAnalytics should request data for pull-based metrics. Defaults to 0.
- **pull_url** (string) - Optional - The URL from which FancyAnalytics should pull data for pull-based metrics. Defaults to an empty string.

### Request Example
```json
{
  "project_id": "FancyNpcs",
  "metric_id": "npc_count",
  "name": "NPC Count",
  "multi_sender": true,
  "aggregation_interval": 300,
  "apply_extra_aggregation": true,
  "pull_metric": false,
  "pull_interval": 0,
  "pull_url": ""
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the metric was created successfully.

#### Response Example
```json
{
  "message": "Metric 'npc_count' created successfully."
}
```
```

--------------------------------

### Compatibility: Paper Plugin (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Announces that FancyNpcs is now a 'paper-plugin'. This indicates a dependency on or optimization for the Paper Minecraft server software.

```java
FancyNpcs is now a paper-plugin
```

--------------------------------

### FancyDialogs Storage Commands

Source: https://docs.fancyinnovations.com/fancydialogs/commands/fancydialogs

Provides commands for managing dialog data storage, including saving, loading, and reloading all dialogs.

```APIDOC
## POST /fancydialogs/storage/save

### Description
Saves all dialog data to the storage.

### Method
POST

### Endpoint
/fancydialogs/storage/save

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "All dialogs saved successfully."
}
```
```

```APIDOC
## POST /fancydialogs/storage/load

### Description
Loads all dialog data from the storage.

### Method
POST

### Endpoint
/fancydialogs/storage/load

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "All dialogs loaded successfully."
}
```
```

```APIDOC
## POST /fancydialogs/storage/reload

### Description
Clears the dialog registry and loads all dialog data from the storage.

### Method
POST

### Endpoint
/fancydialogs/storage/reload

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Dialog registry cleared and all dialogs reloaded successfully."
}
```
```

--------------------------------

### Add FancyNPCs API Dependency (Maven)

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

This snippet demonstrates how to add the FancyNPCs API as a dependency in your project using Maven. It involves configuring the repository and adding the dependency with a provided scope.

```xml
<repository>
    <id>fancyinnovations-releases</id>
    <name>FancyInnovations Repository</name>
    <url>https://repo.fancyinnovations.com/releases</url>
</repository>

<dependency>
    <groupId>de.oliver</groupId>
    <artifactId>FancyNpcs</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>
```

--------------------------------

### Testing Placeholders with PlaceholderAPI

Source: https://docs.fancyinnovations.com/fancynpcs/faq

This command is used to test if a PlaceholderAPI placeholder resolves correctly without player context. It's a requirement for using placeholders as NPC skins in FancyNpcs. The command attempts to parse the placeholder and will output its resolved value or null if it fails.

```minecraft
/papi parse --null %YOUR-PLACEHOLDER%
```

--------------------------------

### Set NPC Skin using New API - Java

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

This code snippet demonstrates how to set an NPC's skin using the updated API in Fancy Innovations. It replaces the older SkinFetcher and supports setting skins via username, UUID, URL, or local filename. Ensure the correct API is used as the old one is deprecated.

```java
npc.getData().setSkin("username / uuid / url / filename");
```

--------------------------------

### Create and Register a Text Hologram in Java

Source: https://docs.fancyinnovations.com/fancyholograms/api/getting-started

This Java code demonstrates how to create a TextHologramData object, configure its properties like background color and billboard, and then use the HologramManager to create and register the hologram within the FancyHolograms system.

```java
TextHologramData hologramData = new TextHologramData("hologram_name", location);
hologramData.setBackground(TextColor.color(100, 255, 79));
hologramData.setBillboard(Display.Billboard.FIXED);

HologramManager manager = FancyHologramsPlugin.get().getHologramManager();
Hologram hologram = manager.create(hologramData);
manager.addHologram(hologram);
```

--------------------------------

### Bug Fix: Problems with Skins (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Addresses and resolves various problems that were occurring with NPC skin loading and display.

```java
Fixed problems with skins
```

--------------------------------

### Bug Fix: MiniPlaceholders Support (Java)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Corrects issues related to the integration and support of the MiniPlaceholders plugin, ensuring placeholder functionality works as expected.

```java
Fixed MiniPlaceholders support
```

--------------------------------

### Create Interaction NPC with FancyNpcs

Source: https://docs.fancyinnovations.com/fancyholograms/tutorials/clickable-holograms

This snippet demonstrates how to create an NPC of type 'INTERACTION' using the FancyNpcs plugin. This is a prerequisite for making holograms clickable by using the NPC's interaction capabilities to trigger actions.

```minecraft-commands
/npc type (npc name) INTERACTION
```

```minecraft-commands
/npc displayname (npc name) <empty>
```

```minecraft-commands
/npc attributes (npc name) set (width/height) (size)
```

--------------------------------

### /Hologram - Manage Holograms

Source: https://docs.fancyinnovations.com/fancyholograms/commands/hologram

Commands for managing holograms, including listing, creating, removing, and viewing information about them.

```APIDOC
## /Hologram - Manage Holograms

### Description
Commands for managing holograms, including listing, creating, removing, and viewing information about them.

### Commands

#### help
- **Description**: Shows a list of all subcommands.
- **Syntax**: `/Hologram help`
- **Permission**: `FancyHolograms.admin`

#### list
- **Description**: Shows a list of all holograms.
- **Syntax**: `/Hologram list`
- **Permission**: `FancyHolograms.admin`

#### nearby
- **Description**: Shows all holograms nearby you in a range.
- **Syntax**: `/Hologram nearby <range>`
- **Permission**: `FancyHolograms.admin`

#### create
- **Description**: Creates a new hologram at your location.
- **Syntax**: `/Hologram create (type) (name)`
- **Permission**: `FancyHolograms.admin`

#### remove
- **Description**: Removes a certain hologram.
- **Syntax**: `/Hologram remove (hologram)`
- **Permission**: `FancyHolograms.admin`

#### copy
- **Description**: Creates a copy of a hologram.
- **Syntax**: `/Hologram copy (hologram) (new name)`
- **Permission**: `FancyHolograms.admin`

#### info
- **Description**: Shows you all information about the hologram.
- **Syntax**: `/Hologram info (hologram)`
- **Permission**: `FancyHolograms.admin`
```

--------------------------------

### FancyNpcs Plugin Configuration Options

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v1

Highlights key configuration options for the FancyNpcs plugin, controlling NPC behavior and plugin functionality. These settings can be adjusted in the `config.yml` file and are enabled by default.

```yaml
turn_to_player_distance: 5
visibility_distance: 20
enable_autosave: true
```

--------------------------------

### Message Action for NPCs (Minecraft Plugin)

Source: https://docs.fancyinnovations.com/fancynpcs/tutorials/action-system

Sends a customizable message to the player interacting with the NPC. Supports PlaceholderAPI for dynamic content. This action is part of the FancyNPCs plugin.

```plaintext
/npc action (npc) (trigger) add message <green>Hi, <b>%player_name%</b>! Welcome to our server!</green>
```

--------------------------------

### FancyHolograms Convert Command

Source: https://docs.fancyinnovations.com/fancyholograms/commands/fancyholograms

Converts holograms from other compatible plugins (e.g., DecentHolograms) into the FancyHolograms format. Supports optional icon conversion. Requires the 'fancyholograms.admin' permission.

```minecraft-command
/fancyholograms convert DecentHolograms <* | name of hologram> [--processIcons]
```

--------------------------------

### Open Dialog Command - FancyDialogs

Source: https://docs.fancyinnovations.com/fancydialogs/commands/dialog

This command opens a specified dialog by its ID for a given player. The player argument is optional and defaults to the command issuer. It requires the 'fancydialogs.commands.dialog.open' permission.

```plaintext
/dialog open <id> [player]
```

--------------------------------

### Execute Random Action for NPCs (Minecraft Plugin)

Source: https://docs.fancyinnovations.com/fancynpcs/tutorials/action-system

Randomly selects and executes one of the subsequent actions in the list. Useful for creating varied NPC responses. Implemented within the FancyNPCs plugin.

```plaintext
/npc action (npc) (trigger) add message <gold>Hello!</gold>
/npc action (npc) (trigger) add execute_random_action
/npc action (npc) (trigger) add message <green>Message one</green>
/npc action (npc) (trigger) add message <red>Message two</red>
/npc action (npc) (trigger) add message <blue>Message three</blue>
```

--------------------------------

### Modify Existing NPC

Source: https://docs.fancyinnovations.com/fancynpcs/api/getting-started

Procedures for modifying properties of an existing NPC.

```APIDOC
## Modify Existing NPC

### Description
Procedures for modifying properties of an existing NPC.

### 1. Get NPC Object

```java
// Get NPC by name (unique unless 'player-npcs' feature flag is enabled)
Npc npc = FancyNpcsPlugin.get().getNpcManager().getNpc("myNpc");
NpcData data = npc.getData();
```

### 2. Modify NPC Data

```java
data.setDisplayName("<green>new displayname</green>");
data.setSkin("https://url-to-skin.com/skin.png");
```

### 3. Update NPC

```java
npc.updateForAll();
```

For changes requiring respawn:

```java
npc.removeForAll();
pc.spawnForAll();
```
```

--------------------------------

### Player Command as OP Action for NPCs (Minecraft Plugin)

Source: https://docs.fancyinnovations.com/fancynpcs/tutorials/action-system

Executes a command as the player who interacted with the NPC, granting temporary operator privileges. Use with caution due to security implications. Part of the FancyNPCs plugin.

```plaintext
/npc action (npc) (trigger) add player_command_as_op give diamond 1
```

--------------------------------

### Hologram Management Commands

Source: https://docs.fancyinnovations.com/fancyholograms/commands/hologram

Commands for managing holograms, including listing, creating, and removing them. These commands require the 'FancyHolograms.admin' permission.

```plaintext
/Hologram help
/Hologram list
/Hologram nearby <range>
/Hologram create (type) (name)
/Hologram remove (hologram)
/Hologram copy (hologram) (new name)
/Hologram info (hologram)
```

--------------------------------

### Play Sound Effect for Player

Source: https://docs.fancyinnovations.com/fancynpcs/tutorials/action-system

The 'play_sound' action plays a specified sound effect to the player interacting with the NPC. This action enhances player experience by providing auditory feedback for events or interactions. It requires the name of the sound to be played.

```plaintext
/npc action (npc) (trigger) add play_sound entity.experience_orb.pickup
```

--------------------------------

### Command: Teleport NPCs (Command Line)

Source: https://docs.fancyinnovations.com/fancynpcs/changelog/v2

Introduces a '/npc teleport' command to move NPCs to specific coordinates. This provides a way to reposition NPCs within the game.

```bash
teleport command (teleports the npc to specific coordinates)
```

--------------------------------

### Customize NPC Appearance and Behavior

Source: https://docs.fancyinnovations.com/fancynpcs/commands/npc

This section covers commands for customizing NPC appearance, including setting their type, display name, skin, and equipment. It also includes options for toggling glowing effects and visibility in the player list.

```bash
`/npc type (npc) (type)`
`/npc displayname (npc) (@none | name)`
`/npc skin (npc) (@none | @mirror | name | url | file name) [--slim]`
`/npc equipment (npc) (set | clear | list)`
`/npc glowing (npc) [disabled | color]`
`/npc show_in_tab (npc) [state]`
```
Tokens:
Raw