Citizens Wiki: Difference between revisions

From Citizens Wiki

No edit summary
(41 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<div style='text-align: center;'>
<div class='alert' style='border-color: #4EE2EC; background-color: #E0FFFF'>
<div style='margin-left: 20px; margin-right: 20px; font-size: 120%;'>
<big>'''NOTICE'''</big>
---------------------<br>
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 [[:Category:Citizens1|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 [http://ci.citizensnpcs.com the Citizens Jenkins].'''<br><br>
</div></div></div>
<br>
{{InfoBox}}
{{InfoBox}}
{{FNavBox}}
Welcome to the Citizens Wiki!
Citizens2 is an advanced NPC plugin for CraftBukkit. Unlike the original Citizens, Citizens2 allows developers to extend basic NPCs to provide varied gameplay and functionality.


<h1>Looking for the Citizens 1.2 wiki? Click [http://wiki.citizensnpcs.com/Category:Citizens1 here].</h1>
==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.
* [[Types|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|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.


{{FNavBox}}


==What's New?==
==Can I keep my NPCs from Citizens 1?==
{{color|green|white| Citizens 1.2 and Citizens 2.0 are both now compatible with Craftbukkit 1.3.1, download the latest development builds if you encounter any errors}}
You'll have to convert your old npc-profiles.yml files first. A converter can be found [http://citizensnpcs.co/converter/ here]. Once you get the saves.yml file, place it in ./plugins/Citizens/saves.yml .
 
[http://ci.citizensnpcs.com/job/Citizens/ Citizens 1.2 ]
 
[http://ci.citizensnpcs.com/job/Citizens2/ Citizens 2.0 ]
 
<span style="word-spacing:13;letter-spacing:12">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.</span>
 
 
===Key Features===
* New and improved [[API]] for developers. This allows for brand new [[:Category:Characters|Characters]] to be made that can enhance your Minecraft experience.
* [[Data Storage|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.
* [[Types|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|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 or the /plugins/Citizens/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. If you want to see a character and can code, there's also the option of creating your own! See the [[API]] page.
 
===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 [http://ci.citizensnpcs.com Jenkins]. Instructions to install the development builds can be found on the [[Installation]] page.


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


===Can I keep my old NPCs?===
==Changelog==
You'll have to convert your old npc-profiles.yml files first. A converter can be found [http://citizensnpcs.com/converter/ here on the site]. Once you get the saves.yml file, place it in ./plugins/Citizens/saves.yml .
https://www.spigotmc.org/resources/citizens.13811/


==News==
Previous versions:
{{News}}
http://dev.bukkit.org/server-mods/citizens/files/


The latest dev build for specific server versions are listed [[Versions|here]].


==Credits==
==Credits==
Line 57: Line 33:


<br>'''fullwall and aPunch''' - creators of the Citizens plugin  
<br>'''fullwall and aPunch''' - creators of the Citizens plugin  
<br>'''Paul_T''' - citizensnpcs.com server host
<br>'''Creeperhost''' - Citizens website server host
<br>'''AgentK''' - Wiki editor, test server provider
<br>'''AgentK''' - Wiki editor, 1.x converter and script repo programmer.
<br>'''aufdemrand''' - Wiki editor, graphic designer, and trait programmer
<br>'''aufdemrand''' - Wiki editor, graphic designer, and [[Denizen|trait programmer]]
<br>'''NeonMaster''' - Server and web maintenance, website developer
<br>'''mcmonkey and Morphan1''' - Trait programmer, wiki editor
<br>All character/trait authors, including those not mentioned here - talk to us on IRC!
<br>All character/trait authors, including those not mentioned here - talk to us on Discord!
<br>You, for trying out and using Citizens!
<br>You, for trying out and using Citizens!


Also, a special thanks to all of those in [irc://citizens@irc.esper.net IRC] who have tested and to all of those who have donated! We would be nowhere without you!
Also, a special thanks to all of those on [https://discord.gg/Q6pZGSR Discord] who have tested and to all of those who have donated! We would be nowhere without you!

Revision as of 23:46, 26 February 2018

Wordmark.png

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

Welcome to the Citizens Wiki! Citizens2 is an advanced NPC plugin for CraftBukkit. Unlike the original Citizens, Citizens2 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.
Quick Navigation
Usage Installation  · Frequently Asked Questions  · Commands  · Waypoints  · Shops  · Editors  · API
Configuration Data Storage  · Permissions  · Translations
Characters Denizen  · Sentinel  · DtlTraders  · Builder
Info Downloads  · Discord
Special Information Minecraft 1.8  · Cracks  · Skins  · NPC Commands

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.

Changelog

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

Previous versions: http://dev.bukkit.org/server-mods/citizens/files/

The latest dev build for specific server versions are 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
Creeperhost - Citizens website server host
AgentK - Wiki editor, 1.x converter and script repo programmer.
aufdemrand - Wiki editor, graphic designer, and trait programmer
mcmonkey and Morphan1 - Trait programmer, wiki editor
All character/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!