Skip to content

Simple, lightweight and fast NPC plugin using packets

Notifications You must be signed in to change notification settings

Yive/FancyNpcs

 
 

Repository files navigation

Latest Version Generic badge Discord GitHub Downloads SpigotMC Downloads Downloads

Simple, lightweight and fast NPC plugin using packets

Only for minecraft server version 1.19.4 and 1.20.1
Using paper is highly recommended

Get the plugin

You can download the latest versions at the following places:

Commands

/npc create (name) - Creates a new npc at your location
/npc remove (name) - Removes an npc
/npc list - Summary of all npcs
/npc skin (name) [(skin)] - Sets the skin for an npc
/npc type (name) (type) - Sets the entity type for an npc
/npc movehere (name) - Teleports an npc to your location
/npc displayName (name) (displayName ...) - Sets the displayname for an npc
/npc equipment (name) (slot) - Equips the npc with the item you are holding
/npc message (name) (message) - Set NPC message
/npc serverCommand (name) (command ...) - The command will be executed by the console when someone interacts with the npc
/npc playerCommand (name) (command ...) - Executes the command on a player when interacting
/npc showInTab (name) (true|false) - Whether the NPC will be shown in tab-list or not
/npc turnToPlay (name) (true|false) - Whether the NPC will turn to you or not
/fancynpcs version - Shows you the current plugin version
/fancynpcs save - Saves all npcs
/fancynpcs reload - Reloads the config and npcs

Using <empty> as displayName will make the whole name tag invisible.

For the serverCommand, there is a placeholder {player} - it will be replaced with the username of the player who interacted with the npc.

You can also use any placeholder from PlaceholderAPI.

Permissions

For the /fancynpcs command - FancyNpcs.admin
For the /npc command - FancyNpcs.npc
For all subcommands of /npc - FancyNpcs.npc.*
Permission for a subcommand of /npc - FancyNpcs.npc.<subcommand>

Entity types

When using any entity type other than Player, the following features are disabled:

  • Changing the skin
  • Changing the equipment
  • Showing in tab
  • Glowing and changing the glowing-color

Multiple lines

To have multiple lines as the display name of an NPC follow the following steps:

  1. download the FancyHolograms plugin and put it in the plugins folder
  2. start your server and make sure the FancyNpcs and FancyHolograms plugin have both loaded
  3. create a hologram with multiple lines
  4. create a npc
  5. link the hologram with the npc /hologram edit <hologram> linkWithNpc <npc>
  6. you can now move the npc around and the hologram will always follow
  7. to unlink simply run /hologram edit <hologram> unlinkWithNpc

Build from source

  1. Clone this repo and run gradlew reobfJar
  2. The jar file will be in build/libs/FancyNpcs-<version>.jar

Examples

About

Simple, lightweight and fast NPC plugin using packets

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 96.1%
  • Kotlin 3.9%