Citizens Wiki: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
 
(168 intermediate revisions by 9 users not shown)
Line 1: Line 1:
<div class="infobox" style="width: 295; font-size: 12px; background: #FFFFFF; float: right; border: 1px solid #CCCCCC; margin-left:0.5em; padding: 9px;">
__NOTOC__
{{Box|
Welcome to the Citizens Wiki! {{InfoBox}}
BORDER = #ccc|
Citizens is a popular Minecraft server plugin that allows you to create non player characters (NPCs) to provide varied gameplay and functionality for your server such as basic statues, shopkeepers, guards, scriptable NPCs and much more.
BACKGROUND = #aaa|
WIDTH = 275|
ALIGN = RIGHT|
ICON = |
HEADING = ''' ''' |
CONTENT = [[image:wordmark.png|center]]
<div class="padded" style="padding: 19px">Human NPCs for Bukkit.


'''Citizens''' is a Minecraft server plugin that utilizes the [http://www.bukkit.org 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.
{{FNavBox}}


'''Current Version:''' 1.1.5 on [http://dev.bukkit.org/server-mods/citizens/files/11-1-1-5/ bukkit-dev]
==Features==
 
* NPCs can walk, stand and talk naturally to players.
'''Developers:''' fullwall and aPunch
* Easy to use [[API]] for developers that allow [[Traits]] to be built for specific functionality.
 
* [[Types|Support for all mob types]] including Players, Pigs, and even non living ones like dropped items or arrow projectiles.  
'''API:''' on [http://jd.citizensnpcs.net Citizens JavaDocs]
* [[Commands]] Extensive commands to customise NPCs.
 
* [[Controllable NPCs|Ridable NPCs]].
'''Source:''' [https://github.com/CitizensDev/Citizens on Github]
* Text editing.
 
* Basic GUI shops.
'''Latest build:''' [http://citizens.us1.creeperhost.net:8080/job/Citizens/lastSuccessfulBuild/artifact/*zip*/archive.zip on Citizens Jenkins]
* Pathing.
 
* Much more.
'''Support tickets:''' [https://github.com/CitizensDev/Citizens/issues Issues on Github], but please see [[Troubleshooting]] first.
 
'''Donate: [https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=LXJKS2C8KREEG&lc=US&item_name=Halfcraft%20SMP%20Donations&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted aPunch] and [https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=CEQD6UNQHUG3C&lc=US&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted fullwall]
<br>
 
}}
</div>
</div> {{Box|
BORDER = #ccc|
BACKGROUND = #aaa|
WIDTH = |
ALIGN = CENTER|
ICON = |
HEADING = '' |
CONTENT = <div class="padded" style="font-size: 12px; padding: 5px">
'''Quick Navigation:'''&nbsp; &nbsp; &nbsp; [[Installating]] &nbsp; &nbsp; &nbsp;[[Upgrading]]&nbsp; &nbsp; &nbsp; [[Troubleshooting]]&nbsp; &nbsp; &nbsp; [[Frequently Asked Questions]] &nbsp; &nbsp; &nbsp;[[Commands and Permissions]] &nbsp; &nbsp; &nbsp;[[Configuration]]&nbsp; &nbsp; &nbsp; [[citizens.yml]]&nbsp; &nbsp; &nbsp; [[mobs.yml]]&nbsp; &nbsp; &nbsp;[[quests.yml]]&nbsp; &nbsp; &nbsp; [[npc_profiles.yml]]&nbsp; &nbsp; &nbsp; [[Characters]]</div>
}}
<br>
<div class="padded" style="font-size: 12px; padding: 5px">
== Latest News ==
 
* 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.
* Jan 30, 2012: 1.1.5 has been released for use with the new RB 1.1 R3.
 
== Setting up Citizens ==
 
Current version, 1.1.5, can be downloaded at the [http://dev.bukkit.org/server-mods/citizens/files/11-1-1-5/ 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.x ===
 
* 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
<br><br>
 
== 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!''.
 
<pre>/npc create Notch I like cookies!</pre>
 
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.
 
<pre>/toggle healer</pre>
 
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):'''
 
[[Blacksmith]]s<br>
[[Guard]]s<br>
[[Healer]]s<br>
[[Quester]]s<br>
[[Trader]]s<br>
[[Wizard]]s<br>
 
'''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
<br>'''aPunch''' - programmer
<br>'''Paul_T''' - citizensnpcs.net server host
<br>'''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!</div>

Latest revision as of 18:17, 19 April 2023

Welcome to the Citizens Wiki!

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

Citizens is a popular Minecraft server plugin that allows you to create non player characters (NPCs) to provide varied gameplay and functionality for your server such as basic statues, shopkeepers, guards, scriptable NPCs and much more.

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

Features

  • NPCs can walk, stand and talk naturally to players.
  • Easy to use API for developers that allow Traits to be built for specific functionality.
  • Support for all mob types including Players, Pigs, and even non living ones like dropped items or arrow projectiles.
  • Commands Extensive commands to customise NPCs.
  • Ridable NPCs.
  • Text editing.
  • Basic GUI shops.
  • Pathing.
  • Much more.