Denizen/0.7/config.yml: Difference between revisions

Latest revision as of 18:58, 3 September 2021

For more up-to-date information and full details on specific features (individual commands or tags, for example), check the Meta Documentation.

If you want a full tutorial to help get you set up, check out the Beginner's Guide text website.

If you need quick help, visit our Discord group.

This wiki is outdated, please view the tutorial videos/guide, meta documentation, or Discord group (all linked above) for up-to-date information!

Contents

1 Denizen config.yml

2 Default config.yml

The config.yml is where the knobs and levers are for controlling the interworkings of Denizen and its Script Engine. We've taken as many opportunities as possible to make certain that built-in functionality is as customizable as possible. This includes allowing adjustments to low-level denizen functions, such as the length of an interact_delay, to high-level things such as text formatting.

Denizen config.yml

The Denizen config.yml contains nodes to alter the default behavior and look of Denizen.
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.
To change the Denizen defaults:

Open config.yml located in the plugins\Denizen\ directory.

Edit the defaults, save the file, and call /denizen reload from in-game or the console. Denizen will alert you of a successful reload.

Default config.yml

Code: Default Denizen config.yml

{{{2}}}

@@ Line 1: / Line 1: @@
-{{Quote|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.
+For more up-to-date information and full details on specific features (individual commands or tags, for example), check the [https://meta.denizenscript.com/ Meta Documentation].
+If you want a full tutorial to help get you set up, check out the [https://guide.denizenscript.com/ Beginner's Guide] text website.
+If you need quick help, visit our [https://discord.gg/Q6pZGSR Discord group].
+<br><br><br>
+<span style="font-family:natalya-alternate-one; font-size:300%; margin-right:-7px; margin-left:-10px;">This wiki is outdated, please view the tutorial videos/guide, meta documentation, or Discord group (all linked above) for up-to-date information!</span>
+<br><br><br>
+<s><div style="font-family:camingodos-web;">
+<div style="float:right;margin-left:2.0em; padding:10px; font-family:camingodos-web; font-size:110%; ">__TOC__</div>
+<div style="margin-right:2.0em; margin-top:35px; padding:10px; font-family:camingodos-web; font-size:110%;">
+<span style="font-family:natalya-alternate-one; font-size:650%; margin-right:-7px; margin-left:-10px;">T</span>he config.yml is where the knobs and levers are for controlling the interworkings of Denizen and its Script Engine. We've taken as many opportunities as possible to make certain that built-in functionality is as customizable as possible. This includes allowing adjustments to low-level denizen functions, such as the length of an interact_delay, to high-level things such as text formatting.
+</div>
+=== Denizen config.yml ===
+<div style="margin-right:2.0em;padding:10px; font-family:camingodos-web; font-size:110%;">The Denizen config.yml contains nodes to alter the default behavior and look of Denizen.
 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.
-}}
+To change the Denizen defaults:
+* Open config.yml located in the plugins\Denizen\ directory.
+* Edit the defaults, save the file, and call /denizen reload from in-game or the console. Denizen will alert you of a successful reload.
+</div>
+=== Default config.yml ===
+<div style="margin-right:2.0em; margin-top:35px; padding:10px; font-family:camingodos-web; font-size:110%;">
 {{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
+# Default time in seconds of cooldown set to Denizens when a trigger is triggered.
+default_click_cooldown_in_seconds: 2.0
+default_location_cooldown_in_seconds: 30.0
+default_proximity_cooldown_in_seconds: 15.0
+default_death_cooldown_in_seconds: 0.0
+default_damage_cooldown_in_seconds: 0.5
+default_chat_cooldown_in_seconds: 2.0
+# if the damage trigger (left click) is disabled. Select false if you would prefer
+# to have click triggers activate with the right mouse button only.
+disabled_damage_trigger_instead_triggers_click: false
+# Default engage timeout. When NPCs are set to ENGAGE, this is the default timeout
+# that they DISENGAGE if not specified. (Default, 5 minutes)
+engage_timeout_in_seconds: 150
 # Interact delay sets the pace of the 'Player Queue' and 'Denizen Queue'
@@ Line 30: / Line 86: @@
 # triggers, but the player failed to match one.
 chat_globally_if_failed_chat_triggers: false
+# Also.. if the Denizen happens to be un-interactable
+# (Engaged, or not cooled-down, for instance), by default
+# chat is still targeted to the NPC. You can turn this
+# behavior off by changing this config node to true.
+chat_globally_if_not_interactable: false
 # Should players around the player interacting with the Denizen
@@ Line 45: / Line 107: @@
 player_to_npc_whisper_range_in_blocks: 2
 npc_to_player_whisper_range_in_blocks: 3
+proximity_trigger_range_in_blocks: 3
+location_trigger_range_in_blocks: 1
 # These nodes define how chatting, shouting, etc. is displayed
@@ Line 67: / Line 131: @@
 npc_shout_to_player: "<NPC> shouts at you, '<TEXT>'"
 npc_shout_to_player_bystander: "<NPC> shouts at <PLAYER>, '<TEXT>'"
+npc_hint_prefix: "[HINT] You can say: "
 # 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.
+default_denizen_unavailable_text: "I'm busy at the moment, can't you see?"
+default_no_click_trigger_text: "I have nothing else for you right now."
+default_no_damage_trigger_text: "Ouch! That hurts!"
+default_no_chat_trigger_text: "Sorry, I don't understand."
 </syntaxhighlight>
 }}
+</div>
+[[Category:Denizen 0.7]]</s>