Denizen/0.7/config.yml: Difference between revisions

Revision as of 04:03, 13 September 2012

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: @@
-== Denizen config.yml ==
+<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>
-The Denizen config.yml contains nodes to alter the default behavior and look of Denizen.
+<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 does not automatically create this file!
-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.
+== Denizen config.yml ==
+<div style="margin-right:2.0em; margin-top:35px; 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>
-To change the Denizen defaults:
-*Create a file called config.yml and place it in the plugins\Denizen\ directory.
-*Copy the code below into that file.
-*Edit the defaults, and call /denizen reload from in-game.
-==== Default config.yml ====
+=== Default config.yml ===
-<div style="margin-right:2.0em; padding:10px; font-family:museo-sans; font-size:110%;">
+<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,