Citizens Wiki

Under Construction: These pages are under construction for the upcoming release of Citizens 2.0, a complete rewrite of the Citizens plugin you know and love with tons of spiffy new features. If you're looking for reference for Citizens 1.x and its character types, please see the index of 1.x pages. Citizens 2.0 has not been released, contrary to what the wiki says. We're just preparing it for the eventual release. You CAN however download the beta at the Citizens Jenkins.

Citizens is a Minecraft server plugin that utilizes the Bukkit API. It adds various Non-Player Character (NPC) functionality. Citizens also features an easy-to-use API for plugin developers. Downloads: Downloads Spigot Page: Spigot Developers: fullwall Source: Github Support tickets: Ask on Discord in the '#citizens' channel, or post an issue on Github, but please see Troubleshooting first. Discord: Discord Donate: fullwall

Looking for the Citizens 1.2 wiki? Click here.

What's New?

For the past few months, we have been planning a complete rewrite of the core code and API. We believed that Citizens wasn't fully living up to its potential. There were so many things we could do and so many places we could go with it. But the code didn't allow for many of these things. So, we agreed to completely redo the system. With Citizens2 comes a better code base, better API, and shiny new features for server administrators to play with.

Key Features

• New and improved API for developers. This allows for brand new Characters to be made that can enhance your Minecraft experience.
• Database support. When the settings first generate, the default save method is YML. You can change storage.type in the config.yml to database if you wish to use a database. There are also database settings that you must configure before you can begin using the database.
• Mob NPCs. No longer are you confined to human NPCs. Now 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.
• Improved text editing. The new text-editing interface allows for easier NPC text adding, removing, and changing. There are also a few new text-related Configuration settings.
• Ability to set the server as the owner of an NPC. This makes it so only those with the "citizens.admin" permission can use and edit the NPC.
• Ridable NPCs. 'nuff said.
• A new scripting engine makes Citizens perhaps the most powerful plugin you have ever used.
• New Characters!
• And much more! We're constantly adding new features, so stay tuned!

But, what happened to my NPC types? Can I still use those?

NPC types are now known as "Characters". Instead of placing these JAR files into the /plugins/Citizens/types directory, all you need to do is drop the JAR in the plugins folder. It is important to note, however, that all of your previous NPC type files will not work. You need to upgrade to the new characters if you so choose to use them. You can find more information on each character at the Characters page.

Where's the <insert character name here>?

Hang tight! We decided that rather than simply port the characters, we would rebuild them from scratch, including the design. We're redesigning most of the characters to work better with Citizens2 and be easier to use.

Well how do I get this shiny new version?

Citizens 2 is still in development, and isn't stable enough for a production server. However, there are development builds out that can be found on Jenkins. Instructions to install the development builds can be found on the Installation page.

Can I keep my old NPCs?

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

Credits

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

fullwall and aPunch - creators of the Citizens plugin
Paul_T - citizensnpcs.net server host
AgentKid - Wiki editor, test server provider
aufdemrand - Wiki editor, graphic designer, and character programmer
NeonMaster - Server and web maintenance, website developer
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!