Revision as of 18:27, 13 June 2012

Denizen

Author	aufdemrand
Version	0.6 Build #86
Citizens build	2.0 dev build (Latest)
Other dependencies	Vault, a permissions system, and an economy system
Download	Link
Download example scripts:	Link

Description: Scriptable, interactive citizens!

Denizens are a great way to add MUD-style RPG Citizens (and some other features) to your server. Denizen NPCs use mini scripts with steps and events to interact with the player and world. They can be used in thousands of different ways, from tutorials, to questing, to administrating and more!

Script Repository:
Want to share your scripts that you've created for Denizen?

Submit your Denizens Scripts here to share.
View Shared Scripts

Changelog:

0.6 Build #82

Requirements code reformat is done, thanks for being patient if you were watching the Jenkins!
FINISH command now increments a counter so you can check for a certain number of FINISHes. Use: FINISHED (# of times) [name of script]. The # is optional and will assume 1 if not specified. There's a chance that this broke any recorded FINISHes that may be in your config. Sorry about that. You can manually change them from True to 1 to fix this. New FINISHes will overwrite without any issues.
TIME requirement can now check for DAWN and DUSK in addition to DAY and NIGHT.
Requirements that use items can now use the #:# (typeId:data) format. So, for gray wool, 35:7. You can still specify just WOOL and any color will do.
Script combiner will now only read .yml files, this fixes issues with hidden files in your scripts file corrupting the combined read-only-scripts.yml.
NAME, WORLD, PERMISSION, GROUP, POTION_EFFECT can now all use multiple arguments. For example, WORLD world_1 world_2 world_3 world_4 will return true if one of the worlds listed matches. You can use up to 24 arguments.

0.6 Build #71

Started code reformat, this will make it easier to extend.
Added ability to use multiple scripts! Denizen will read any .yml file in the /plugins/Denizen/scripts/ folder. You will need to place your existing scripts.yml in that folder. Denizen will generate a read-only-scripts.yml to the main Denizen folder. This should be left alone. Also made config.yml generate automatically upon startup.
Added config node chat_globally_if_no_chat_triggers

0.5.3 Build #60

PlayerQue now uses ConcurrentHashMap to avoid ConcurrentModificationException. (Thanks tenowg!)
/denizen reload and /denizen save can now be used in the console.
Check for interact_delay_in_ticks = 0 and change it to 1. (Thanks Sparta!) Probably a good idea to keep this at least 10, though.

0.5.3 Build #56

Added FAIL command. Sets the script as 'FAILED' for checking with requirements. Note: A script can still be FAILED and FINISHED, they are seperate.
Added FAILED requirement. Use FAILED [Name of Script]. Remember: SCRIPT NAMES ARE CaSe SeNsItIvE!
Added RESET command. This can be used to reset the FAILED or FINISHED status of a script. Use RESET FAILED|FINISHED [Name of Script].
Added small warning on the /denizen help stating that many commands listed there do not yet work -- this is a beta, people, I'm working on them :P
Documenting /denizen adddata|decdata|getdata. Nothing to do with Denizens, really, but handy for checking/switching block data. Try it on a tree.
Fixed WAIT command. It actually works as intended now.

0.5.3 Build #48

Extended use of LOOK command. Can now specify a location bookmark to set Pitch and Yaw of a Denizen. Note: When making Location Bookmarks, your Pitch and Yaw are recorded along with your XYZ position. Use: LOOK [Location Bookmark]. Existing arguments, CLOSE and AWAY, are still valid. Additional note: LOOK CLOSE will override the set pitch/yaw, so be sure LOOK AWAY is used beforehand, or be sure LOOK CLOSE was not engaged.
Fixed issue with RESPAWN command.
Fixed issue with talking to Denizens close to one another. Players now only speak to the very closest Denizen.
Added TELEPORT command to teleport the player to a Denizen's location bookmark. Use TELEPORT [Location Bookmark].
Added REFUSE command to take a permission from the player. Use REFUSE [name.of.permission.node].

It is suggested you use the latest builds of C2.

0.5.3 Build #42

SWITCH now activates redstone. Sorry about that folks.
WAIT command added.
SPAWN command added.
Other code optimizations/cleanup.

Big thanks to the hardworking beta testers in #citizens! Thank you!

0.5.3 Build #25

NARRATE command now replaces <NPC> properly.
Denizens no longer requires you to be the owner of the NPC to use commands.
Tweaked multi-line engine to accomodate for extra long names.
ZAP now uses getName instead of getDisplayName (Sorry if this causes issues with current progress.)

0.5.3 Alpha

Added SWITCH command. Denizens can now flip levers!
Added Denizen Project to Citizens Jenkins!

0.5.2 Alpha:

Fixed requirements WEARING and -TIME. Note: PermissionsBukkit users are still having problems with GROUP.
Added FOLLOW, TAKE, NARRATE, and CAST commands.

Smaller update than I planned, stay tuned for more!

0.5.1 Alpha:

Fixed requirements... they should all work now, except haven't tested requirements which can have an enchantment.
Added the ability to give Denizens 'Location Bookmarks'. Use /denizen bookmark location [name].
Added WALKTO, PERMISS, FINISH, RESPAWN, WEATHER and EXECUTE commands.
Started to flesh out /denizen help
Added activity scheduler.

Known caveats

I've been having problems getting the NPCs to WALKTO a bookmarked location that is far away. This seems to be a bug beyond Denizen and Citizens2. I have a possible fix and am looking in to it.

Before using Denizens

Denizens are in BETA! Expect bugs! There is very little error handling for scripts that contain bad syntax. If you do come across any errors, please report them to the Github Issues page for Denizens. You can also get assistance with Denizens on the #citizens IRC channel on EsperNET from me (aufdemrand) when available. I'm usually there working hard to add awesome features and squashing bugs.

Denizen is not a drag-and-go type of plugin. In fact, Denizen won't do anything unless you assign and define scripts to NPCs. It's highly customizable and you should expect that to be able to write scripts, it is suggested you read the entirety of this wiki document. I'm always around IRC to help out, but please don't ask about the basics unless you have consulted here first.

Denizens REQUIRES you to have Vault installed. You also should have a Permissions System and and Economy System for best results.

Getting started with Denizen

The easiest way to use Denizen for the first time is to download the Start-up Kit with sample .yml configuration files and scripts.

File Structure

Denizen File Structure

File structure.

A basic trigger script

First, we need a script. Scripts can be simple or very powerful, thanks to a wide array of commands and functions at your disposal. Each script has at least 2 parts, Requirements and Steps. For now, let's take this very simple script as an example. We'll get more detailed later on.

Scripts are defined in plugins/Denizen/scripts/nameofscript.yml. See the main scripts section for more information.

'Daytime in the City':   
  Type: Trigger
  Requirements:
    Mode: All
    List:
    - TIME Day
  Steps:
    1:
      Click Trigger:
        Script:
        - CHAT Welcome to the city! Isn't it beautiful in the daytime?

So what just happened there? A quick literal translation: This script is named 'Daytime in the City'. This name is used when assigning Denizen NPCs their scripts to use. When the script is called by a trigger, in this case a 'Click Trigger', for it to activate the Requirements set must be met, more specifically ALL of the requirements set. In this example, the only requirement is that the time in the world is daytime. If the Requirements are met, the script defined in the 'Click Trigger' is sent to be run. It will have the Denizen NPC chat to the player 'Welcome to the city! Isn't it beautiful in the daytime?'.

But before the script can be triggered, it needs to be assigned.

A basic assignment

In order for a Denizen to be associated with a script, he needs to be assigned to it. The following shows a simple assignment format.

Assignments are defined in the Denizens node found in plugins/Denizen/config.yml and must be done by hand, for now. Once you edit the config.yml, immediately save and use /denizen reload in-game.

Denizens:                         
  'Steve':                        
    Interact Scripts:                      
    - 10 Daytime in the City  
    Texts:
      No Scripts To Trigger: 'I have nothing to say to you at this time.'

Another literal translation. This assignement will work for Denizens named 'Steve'. Triggers that involve this NPC, such as a 'Click Trigger' will call the script named 'Daytime in the City'. The 10 before the name is the script priority, useful when assigning multiple scripts, but we'll get into that next. If no scripts meet requirements (in this case -- if it's NOT daytime when clicking on Steve), 'No Scripts To Trigger' will run instead. So to reiterate, if the player clicks on Steve during the daytime, the player will get a chat containing 'Welcome to the city! Isn't it beautiful in the daytime?' If the player clicks during the nighttime, since the script requirements are not met, the player will see a chat containing 'I have nothing to say to you at this time.'

