1.x/Configuration: Difference between revisions

From Citizens Wiki

< 1.x
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page only describes nodes in the core plugin. For per-type node descriptions, see the type's corresponding page.
{{NoSupport}}
Citizens is configured with a few YAML files. Configuration files will generate automatically when you first install Citizens. If a file is missing a setting, it will automatically generate.


''citizens.yml'' and ''mobs.yml'' will generate automatically when you first install Citizens. If a file is missing a setting, it will automatically generate.
== Configuration files ==


== citizens.yml ==
[[citizens.yml]] control the core components of Citizens.<br>
<pre>
[[mobs.yml]] contain configuration nodes for [[Evil NPCs]].<br>
range:
[[npc_profiles.yml]] contain information about toggleable [[Characters]].<br>
    #number of blocks a player needs to be near an NPC in order for the NPC to look at the player
[[quests.yml]] contain your quest files for [[Quester]]s.
    look: 5
    #range a pathing NPC looks within while searching for entities to target
    pathfinding: 16.0
items:
    #items used to select an NPC with, '*' means all, ''DO NOT remove single quotes''
    select-items: '*'
    #items used to make an NPC talk, leave a trailing comma
    talk-items: 340,
ticks:
    #1 server tick = 1/20 of a second
    saving:
        #whether to save settings/properties often
        save-often: true
        #
        use-task: true
        #delay between each save-task save
        delay: 72000
    pathing:
        #maximum amount of ticks an NPC can remain stationary while pathing
        max-stationary: -1
        #maximum amount of ticks an NPC can path for
        max-pathing: -1
    waypoints:
        #amount of ticks to pause an NPC if right-clicked while pathing
        right-click-pause: 70
economy:
    #if you have NPC types on your server, more settings will generate here
    prices:
        #price for creating a basic NPC (with /npc create)
        basic:
            creation: 100
    #whether or not to use an economy plugin, if false, above economy settings are ignored
    use-economy: true
general:
    defaults:
        #default setting for whether an NPC looks at a player when close
        enable-following: true
        #default setting for whether an NPC talks when a player is close
        talk-when-close: false
    #whether to select and execute an NPC type's right-click option at the same time (i.e. select and teleport at the same time)
    quick-select: false
    #whether to print debug messages to the console
    debug-mode: false
    colors:
        #whether to use an NPC's nameplate color as their color in chat
        use-npc-colours: true
        #the color to use as an NPC's chat color if ''use-npc-colours'' is false
        npc-colour: f
    #whether to notify those with the 'citizens.admin.notifyupdates' of any Citizens update
    notify-updates: true
    chat:
        #character used to have spaces in NPC names
        space-char: /
        #message that is sent when an NPC is selected
        selection-message: <g>You selected <y><npc><g> (ID <y><npcid><g>).
        #default text of an NPC, leave a trailing semi-colon
        default-text: Hello.;How are you today?;Having a nice day?;Good weather today.;Stop hitting me!;I'm bored.;
        #message that is sent when an NPC is created
        creation-message: <g>The NPC <y><npc><g> was born!
        #message format used for when an NPC speaks
        format: '[%name%]: '</pre>


== mobs.yml ==
{{NavBox}}
 
[[Category:Citizens1]]
 
=== Default File ===
<pre>
general:
    spawn:
        #delay between each creature NPC random spawn
        delay: 200</pre>

Latest revision as of 12:14, 19 February 2012

Not Supported!
This page is about Citizens 1.x, while the current version is Citizens 2.0.2. This page's content may be outdated, and shouldn't be trusted as being correct. See this page's talk page for more information. If you were looking for the 2.0.2 equivalent of this page, try Configuration. If you feel this message was displayed in error, please contact an administrator.

Citizens is configured with a few YAML files. Configuration files will generate automatically when you first install Citizens. If a file is missing a setting, it will automatically generate.

Configuration files

citizens.yml control the core components of Citizens.
mobs.yml contain configuration nodes for Evil NPCs.
npc_profiles.yml contain information about toggleable Characters.
quests.yml contain your quest files for Questers.

Retrieved from ‘https://wiki.citizensnpcs.co/index.php?title=1.x/Configuration&oldid=674’