Configuration: Difference between revisions
From Citizens Wiki
No edit summary |
No edit summary |
||
(14 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
==Default Configuration== | ==Default Configuration== | ||
<pre> | |||
# Citizens Configuration | |||
npc: | |||
chat: | |||
options: | |||
bystandersheartargetedchat: true | |||
maxnumberoftargetstoshow: 2 | |||
multipletargetsformat: <target>|, <target>| & <target>| & others | |||
range: 5 | |||
format: | |||
notargets: '[<npc>]: <text>' | |||
withtargettobystanders: '[<npc>] -> [<target>]: <text>' | |||
totarget: '[<npc>] -> You: <text>' | |||
withtargetstobystanders: '[<npc>] -> [<targets>]: <text>' | |||
default: | |||
lookclose: # NPCs turning heads towards players settings | |||
enabled: false # whether look close is enabled by default | |||
range: 5 # the look close range | |||
pathfinding: | |||
range: 25.0 # the maximum pathfinding range to search through before giving up | |||
randomtalker: true # whether the NPC will randomly select a text item instead of sequentially | |||
realisticlooking: false # whether the NPC will ensure potential players to look at / talk to aren't obscured by walls | |||
stationaryticks: -1 # how long the NPC will be stationary while pathfinding before giving up | |||
talkclose: | |||
enabled: false # default talk close | |||
range: 5 # range before NPC talks | |||
text: | |||
'0': Hi, I'm <npc>! # default text | |||
limits: | |||
defaultlimit: 10 # the default per-player NPC limit | |||
maxpermissionchecks: 100 # the maximum number of per-player NPCs a player can have | |||
maxspeed: 100 # the maximum speed an NPC can have | |||
chunks: | |||
alwayskeeploaded: false # whether to always keep chunks loaded with NPCs in them or unload them when there are no other players inside the chunk | |||
selection: | |||
quickselect: false # no message will be sent | |||
item: '280' # the selector item: default is stick | |||
message: <b>You selected <a><npc><b>! # the message sent on select | |||
player: | |||
removefromlist: true # setting this to false will enable human NPCs to be recognised by mobs; it will also make them just like a normal player, which means other plugins will recognise them as well. This can be enabled per-NPC using /npc playerlist | |||
serverownership: false # whether the server owns NPCs by default | |||
text: | |||
maxtalkcooldown: 1 # the maximum cooldown before the NPC will talk close in seconds : the cooldown is chosen at random between the min/max | |||
mintalkcooldown: 1 # the minimum cooldown before the NPC will talk close in seconds | |||
talkitem: '340' # the items that will cause the NPC to talk to you on right click : default is book | |||
pathfinding: | |||
usenewfinder: false # EXPERIMENTAL: enable non-Minecraft pathfinder | |||
advanced: | |||
checkminecraftversion: true # set this to false to disable minecraft compatibility checks. Should not normally be used. | |||
storage: | |||
savetask: | |||
delay: 72000 # the delay in ticks before everything gets serialised to disk | |||
file: saves.yml # the storage file | |||
type: yaml # the type: can be NBT, YAML. | |||
general: | |||
debugmode: false # enable debug output | |||
colorscheme: | |||
messagehighlight: <e> # set the default highlight colour: usually yellow. | |||
message: <a> # set the default message colour: usually green. | |||
translation: | |||
locale: '' # set the locale explicitly if needed: eg. en_US is US English, de_DE is the generic German locale | |||
economy: | |||
npc: | |||
cost: 100.0 # the cost of an NPC. NOTE: requires Vault | |||
subplugins: | |||
folder: plugins # subplugins like Denizen etc can be placed into Citizens/<subplugins folder> for organisational purposes. | |||
</pre> | |||
{{hidden|old config| | |||
Mouse over each field to see what each one is used for. | Mouse over each field to see what each one is used for. | ||
<nowiki></nowiki># Citizens Configuration | <nowiki></nowiki># Citizens Configuration | ||
<nowiki></nowiki>{{H:title|The NPC block. All NPC specifics go here|npc:}} | <nowiki></nowiki>{{H:title|The NPC block. All NPC specifics go here|npc:}} | ||
{{H:title|Chat specific settings|chat:}} | {{H:title|Chat specific settings|chat:}} | ||
{{H:title| | {{H:title|Prefix that is put before all NPC dialogue lines|prefix: '[<npc>]: '}} | ||
{{H:title|Configuration on how to select NPCs|selection:}} | {{H:title|Configuration on how to select NPCs|selection:}} | ||
{{H:title|Whether to | {{H:title|Whether to go to next task right after selecting NPC instead of having to click again|quick-select: false}} | ||
{{H:title| | {{H:title|ID of item to use as selection tool|item: 280}} | ||
{{H:title| | {{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|Whether to look at the player when they come within 5 blocks|look-close: false}} | |||
{{H:title|Randomly choose line to talk instead of talking in order|random-talker: true}} | |||
{{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 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> | |||
<nowiki></nowiki>{{H:title|General settings regarding Citizens|general:}} | <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. | {{H:title|Whether to be in debug mode or not. Prints more messages to console about Citizens.|debug-mode: false}} | ||
<nowiki></nowiki>{{H:title| | <nowiki></nowiki>{{H:title|Subplugin settings|subplugins:}} | ||
{{H:title|The folder to load subplugins from|folder: 'plugins'}} | |||
}} | |||
{{H:title|The | |||
{{NavBox}} | {{NavBox}} | ||
[[Category:Configuration]] | [[Category:Configuration]] |
Revision as of 05:55, 18 November 2014
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
# Citizens Configuration npc: chat: options: bystandersheartargetedchat: true maxnumberoftargetstoshow: 2 multipletargetsformat: <target>|, <target>| & <target>| & others range: 5 format: notargets: '[<npc>]: <text>' withtargettobystanders: '[<npc>] -> [<target>]: <text>' totarget: '[<npc>] -> You: <text>' withtargetstobystanders: '[<npc>] -> [<targets>]: <text>' default: lookclose: # NPCs turning heads towards players settings enabled: false # whether look close is enabled by default range: 5 # the look close range pathfinding: range: 25.0 # the maximum pathfinding range to search through before giving up randomtalker: true # whether the NPC will randomly select a text item instead of sequentially realisticlooking: false # whether the NPC will ensure potential players to look at / talk to aren't obscured by walls stationaryticks: -1 # how long the NPC will be stationary while pathfinding before giving up talkclose: enabled: false # default talk close range: 5 # range before NPC talks text: '0': Hi, I'm <npc>! # default text limits: defaultlimit: 10 # the default per-player NPC limit maxpermissionchecks: 100 # the maximum number of per-player NPCs a player can have maxspeed: 100 # the maximum speed an NPC can have chunks: alwayskeeploaded: false # whether to always keep chunks loaded with NPCs in them or unload them when there are no other players inside the chunk selection: quickselect: false # no message will be sent item: '280' # the selector item: default is stick message: <b>You selected <a><npc><b>! # the message sent on select player: removefromlist: true # setting this to false will enable human NPCs to be recognised by mobs; it will also make them just like a normal player, which means other plugins will recognise them as well. This can be enabled per-NPC using /npc playerlist serverownership: false # whether the server owns NPCs by default text: maxtalkcooldown: 1 # the maximum cooldown before the NPC will talk close in seconds : the cooldown is chosen at random between the min/max mintalkcooldown: 1 # the minimum cooldown before the NPC will talk close in seconds talkitem: '340' # the items that will cause the NPC to talk to you on right click : default is book pathfinding: usenewfinder: false # EXPERIMENTAL: enable non-Minecraft pathfinder advanced: checkminecraftversion: true # set this to false to disable minecraft compatibility checks. Should not normally be used. storage: savetask: delay: 72000 # the delay in ticks before everything gets serialised to disk file: saves.yml # the storage file type: yaml # the type: can be NBT, YAML. general: debugmode: false # enable debug output colorscheme: messagehighlight: <e> # set the default highlight colour: usually yellow. message: <a> # set the default message colour: usually green. translation: locale: '' # set the locale explicitly if needed: eg. en_US is US English, de_DE is the generic German locale economy: npc: cost: 100.0 # the cost of an NPC. NOTE: requires Vault subplugins: folder: plugins # subplugins like Denizen etc can be placed into Citizens/<subplugins folder> for organisational purposes.
old config
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 general: debug-mode: false subplugins: folder: 'plugins'
{{#if:|}}
Quick Navigation | |
---|---|
Usage | Installation · Frequently Asked Questions · Commands · Editors · Characters · API · |
Configuration | Configuration · Text Syntax · Permissions · Waypoints · Data Storage |