Multiple Scripts

The key to Denizens being dynamic is their ability to handle multiple situations. This is done by multiple script assignments. Let's take this example configs below to see how script priority is handled.

---- Config.yml ----

Denizens:                         
  'Steve':                        
    Interact Scripts:                      
      - 0 Regular Joe
      - 10 Joe the Builder  

---- Scripts.yml ----

'Regular Joe':
  Type: Trigger   
  Requirements:
    Mode: None
  Steps:
    1:
      Click Trigger:
        Script:
        - CHAT Hello <PLAYER>! I supply builders only!

'Joe the Builder':
  Type: Trigger   
  Requirements:
    Mode: All
    List:
    - PERMISSION modifyworld.*
  Steps:
    1:
      Click Trigger:
        Script:
        - CHAT Hello <PLAYER> the Builder! Take this shovel!
        - GIVE WOOD_SPADE 1
        - FINISH

Denizen Steve has been assigned two scripts. Upon player interaction, each script is checked for met requirements. If only one script has their requirements met, it's clear what script will be returned. But what if both meet requirements? That's where the number before each script assigned comes in. Higher priority always wins. To break down this specific situation, if a player with the 'modifyworld.*' permission clicks on Steve, both scripts meet the requirements, but since the script 'Joe the Builder' has a priority of 10, and 'Regular Joe' only has a priority of 0, 'Joe the Builder' sends its script. 'Regular Joe' is simply ignored. Denizens can be issued as many scripts as you want. If two scripts have the same priority, the first in the list will be the one to trigger, if both scripts meet their requirements.

