how to use citizens plugin

From Citizens Wiki

Jump to: navigation, search

Citizens is a Minecraft server plugin that utilizes the Bukkit API. It adds various Non-Player Character (NPC) functionalities, from basic human NPCs to lively mob NPCs. Citizens also features an easy-to-use API for plugin developers to create new Characters.

Downloads: Downloads

Spigot Page: Spigot

Developers: fullwall and aPunch

Source: Github

Support tickets: Issues on Github, but please see Troubleshooting first.

Discord live chat: Discord

Donate: fullwall

Welcome to the Citizens Wiki! Citizens2 is an advanced NPC plugin for Spigot that allows developers to extend basic NPCs to provide varied gameplay and functionality.

Key Features

NPCs can walk, stand and talk naturally to players.
Easy to use API for developers. This allows for brand new Traits that enhance your NPC experience.
Monster and animal NPCs. You can create intimidating blazes around a Nether portal, welcoming sheep near the spawn, and helpful villagers in your villages. See the Commands page to see how to create a mob NPC.
Ridable and controllable NPCs.
Robust text editing. The new text-editing interface allows for adding, removing, and editing NPC text.
Player- and server-owned NPCS. Server-owned NPCs can be edited by anyone with the citizens.admin permission.
Admins can optionally charge for NPC creation and limit the number of NPCs per player.

Spigot Page

https://www.spigotmc.org/resources/citizens.13811/

Got an older version? Citizens is compatible with all major versions of Minecraft from 1.8.8 onwards (except 1.9.x). The correct build for specific server versions is listed here.

Credits

Citizens would not be where it is today without the contributions of these people:

fullwall and aPunch - creators of the Citizens plugin
aufdemrand - Wiki editor, graphic designer, and trait programmer
mcmonkey and Morphan1 - Trait programmers, wiki editors
Creeperhost - Original Citizens website server host
AgentK - Wiki editor, 1.x converter and script repo programmer.
All trait authors, including those not mentioned here - talk to us on Discord!
You, for trying out and using Citizens!

Also, a special thanks to all of those on Discord who have tested and to all of those who have donated! We would be nowhere without you!

Can I keep my NPCs from Citizens 1?

You'll have to convert your old npc-profiles.yml files first. A converter can be found here. Once you get the saves.yml file, place it in ./plugins/Citizens/saves.yml .

Still using Citizens 1.2? The old documentation, while no longer updated or supported, can be found here.