HyperCitizens

HyperCitizens is an addon for HyperScript that connects your scripts to Citizens NPCs: create them, dress them, make them move and talk, and run script when a player clicks one.

on npc click "Guide":
    make npc "Guide" say "Welcome, %player.name%! Follow the path to the market."
    give 1 bread to player

What you can do

• Run script on a click: on npc click "Guide": and on npc left click "Guard":
• Make NPCs: create npc "Guide" at player's location, or as "villager", "cow" and so on
• Dress them: set tool of npc "Guard" to diamond sword, plus armour and offhand
• Add floating text: add hologram line "Right-click to talk" to npc "Guard"
• Make them act: watch players, follow player, patrol between places, walk to, look at
• Make them talk: make npc "Guide" say "Welcome!"
• Change skin and name, and find NPCs by name or number

NPCs made with /npc create work in scripts too, and NPCs made by a script are saved by Citizens.

Requirements

HyperScript	1.7.4 or newer
Citizens	2.0.27 or newer
Server	Paper or Spigot 1.16.5+, Java 8+

Installation

1. Put the jar in the server's plugins/ folder, next to HyperScript and Citizens.
2. Restart the server.

There is nothing to configure.

Good to know

• An NPC is meant by its number or by its name, compared without colours.
• A patrol is remembered only while the server runs; start it again from an on server start: block.
• This addon collects no data.

Licence

MIT, like HyperScript.

Full syntax and examples: hyperscript.monoforge.net/addons.html