Some other basic things to note

Denizens with the same name use the same script assignments. The plus to this is the ability to quickly make 'generic NPCs' such as a 'Townsman' or 'Miner'.

In the YAML files, nodes are case sensitive! 'Scripts:' will work. 'scripts:' will not! All nodes are first letter capital, rest of the word lowercase.

YAML Ain't Markup Lanugage

All the scripts and configuration nodes are in YAML. Remember! Spacing is CRITICAL when dealing with YAML files. Each parent node and sibling node should follow the spacing and formatting guidelines set forth by the YAML 1.0 standard.

From the official 1.0 YAML Specs, this is section 4.2.1 on Indentation:

YAML streams use lines and spaces to convey structure. This requires special processing rules for white space (space and tab).

In a YAML character stream, structure is often determined from indentation, where indentation is defined as a line break character followed by zero or more space characters. With one notable exception, a node must be more indented than its parent node. All sibling nodes must use the exact same indentation level, however the content of each such node could be further indented. Indentation is used exclusively to delineate structure and is otherwise ignored; in particular, indentation characters must never be considered part of the document's content.

Tab characters are not allowed in indentation since different systems treat tabs differently. To maintain portability, YAML's tab policy is conservative; they shall not be used. Note that most modern editors may be configured so that pressing the tab key results in the insertion of an appropriate number of spaces.

In all the examples used in this guide, 2 spaces are used for indenting. Generally, whatever you choose should be maintained through your YAML document.

YAML tutorials can be intimidating, but this small tutorial on the Essentials wiki is pretty useful for basic YAML, which is the extent of which Denizens uses.

Denizens Node in detail

In addition to handling the script assignments, there are also a few other things that are declared in the Denizens node. Let's take this example to show the different options. Note: Some of the functionality in this has not yet been discussed, you may need to read further.

Denizens:

 'Steve':                        
   Interact Scripts:                      
     - 10 Joe the Builder  
   Options:
     Languages: HU EN
     Chat Name: Steve the Master Builder 
     Finish Cooldown: 600
   Texts:
     Finish Cooldown:
     No Scripts To Trigger: I have nothing for you at this time!
     Interact Cooldown: That's all I have for now! Come back later!

Denizen Options

Languages:
~~Adds a spoken/understood language to the Denizen. Languages are defined in the Languages: node. See: #Languages~~

