forked from LordTuxn/FancyNpcs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * replace misleading image, correct requirements * compress images, use .jpeg instead of .png, remove unused image * cache discord badge * restructure content one more time
- Loading branch information
Showing
17 changed files
with
69 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,84 +1,97 @@ | ||
 | ||
<div align="center"> | ||
|
||
# | ||
 | ||
|
||
 | ||
[](https://shields.io/) | ||
[](https://discord.gg/ZUgYCEJUEx) | ||
 | ||
[](https://modrinth.com/plugin/fancynpcs/versions) | ||
[](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) | ||
|
||
Simple, lightweight and fast NPC plugin using [packets](https://wiki.vg/Protocol) | ||
[](https://modrinth.com/plugin/fancynpcs) | ||
[](https://hangar.papermc.io/Oliver/FancyNpcs) | ||
|
||
**Only for minecraft server version 1.19.4 - 1.20.6**<br> | ||
_Using [paper](https://papermc.io/downloads) is highly recommended_ | ||
<br /> | ||
|
||
## Get the plugin | ||
Simple, lightweight and feature-rich NPC plugin for **[Paper](https://papermc.io/software/paper)** (and **[Folia](https://papermc.io/software/folia)**) servers using packets. | ||
|
||
### Stable versions | ||
</div> | ||
|
||
- https://hangar.papermc.io/Oliver/FancyNpcs | ||
- https://modrinth.com/plugin/fancynpcs/ | ||
- https://github.com/FancyMcPlugins/FancyNpcs/releases | ||
|
||
### Development builds | ||
|
||
- https://fancyplugins.de/FancyNpcs/download/ | ||
- Build from source | ||
|
||
## Documentation | ||
## Features | ||
With this plugin you can create NPCs with customizable properties like: | ||
- **Type** (Cow, Pig, Player, etc.) | ||
- **Skin** (from username or texture URL) | ||
- **Glowing** (in all colors) | ||
- **Attributes** (pose, visibility, variant, etc.) | ||
- **Equipment** (eg. holding a diamond sword and wearing leather armor) | ||
- **Interactions** (player commands, console commands, messages) | ||
- ...and much more! | ||
|
||
You can find the official FancyNpcs documentation here: https://fancyplugins.de/docs/fancynpcs.html | ||
Check out **[images section](#images)** down below. | ||
|
||
- Getting started: https://fancyplugins.de/docs/fn-getting-started.html | ||
- Commands: https://fancyplugins.de/docs/fn-commands.html | ||
- API: https://fancyplugins.de/docs/fn-api.html | ||
<br /> | ||
|
||
If you have any questions about the plugin/api, feel free to ask in the [discord](https://discord.gg/ZUgYCEJUEx). | ||
## Installation | ||
Paper **1.19.4** - **1.20.6** with **Java 21** (or higher) is required. Plugin should also work on **Paper** forks. | ||
|
||
## Features | ||
**Spigot** is **not** supported. | ||
|
||
With FancyNpcs you can create NPCs that look like real players. You can edit a bunch of properties like the display name | ||
or skin. | ||
### Download (Stable) | ||
- **[Hangar](https://hangar.papermc.io/Oliver/FancyNpcs)** | ||
- **[Modrinth](https://modrinth.com/plugin/fancynpcs)** | ||
- **[GitHub Releases](https://github.com/FancyMcPlugins/FancyNpcs/releases)** | ||
|
||
All properties: | ||
### Download (Development Builds) | ||
- **[Jenkins CI](https://jenkins.fancyplugins.de/job/FancyNpcs/)** | ||
- **[FancyPlugins Website](https://fancyplugins.de/FancyNpcs/download)** | ||
|
||
- display name | ||
- skin (username or url) | ||
- entity type (cow, pig, blaze etc.) | ||
- equipment (e.g. holding something in the hand) | ||
- glowing (in all colors) | ||
- and many more properties that are entity specific | ||
<br /> | ||
|
||
You can also define some actions that will be executed when a player interacts with the npc: | ||
## 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)** | ||
|
||
- message: sends a simple message to the player | ||
- player command: forces the player to execute a command | ||
- server command: executes a command in the console | ||
**Have more questions?** Feel free to ask them on our **[Discord](https://discord.gg/ZUgYCEJUEx)** server. | ||
|
||
Explore more features on the official website: https://fancyplugins.de/ | ||
<br /> | ||
|
||
### Build from source | ||
## Building | ||
Follow these steps to build the plugin locally: | ||
|
||
1. Clone this repo and run `gradlew shadowJar` | ||
2. The jar file will be in `build/libs/FancyNpcs-<version>.jar` | ||
```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. | ||
``` | ||
|
||
## Examples | ||
<br /> | ||
|
||
The following images are by https://explorerseden.eu/ | ||
 | ||
## 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> | ||
|
||
The following image is by Beacon's Quest | ||
 | ||
 | ||
<sup>Provided by [Explorer's Eden](https://explorerseden.eu/)</sup> | ||
|
||
The following images are by oliver (main dev of this plugin) | ||
 | ||
 | ||
<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> |
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.