Citizens Wiki: Difference between revisions
No edit summary |
No edit summary |
||
Line 8: | Line 8: | ||
'''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 | '''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 create their own NPC type. Server admins are even able to choose which types that they want on their server. | ||
'''Current Version:''' 1.1 | '''Current Version:''' 1.1 |
Revision as of 15:54, 1 September 2011
Welcome to the Citizens Wiki!
|
Getting started
Follow the directions below to set up Citizens to your liking.
- Go to the download page here.
- Follow instructions on the download page.
- Drag the generated 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!
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.
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.
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.
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.
NPC Types
Creature Types (These types spawn on their own):
Toggleable Types (These types can be toggled):
FAQ
If the above pages don't have answers to your problems, this section usually will.
Can I give my NPCs custom skins?
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 CitizenSpout by mbsuperstar1.
How come my NPC won't talk?
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 isn't working?
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?
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 here.