Finish Cooldown:
Sets a delay for the speed in which you can trigger scripts between FINISHes. If the selected script only has a simple reward, this is a way to control how fast the player can re-trigger the NPC. In the above example, clicking on Steve will trigger the script 'Joe the Builder' in which he hands over a Shovel. With an interact cooldown specified, it keeps the player from getting a shovel every click. Instead, the player must wait 600 seconds. This will also delay any other script from triggering, if the script is required! Useful scenario: Script 1 gives a wood shovel, Script 2 gives a wood sword, but requires Script 1 to be complete first. To keep the player from redeeming Script 2 right away, use a Finish Cooldown.

Chat Name:
Allows you to expand on a Denizens name, or completely change it. If this is set, all chat heard from the Denizen will use this 'Chat Name' instead of the actual NPCs name, which can only be one word. Note: On Human NPCs, this will NOT change the name above them in-game. For now, that is coded into the Minecraft client, which this plugin can not modify.

Denizen Texts

No Scripts To Trigger:
If no scripts meet requirements, this message is CHATted instead.

Cooldown Not Yet Met:
If an Interact Cooldown: is set and not yet satisfied, this message is CHATted instead.

Scripts Node in detail

The general structure of a script should always include the 'Name', 'Requirements', and 'Steps' nodes. These are required. You can optionally include 'Options', which include other conditions, such as if the script should have a cool-down or is not repeatable.

Scripts are defined in the plugins/Denizen/scripts/ folder. Any .yml file in that directory will be loaded into Denizen. For example purposes on this website, reference to scripts.yml is made.

General layout of a Script

'Name of script':   # Name Node
  Type: ...         # Type Node
  Requirements:     # Requirements Node
    ...:
    ...:
      - ...
      - ...
  Steps:            # Steps Node
    ...:
      - ...
    ...:
  Options:          # Options Node
    ...:

Name Node

This node is pretty self-explanatory, but here are some things to keep in mind.

Names, just like nodes are case-sensitive! 'This script name' is different than 'THIS SCRIPT NAME'.
Names that contain spaces must have single or double quotes around it. ie: "This script": or 'This script': is acceptable.
If the name includes a single quote in it, you must use double quotes around it, or 'escape' the quote with another quote. ie: "John's Script": or 'John''s Script':

Type Node

I've been getting questions about the type node. The truth is, while this isn't technically required as of yet, there will soon be a couple more different types of scripts, and for the sake of forward compatibility, I believe this node will be used to easily distinguish between the different types. For the scripts that are explained here, use Type: Trigger. In the near future I have planned Activity type scripts and another types I haven't come up with a good name for, yet :D

Requirements Node

This node sets the rules for the player to qualify for the script. There are a couple different options that you should know when using requirements. For example:

  Requirements:
    Mode: All
    List:
    - TIME Night
    - MONEY 1000000
    - STORMY

This would be a difficult script to obtain, for sure. To trigger, the time would have to be after 16000, but before 0, the player would need one million dollars on hand (or whatever economy you use), and the weather must be storming! But it shows the flexibility of requirements. First is the 'Mode'. Currently there are three different types. Second is the requirement type, with arguments if applicable.

Mode Types

[] indicates required field

ALL
Requires all requirements listed to be met.

