![Banner](../../docs/src/static/logos-and-banners/fancynpcs-banner.png) [![GitHub Release](https://img.shields.io/github/v/release/FancyMcPlugins/FancyNpcs?logo=github&labelColor=%2324292F&color=%23454F5A)](https://github.com/FancyMcPlugins/FancyNpcs/releases/latest) [![Supports Folia](https://img.shields.io/badge/folia-supported-%23F9D879?labelColor=%2313154E&color=%234A44A6)](https://papermc.io/software/folia) [![Discord](https://img.shields.io/discord/899740810956910683?cacheSeconds=3600&logo=discord&logoColor=white&label=%20&labelColor=%235865F2&color=%23707BF4)](https://discord.gg/ZUgYCEJUEx) [![GitHub Downloads](https://img.shields.io/github/downloads/FancyMcPlugins/FancyNpcs/total?logo=github&labelColor=%2324292F&color=%23454F5A)](https://github.com/FancyMcPlugins/FancyNpcs/releases/latest) [![Modrinth Downloads](https://img.shields.io/modrinth/dt/fancynpcs?logo=modrinth&logoColor=white&label=downloads&labelColor=%23139549&color=%2318c25f)](https://modrinth.com/plugin/fancynpcs) [![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/FancyMcPlugins/FancyNpcs?logo=codefactor&logoColor=white&label=%20)](https://www.codefactor.io/repository/github/fancymcplugins/fancynpcs/issues/main) [![Modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/modrinth_vector.svg)](https://modrinth.com/plugin/fancynpcs) [![Hangar](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/available/hangar_vector.svg)](https://hangar.papermc.io/Oliver/FancyNpcs)
Simple, lightweight and feature-rich NPC plugin for **[Paper](https://papermc.io/software/paper)** (and **[Folia](https://papermc.io/software/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](#images)** down below.
## Installation Paper **1.19.4** - **1.21.5** with **Java 21** (or higher) is required. Plugin should also work on **Paper** forks. **Spigot** is **not** supported. ### Download (Stable) - **[Hangar](https://hangar.papermc.io/Oliver/FancyNpcs)** - **[Modrinth](https://modrinth.com/plugin/fancynpcs)** - **[GitHub Releases](https://github.com/FancyMcPlugins/FancyNpcs/releases)** ### Download (Development Builds) - **[Jenkins CI](https://jenkins.fancyplugins.de/job/FancyNpcs/)** - **[FancyPlugins Website](https://fancyplugins.de/FancyNpcs/download)**
## Documentation Official documentation is hosted **[here](https://fancyplugins.de/docs/fancynpcs.html)**. Quick reference: - **[Getting Started](https://fancyplugins.de/docs/fn-getting-started.html)** - **[Command Reference](https://fancyplugins.de/docs/fn-commands.html)** - **[Using API](https://fancyplugins.de/docs/fn-api.html)** **Have more questions?** Feel free to ask them on our **[Discord](https://discord.gg/ZUgYCEJUEx)** server.
## Developer API More information can be found in **[Documentation](https://fancyplugins.de/docs/fn-api.html)** and **[Javadocs](https://repo.fancyplugins.de/javadoc/releases/de/oliver/FancyNpcs/latest)**. ### Maven ```xml fancyplugins-releases FancyPlugins Repository https://repo.fancyplugins.de/releases ``` ```xml de.oliver FancyNpcs [VERSION] provided ``` ### Gradle ```groovy repositories { maven("https://repo.fancyplugins.de/releases") } dependencies { compileOnly("de.oliver:FancyNpcs:[VERSION]") } ```
## Building Follow these steps to build the plugin locally: ```shell # 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. ![Screenshot 1](https://github.com/FancyMcPlugins/FancyNpcs/blob/main/images/screenshots/niceron1.jpeg?raw=true) Provided by [Explorer's Eden](https://explorerseden.eu/) ![Screenshot 2](https://github.com/FancyMcPlugins/FancyNpcs/blob/main/images/screenshots/niceron2.jpeg?raw=true) Provided by [Explorer's Eden](https://explorerseden.eu/) ![Screenshot 3](https://github.com/FancyMcPlugins/FancyNpcs/blob/main/images/screenshots/niceron3.jpeg?raw=true) Provided by [Explorer's Eden](https://explorerseden.eu/) ![Screenshot 4](https://github.com/FancyMcPlugins/FancyNpcs/blob/main/images/screenshots/dave1.jpeg?raw=true) Provided by [Beacon's Quest](https://www.beaconsquest.net/) ![Screenshot 5](https://github.com/FancyMcPlugins/FancyNpcs/blob/main/images/screenshots/oliver1.jpeg?raw=true) Provided by [@OliverSchlueter](https://github.com/OliverSchlueter) ![Screenshot 6](https://github.com/FancyMcPlugins/FancyNpcs/blob/main/images/screenshots/oliver2.jpeg?raw=true) Provided by [@OliverSchlueter](https://github.com/OliverSchlueter) ![Screenshot 7](https://github.com/FancyMcPlugins/FancyNpcs/blob/main/images/screenshots/grabsky1.jpeg?raw=true) Provided by [@Grabsky](https://github.com/Grabsky)