README.md

Simple, lightweight and feature-rich NPC plugin for Paper (and Folia) servers using packets.

Features

With this plugin you can create NPCs with customizable properties like:

• Type (Cow, Pig, Player, etc.)
• Skin (from username, texture URL or placeholder)
• Glowing (in all colors)
• Attributes (pose, visibility, variant, etc.)
• Equipment (eg. holding a diamond sword and wearing leather armor)
• Interactions (execute commands, send messages etc.)
• ...and much more!

Check out images section down below.

Installation

Paper 1.19.4 - 1.21.1 with Java 21 (or higher) is required. Plugin should also work on Paper forks.

Spigot is not supported.

Download (Stable)

• Hangar
• Modrinth
• GitHub Releases

Download (Development Builds)

• Jenkins CI
• FancyPlugins Website

Documentation

Official documentation is hosted here. Quick reference:

• Getting Started
• Command Reference
• Using API

Have more questions? Feel free to ask them on our Discord server.

Developer API

More information can be found in Documentation and Javadocs.

Maven

<repository>
    <id>fancyplugins-releases</id>
    <name>FancyPlugins Repository</name>
    <url>https://repo.fancyplugins.de/releases</url>
</repository>

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

Gradle

repositories {
    maven("https://repo.fancyplugins.de/releases")
}

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

Building

Follow these steps to build the plugin locally:

# Cloning repository.
$ git clone https://github.com/FancyMcPlugins/FancyNpcs.git
# Entering cloned repository.
$ cd FancyNpcs
# Compiling and building artifacts.
$ gradlew shadowJar
# Once successfully built, plugin .jar can be found in /build/libs directory.

Images

Images showcasing the plugin, sent to us by our community.

^{Provided by Explorer's Eden}

^{Provided by Explorer's Eden}

^{Provided by Explorer's Eden}

^{Provided by Beacon's Quest}

^{Provided by @OliverSchlueter}

^{Provided by @OliverSchlueter}

^{Provided by @Grabsky}