ANY [#]
Requires the specified number of requirements to be met, out of the total of requirements listed.

NONE
Requires NO requirements to be met.

Requirements Types

[] indicates required field, () indicates an optional field, OR indicates alternative usage.

NAME [Player Name] (or this Player Name) ...
Requires a specific player.

ITEM [#:#] (# of that item, or more)
Requires the player to have an item in their inventory. You can also specify an amount.

WEARING [#]
Requires the player to be wearing a specific piece of armor.

HOLDING [#:#] (# of that item, or more)
Requires the player to have an item in their hand. You can also specify an amount.

TIME [Day|Night|Dusk|Dawn] OR TIME [0-23999] [1-24000]
Requires day or night. Alternatively you can specify a time window.

HUNGER [Full|Hungry|Starving]
Requires a specific hunger state.

PRECIPITATION
Requires a rain or snow.

SUNNY
Requires clear skies. Note: This can still trigger at night as it does not check time.

WORLD [World Name] (or this World Name) (or this World Name) ...
Requires the player to be in a specific world, or worlds. You can check as many as you'd like with one line.

PERMISSION [this.permission.node] (or this permission.node) ...
Requires one of the listed permission nodes. Only one is required. If you require multiple permission nodes, use multiple entries.

LEVEL [This Level # or higher] OR LEVEL [At least this Level #] [But no more than this Level #]
Requires a specific Minecraft XP level, or a range of levels.

FINISHED (# of times) [Script Name]
Requires a specific script to be FINISHed. Remember: Script names are case-sensitive! You can specify a certain number of times, as well. Using this as a negative requirement is a good way to put a limit on how many times a player can do a script.

FAILED [Script Name]
Requires a specific script to be FAILed. Remember: Script names are case-sensitive!

GROUP [Name of Group] (or this Group) ...
Requires the player be a member of a group. Requires a Permissions system that allows groups, such as PermissionsEX.

MONEY [Amount of Money, or more]
Requires the player to have at least a certain amount of money on hand. Requires an economy system, such as iConomy.

POTIONEFFECT [POTION_EFFECT]
Requires the player to be under the influence of a specific potion. You can use 'ANY' to specify the player just be under the influence of a potion, without being specific as to which type.

Negative Requirements Types

Requirements can also be 'negative' requirements. In the Requirements List, just place a '-' in front of the requirement to inverse its logic. For example, 'HOLDING IRON_SWORD' would require the player to be holding an Iron Sword. '-HOLDING IRON_SWORD' would require the player to NOT be holding an Iron Sword. All requirements have a negative alternative, even ones whose function overlaps, such as '-WEATHER Precipitating' and 'WEATHER Sunny' technically being the same thing. If anything, it can add to script readability.

  Requirements:
    Mode: All
    List:
    - -TIME Night
    - -MONEY 1000000
    - -STORMY

Negative requirements completely change our original example around. For this script to trigger, time needs to be Day, the weather in the current world must NOT be storming, and the player must not have more than 1000000 units of currency on them.

Steps Node

Steps are the meat of the script. They control what to listen for and what actions to take. Each script can have multiple steps, each with multiple triggers. Let's use an example.

'Welcome to Harbortown':
  Type: Trigger
  Requirements:
    Mode: NONE
  Steps:
    '1':
      Click Trigger:
        Script:
        - CHAT What's your name, stranger?
        - HINT
      Chat Trigger:
        '1':
          Trigger: My name is /<PLAYER>/.
          Script:
          - CHAT Ah ha, your name sounds familiar! 
          - CHAT Are you from around this area?
          - ZAP
    '2':
      Click Trigger:
        Script:
        - HINT
      Chat Trigger:
        '1':
          Trigger: /Yes/, I grew up in Harbortown!
          Script:
          - CHAT I thought so, welcome back! 
            Have you heard about Tom the Taylor? 
            Isn't that just horrible?
          - ZAP 3 
        '2':
          Trigger: /No/, you must be mistaken. 
          Script:
          - CHAT Oh, sorry about that. 
          - CHAT Hey, if you're looking for some work, 
            Bill the Baker is understaffed! 
            This is the bakery's busy season.
          - ZAP 4
    '3':
      Click Trigger:
        Script:
        - CHAT I wonder if Tom the Taylor is doing any better.
        - NARRATE Perhaps you should check on Tom the Taylor.
    '4':
      Click Trigger:
        Script:
        - CHAT Oh, nice to see you again <PLAYER>!
        - CHAT Have you stopped by the bakery?

The sub-sections below reference this example.

Trigger Types

Steps handle the flow of commands and messages with triggers.

Denizen Triggers trigger from interaction with Denizens. They are defined in the Steps: node.

Click Triggers activate when the Denizen is clicked on.

Click Trigger:
  Script:
  - CHAT Scripts are nested as a list.
  - CHAT You can use any command that
    you'd wish.

Chat Triggers activate when players chat with Denizens. Players' chat within the configurable range will be directed to the Denizen instead of global chat. Chat also follows the configuration setting

Chat Trigger:
  '1':
    Trigger: The word needed to /Trigger/ is inside slashes. 
    Script:
    - CHAT Scripts are nested as a list.
    - CHAT You can use any command that
      you'd wish.

Script Commands

Note: There are plenty more to come, some I've even used in examples here but aren't in the alpha. Be patient, more are coming!