|
|
| (217 intermediate revisions by 9 users not shown) |
| Line 1: |
Line 1: |
| {{Box|
| | __NOTOC__ |
| BORDER = #ccc|
| | Welcome to the Citizens Wiki! {{InfoBox}} |
| BACKGROUND = #aaa|
| | 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. |
| WIDTH = 100%|
| |
| ICON = |
| |
| HEADING = '''Welcome to the Citizens Wiki!''' |
| |
| CONTENT = [[image:wordmark.png|center]]
| |
|
| |
|
| | {{FNavBox}} |
|
| |
|
| '''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.
| | ==Features== |
| | | * NPCs can walk, stand and talk naturally to players. |
| '''Current Version:''' 1.1.4
| | * 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. |
| '''Developers:''' fullwall and aPunch
| | * [[Commands]] Extensive commands to customise NPCs. |
| | | * [[Controllable NPCs|Ridable NPCs]]. |
| | | * Text editing. |
| See below for information on types, commands, permission nodes, and more!
| | * Basic GUI shops. |
| }}
| | * Pathing. |
| | | * Much more. |
| == Getting started == | |
| Follow the directions below to set up Citizens to your liking.
| |
| | |
| * Go to the download page [http://www.citizensnpcs.net 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.'''
| |
| | |
| 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.
| |
| | |
| == NPC Types ==
| |
| | |
| '''Creature Types (These types spawn on their own):'''
| |
| | |
| * [[Evil NPCs]] | |
| | |
| | |
| '''Toggleable Types (These types can be toggled):'''
| |
| | |
| * [[Blacksmith]] | |
| * [[Guard]] | |
| * [[Healer]]
| |
| * [[Quester]] | |
| * [[Trader]]
| |
| * [[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?'''
| |
| <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?'''
| |
| <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?'''
| |
| <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?'''
| |
| <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 ==
| |
| | |
| * [[Messages]] | |
| | |
| == 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
| |
| | |
| 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!
| |
