Citizens Wiki

Human NPCs for Bukkit. Citizens is a Minecraft server plugin that utilizes the Bukkit API. It adds various Non-Player Character (NPC) functionalities, from basic NPCs that talk to lively, active Guards. Originally featuring only one type of NPC, Citizens now contains 7 toggleable types and 1 creature type. With the Citizens API, plugins developers can make their plugins compatible with NPCs. Server admins are even able to choose which types that they want on their server. Current Version: 1.1.4 on bukkit-dev Developers: fullwall and aPunch API: on Citizens JavaDocs Source: on Github Latest build: on Citizens Jenkins Support tickets: Issues on Github, but please see Troubleshooting first. Donate: aPunch and fullwall

Quick Navigation:      Installating      Upgrading      Troubleshooting      Frequently Asked Questions      Commands and Permissions      Configuration      citizens.yml      mobs.yml     quests.yml      npc_profiles.yml      Characters

THE LATEST NEWS

Jan 30, 2012: Bukkit has released a 1.1 RB (R3) that currently produces errors with Citizens 1.1.4. Updating to this RB will disable Citizens. A fix is in the works, please be patient. Need a bukkit build that works with Citizens? Try CraftBukkit++ R1 (Build 45).

Setting up Citizens

Current version, 1.1.4, can be downloaded at the Bukkit-Dev page for Citizens.

New Installation

• Unzip the download obtained at Bukkit-Dev.
• Drag Citizens.jar and /Citizens directory into the /plugins directory of your server files.
• Start and stop your server.
• Configure the files in the /plugins/Citizens. Use the Configuration page for reference.
• Give your players permissions. See the Commands and Permissions page for detailed node information.
• Start your server again. Enjoy!

Problems? See Troubleshooting.

Updating from 1.1.3 or 1.1.2

• Stop your server
• Unzip the download obtained at Bukkit-Dev.
• Overwrite Citizens.jar and each Character Type .JAR file.
• Start your server. Enjoy!

Problems? See Troubleshooting.

Updating from earlier versions

It is recommended when updating from early versions of Citizens that you start from scratch, however, old quest files and configuration files may still be valid. New .JAR files should be overwritten over old versions

Creating your first NPC

It is important to read the Commands and Permissions page for an in-depth look at all of the commands you can use to customize your NPCs. For now, here is a basic guide on how to setup an NPC.

Type /npc create [name]. Replace [name] with the name of your NPC. Optionally, you can add text to your NPC. To do this, simply add words after the name of the NPC. Example: /npc create Bob Hi, my name is Bob!.

/npc create Notch I like cookies!

That's it! Of course there are various other things that you can do with basic NPCs as outlined in Basic NPCs

Characters

Having a basic NPC is cool, but you may want to make it another type. To change an NPC's type, use the command /toggle [type]. Replace [type] with the NPC type that you want to toggle your NPC to become. It is imperative that you have the NPC type's .jar file in your plugins/Citizens/types directory. If not, you won't be able to toggle an NPC to become that type.

/toggle healer

Formerly called NPC Types. Here and further known as just Characters, as they will be called in Citizens 2.

Toggleable Types (These types can be toggled):

Blacksmiths
Guards
Healers
Questers
Traders
Wizards

Mob Types (These types can automatically spawn):

Evil NPCs.

FAQ

See Frequently Asked Questions.

Tips and tricks

See Message Formatting.

Credits

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

fullwall - original programmer
aPunch - programmer
Paul_T - citizensnpcs.net server host
You! - for trying out and using Citizens

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