Denizen config.yml: Difference between revisions

From Citizens Wiki

No edit summary
(Blanked the page)
 
Line 1: Line 1:
{{CQuote|The Denizen config.yml contains nodes to alter the stock behavior and look of Denizen. You'll notice that Denizen does not create its own config.yml. Why is this? Denizen stores its entire config inside memory, so it's not necessary to have a copy inside the Denizen folder unless you need to change the defaults. You can use the config.yml to override those defaults. Not having Denizen write to the config.yml itself (as well as scripts files) ensures that upon a /denizen reload, the config.yml, between a save and reload, is never changed when you don't want it to. This also keeps code comments inside the YML files stay intact, exactly the way you left them from last edit allowing you to leave yourself and others detailed notes and ideas.
This file can be reloaded from disk to Denizen memory at any time by using /denizen reload. Some changes in the config.yml may require a restart of the server. This includes interact_delay_in_ticks, but is not limited to that config node.
}}


{{codebox|height=300px|Default Denizen config.yml|<syntaxhighlight lang="yaml">
# OPs can sneak and right click a NPC to see information about the NPC. If disabled,
# the command '/denizen info' can still be used to obtain the information.
right_click_and_sneak_info_mode_enabled: true
# Interact delay sets the pace of the 'Player Queue' and 'Denizen Queue'
# execution, which is where commands triggered by scripts are stored.
# Recommend 10-20.
interact_delay_in_ticks: 10
# How long should the maximum line length be for multi-line text?
multi_line_text_maximum_length: 55
# By default, players can talk to Denizens even if there are no
# chat triggers in the script. I believe this is best for RPG-type
# behavior. Change this to true if you would like chat near a
# Denizen to be global if there are no chat triggers for the
# script being triggered.
chat_globally_if_no_chat_triggers: false
# Furthermore, if there are chat triggers available, and the Player
# doesn't match one, should the player still talk and recieve a
# response from the Denizen, or should he just chat globally and
# ignore the Denizen. Change this to true if you would like
# chat near a Denizen to be global if there are available chat
# triggers, but the player failed to match one.
chat_globally_if_failed_chat_triggers: false
# Should players around the player interacting with the Denizen
# hear the conversation?
bystanders_hear_player_to_npc_chat: true
bystanders_hear_npc_to_player_chat: true
# This set of nodes defines ranges for different types of
# chat/interaction/etc.
player_to_npc_chat_range_in_blocks: 2
npc_to_player_chat_range_in_blocks: 7
npc_emote_range_in_blocks: 7
player_to_npc_shout_range_in_blocks: 15
npc_to_player_shout_range_in_blocks: 15
player_to_npc_whisper_range_in_blocks: 2
npc_to_player_whisper_range_in_blocks: 3
# These nodes define how chatting, shouting, etc. is displayed
# to players in the game. <PLAYER>, <NPC>, and <TEXT> are all
# replaceable variables. Remember to use " around your string
# if your text contains a single apostrophe.
player_chat_to_npc: "You say to <NPC>, '<TEXT>'"
player_chat_to_npc_bystander: "<PLAYER> says to <NPC>, '<TEXT>'"
npc_chat_to_bystanders: "<NPC> says, '<TEXT>'"
npc_chat_to_player: "<NPC> says to you, '<TEXT>'"
npc_chat_to_player_bystander: "<NPC> says to <PLAYER>, '<TEXT>'"
player_whisper_to_npc: "You whisper to <NPC>, '<TEXT>'"
player_whisper_to_npc_bystander: "<PLAYER> whispers something to <NPC>."
npc_whisper_to_bystanders: "<NPC> whispers, '<TEXT>'"
npc_whisper_to_player: "<NPC> whispers to you, '<TEXT>'"
npc_whisper_to_player_bystander: "<NPC> whispers something to <PLAYER>."
player_shout_to_bystanders: "You shout, '<TEXT>'"
player_shout_to_bystanders_bystander: "<PLAYER> shouts, '<TEXT>'"
npc_shout_to_bystanders: "<NPC> shouts, '<TEXT>'"
npc_shout_to_player: "<NPC> shouts at you, '<TEXT>'"
npc_shout_to_player_bystander: "<NPC> shouts at <PLAYER>, '<TEXT>'"
# Default texts that Denizens use when interacting. These
# can also be set per-denizen, which will override the
# defaults set below.
default_no_requirements_met_text: Sorry, I have nothing else for you right now.
</syntaxhighlight>
}}

Latest revision as of 18:25, 8 August 2012