Citizens Wiki: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
Line 25: Line 25:


<div class="padded" style="font-size: 12px; padding: 19px">
<div class="padded" style="font-size: 12px; padding: 19px">
== Getting started ==
== Setting up Citizens ==
Follow the directions below to set up Citizens to your liking.


* Go to the download page [http://www.citizensnpcs.net here].
Current version, 1.1.4, can be downloaded at the [http://dev.bukkit.org/server-mods/citizens/files/10-1-1-4/ Bukkit-Dev page for Citizens].
* Follow instructions on the download page.
 
* Drag the generated Citizens.jar and /Citizens directory into the /plugins directory of your server files.
 
=== 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.
* Start and stop your server.
* Configure the files in the /plugins/Citizens. Use the [[Configuration]] page for reference.
* Configure the files in the /plugins/Citizens. Use the [[Configuration]] page for reference.
Line 36: Line 39:
* Start your server again. Enjoy!
* Start your server again. Enjoy!


== Your First NPC ==
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]].
 
 
== 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.
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.




1. 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!''. If you want your NPC to have a skin, then give it a name of a player who has a skin. For example, typing ''/npc create Notch'' will create an NPC with Notch's skin.
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!''.


2. If you didn't set the text of your NPC with the above command, you can type ''/npc add This is a sentence.'' to add text to it. Additionally, you can replace all of the current text with just one line by doing ''/npc set This text replaces all of the current text.'' Lastly, you can reset your NPC's text by typing ''/npc reset''.
<pre>/npc create Notch I like cookies!</pre>


3. If you want your NPC to have a colored nameplate, then type ''/npc color &[color-code]''. Replace ''[color-code]'' with the ID of the color you want the nameplate to be. Example: ''/npc color &6'' will give your NPC a gold nameplate. '''WARNING: Changing the color of an NPC's nameplate removes its skin.'''
That's it! Of course there are various other things that you can do with basic NPCs as outlined in [[Basic NPCs]]


4. Having a "vanilla" 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.


== Characters ==
== Characters ==
Having a "vanilla" 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.


Formerly called NPC Types. Here and further known as just Characters, as they will be called in [[Citizens 2]].
Formerly called NPC Types. Here and further known as just Characters, as they will be called in [[Citizens 2]].
'''Creature Types (These types spawn on their own):'''
* [[Evil NPCs]]


'''Toggleable Types (These types can be toggled):'''
'''Toggleable Types (These types can be toggled):'''
Line 66: Line 79:
* [[Wizard]]
* [[Wizard]]


== FAQ ==
If the above pages don't have answers to your problems, this section usually will. See the FAQ section on an NPC type's page for type-specific questions.


'''I'm getting an error regarding an NPC type(s) on startup. What should I do?'''
== Evil NPCs ==
<br>Make sure all of your NPC type .JAR files are in the %ROOT%/plugins/Citizens/types directory.


'''Can I give my NPCs custom skins?'''
See [[Evil NPCs]].
<br>Citizens does not officially support custom skins and '''never will'''. However, for custom skins and other client-side Citizens additions, it is recommended that you use [http://forums.bukkit.org/threads/mech-fun-citizenspout-v0-0-1-give-your-npcs-unique-skins-1000-1060.32594/ CitizenSpout] by mbsuperstar1.


'''How come my NPC won't talk?'''
<br>You must be holding the configurable talk-item. You can change this item in citizens.yml under the node ''item.talk-items''. The default item is a book (ID 340).


'''Why isn't the ''/toggle'' command working?'''
== FAQ ==
<br>This is a conflict with xAuth. Use an alias: ''/tog'' or ''/t''.


'''I am getting errors, and none of the developers respond to my questions in the thread. What should I do?'''
See [[Frequently Asked Questions]].
<br>To get a response from a developer, it is key that you follow the directions in the README file that is packaged in Citizens.jar. You can also view it [https://github.com/CitizensDev/Citizens/blob/master/README here].


== Tips and tricks ==
== Tips and tricks ==


* [[Message Formatting]]
See [[Message Formatting]].


== Credits ==
== Credits ==

Revision as of 05:50, 27 January 2012

Wordmark.png

Citizens is a Minecraft server plugin that utilizes the Bukkit API. It adds various Non-Player Character (NPC) functionalities, from simple 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

Developers: fullwall and aPunch


See below for information on types, commands, permission nodes, and more!

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.


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 "vanilla" 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.

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):


Evil NPCs

See 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

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!
Retrieved from ‘https://wiki.citizensnpcs.co/index.php?title=Citizens_Wiki&oldid=278’