mirror of
https://github.com/FancyInnovations/FancyPlugins.git
synced 2025-12-06 07:43:36 +00:00
Add FancyNpcs source
This commit is contained in:
146
plugins/fancynpcs/README.md
Normal file
146
plugins/fancynpcs/README.md
Normal file
@@ -0,0 +1,146 @@
|
||||
<div align="center">
|
||||
|
||||

|
||||
|
||||
[](https://github.com/FancyMcPlugins/FancyNpcs/releases/latest)
|
||||
[](https://papermc.io/software/folia)
|
||||
[](https://discord.gg/ZUgYCEJUEx)
|
||||
[](https://github.com/FancyMcPlugins/FancyNpcs/releases/latest)
|
||||
[](https://modrinth.com/plugin/fancynpcs)
|
||||
[](https://www.codefactor.io/repository/github/fancymcplugins/fancynpcs/issues/main)
|
||||
|
||||
[](https://modrinth.com/plugin/fancynpcs)
|
||||
[](https://hangar.papermc.io/Oliver/FancyNpcs)
|
||||
|
||||
<br />
|
||||
|
||||
Simple, lightweight and feature-rich NPC plugin for **[Paper](https://papermc.io/software/paper)** (and **[Folia](https://papermc.io/software/folia)**) servers using packets.
|
||||
|
||||
</div>
|
||||
|
||||
## 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.
|
||||
|
||||
<br />
|
||||
|
||||
## 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)**
|
||||
|
||||
<br />
|
||||
|
||||
## 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.
|
||||
|
||||
<br />
|
||||
|
||||
## 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
|
||||
|
||||
<repository>
|
||||
<id>fancyplugins-releases</id>
|
||||
<name>FancyPlugins Repository</name>
|
||||
<url>https://repo.fancyplugins.de/releases</url>
|
||||
</repository>
|
||||
```
|
||||
|
||||
```xml
|
||||
|
||||
<dependency>
|
||||
<groupId>de.oliver</groupId>
|
||||
<artifactId>FancyNpcs</artifactId>
|
||||
<version>[VERSION]</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
```
|
||||
|
||||
### Gradle
|
||||
|
||||
```groovy
|
||||
repositories {
|
||||
maven("https://repo.fancyplugins.de/releases")
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly("de.oliver:FancyNpcs:[VERSION]")
|
||||
}
|
||||
```
|
||||
|
||||
<br />
|
||||
|
||||
## 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.
|
||||
```
|
||||
|
||||
<br />
|
||||
|
||||
## Images
|
||||
|
||||
Images showcasing the plugin, sent to us by our community.
|
||||
|
||||

|
||||
<sup>Provided by [Explorer's Eden](https://explorerseden.eu/)</sup>
|
||||
|
||||

|
||||
<sup>Provided by [Explorer's Eden](https://explorerseden.eu/)</sup>
|
||||
|
||||

|
||||
<sup>Provided by [Explorer's Eden](https://explorerseden.eu/)</sup>
|
||||
|
||||

|
||||
<sup>Provided by [Beacon's Quest](https://www.beaconsquest.net/)</sup>
|
||||
|
||||

|
||||
<sup>Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)</sup>
|
||||
|
||||

|
||||
<sup>Provided by [@OliverSchlueter](https://github.com/OliverSchlueter)</sup>
|
||||
|
||||

|
||||
<sup>Provided by [@Grabsky](https://github.com/Grabsky)</sup>
|
||||
Reference in New Issue
Block a user