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

Citizens2 is 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 - 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 use-database in the config.yml to true 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.

But, what happened to my NPC types?

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. All of your previous NPC type files will not work. It is important 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.

Latest News

• Feb 19, 2012: Citizens documentation moved to 1.x subpages, transition to Citizens2 begins!
• Feb 16, 2012: Jenkins is back!
• Feb 13, 2012: 1.1.6 has been released. Several bugs fixed, new KillNPC quest objective added.
• Jan 30, 2012: Our Jenkins site is currently not uploading the most recent builds. You must use our BukkitDev page to get the 1.1.5 download. See above.
• Jan 30, 2012: 1.1.5 has been released for use with the new RB 1.1 R3.

Upgrading to v2.0 from 1.x

Before you do any downloading and configuring of Citizens2, you must delete all of your previous Citizens files. They will not work with Citizens v2.0 or higher. It is recommended to backup these files just in case you decide to downgrade.

Once you have removed all Citizens 1.x files, follow these steps:

1. Download Citizens here <--TODO link to website download.

2. Place Citizens.jar into the plugins folder.

3. Start your server. The configuration and save files will generate.

4. Stop your server.

5. Open up plugins/Citizens/config.yml. Configure Citizens to your liking. Use the Configuration page for reference if necessary.

6. Restart your server. To get started with NPC creation and editing, see other pages.

Credits

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

Paul_T - citizensnpcs.net server host
AgentKid - Wiki editor
aufdemrand - Wiki editor
NeonMaster - Web maintenance
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!