Configuration: Difference between revisions

Revision as of 20:14, 20 March 2012

Citizens configuration is handled in the file /plugins/Citizens/config.yml. See below for detailed information on each setting. For more information on text nodes such as <npc>, see the Text Syntax page.

Default Configuration

Mouse over each field to see what each one is used for.

# Citizens Configuration
npc:
 chat:
   prefix: '[<npc>]: '
 selection:
   quick-select: false
   item: 280
   message: <b>You selected <a><npc><b>!
 default:
   look-close: false
   random-talker: true
   talk-close: false
 talk:
   max-cooldown: 60
   min-cooldown: 30
   talk-item: 340
 server-ownership: false
database:
 password: 
 username: 
 url: 
 driver: 
general:
 debug-mode: false
use-database: false

Quick Navigation
Usage	Installation · Frequently Asked Questions · Commands · Editors · Characters · API ·
Configuration	Configuration · Text Syntax · Permissions · Waypoints · Data Storage

@@ Line 6: / Line 6: @@
   <nowiki></nowiki>{{H:title|The NPC block. All NPC specifics go here|npc:}}
    {{H:title|Chat specific settings|chat:}}
-     {{H:title|The prefix that is put before all NPC dialogue lines|prefix: '[<npc>]: '}}
+     {{H:title|Prefix that is put before all NPC dialogue lines|prefix: '[<npc>]: '}}
    {{H:title|Configuration on how to select NPCs|selection:}}
-     {{H:title|Whether to enable quick select. true/false|quick-select: false}}
+     {{H:title|Whether to enable quick select.|quick-select: false}}
-     {{H:title|What item to use as the selection tool|item: 280}}
+     {{H:title|ID of item to use as selection tool|item: 280}}
-     {{H:title|What message to output to the player when they've selected an NPC|message: <nowiki><b>You selected <a><npc><b>!</nowiki>}}
+     {{H:title|Message outputted to the player when they've selected an NPC|message: <nowiki><b>You selected <a><npc><b>!</nowiki>}}
    {{H:title|Default settings for NPCs. Can be changed per-NPC via commands|default:}}
-     {{H:title|Look at the player when they come within 5 blocks?|look-close: false}}
+     {{H:title|Whether to look at the player when they come within 5 blocks|look-close: false}}
-     {{H:title|Randomly talk, rather than on defined schedule|random-talker: true}}
+     {{H:title|Randomly choose line to talk instead of talking in order|random-talker: true}}
-     {{H:title|Talk when the player comes within 5 blocks?|talk-close: false}}
+     {{H:title|Whether to talk when the player comes within 5 blocks|talk-close: false}}
    {{H:title|Talk settings|talk:}}
      {{H:title|Maximum time before the NPC will talk again|max-cooldown: 60}}
      {{H:title|Minimum time before the NPC will talk again|min-cooldown: 30}}
-  {{H:title|Item you have to hit the NPC with for them to talk|talk-item: 340}}
+    {{H:title|Item you have to right-click the NPC with for them to talk|talk-item: 340}}
+  {{H:title|Whether the server owns an NPC by default|server-ownership: false}}
   <nowiki></nowiki>{{H:title|The name of the database|database:}}
    {{H:title|The password for the database connection.|password: ''}}
@@ Line 25: / Line 26: @@
    {{H:title|The driver to use when connecting to the database.|driver: ''}}
   <nowiki></nowiki>{{H:title|General settings regarding Citizens|general:}}
-   {{H:title|Whether to be in debug mode or not. Prints more messages to console about Citizens. true/false|debug-mode: false}}
+   {{H:title|Whether to be in debug mode or not. Prints more messages to console about Citizens.|debug-mode: false}}
   <nowiki></nowiki>{{H:title|Whether to use databases or not. true/false|use-database: false}}
 {{NavBox}}
 [[Category:Configuration]]