Denizen/0.7

Denizen is an extension for Citizens that allows scripting of NPCs to handle tasks, quests, player interaction and more! Current Version: 0.7 BETA Developers: aufdemranda Source: Github Development Builds: Jenkins Latest Developmental Build: 2.0.2 Support tickets: Tickets on Github, but please read the entirety of this document first. Donate: A lot of man hours has been put into Denizen. Your donations add a lot to the project and are always welcome! Your donations will probably help remodel my house and feed my kids. :) Donate to aufdemrand Don't forget to donate to the Citizens2 project as well, as none of this would be possible without that! Thank You: A lot of people have stepped forward to help out with Denizen, and that's awesome! Special thanks to everyone who has beta tested, and a huge to these people: fullwall, AgentKid, aPunch, NeonMaster, Instinx, tenowg, groggluebutt, Wreyth, jrbudda, spidi, the list could go on! CitizensUI: For a GUI interface, check out CitizensUI by jrbudda which provides an interface for Citizens NPCs as well as managing scripts and other NPC types.

http://www.youtube.com/watch?v=oKTe8-joBUI

While Denizen is in BETA, consider this page under construction! If you run into any inaccuracies, or you have any questions not provided by this document, please let us know in #DENIZEN-DEV on EsperNET.


Denizens are a great way to add MUD-style RPG Citizens to your server. Denizen NPCs use mini scripts with steps and events to interact with the player and world. Imagine interactive gate-keepers, magical wizards, experience trainers, bankers, talking townspeople and more! They can be used in thousands of different ways, from tutorials, to questing, to administrating.. your imagination is just about the limit! Though Denizen uses Scripting, it is not to be confused with Citizens2 Core Scripting which utilizes JavaScript and other major scripting languages to implement Goals. Instead, Denizen uses its own YML 'scripting language' which is designed to be easily read and edited by hand.

Denizen grants Citizens NPCs 2 major abilities: Interactions and Activities. Interactions occur when the player interacts with the NPC in some way, clicking, attacking, walking near, etc. These interactions trigger scripts based on conditions called 'Requirements'. Each interact script will run a series of commands to make the Denizen do or say something. Very complex gameplay can be created using these scripts. The other half of Denizen is activities. These scripts give the NPC continuous tasks to do that make them feel alive and provide useful functions. Wandering around, mining blocks, collecting items are all assignable activities. Denizens can perform multiple activities at one time, such as wandering and collecting garbage.

To current users upgrading from 0.6 to 0.7

First, thanks for being patient, I know there has been a lot of anxious people waiting for the new release. This took a lot longer to do than I thought, but it's worth it! Updating code and adding content is easier than ever, so keep those feature requests coming in! I also want to put out there that I took OUT the PLAYERTASK command, so please be patient with me as I know a lot of you were looking for more 'quest types'. I am instead placing this in another plugin that will extend Denizen called the Adventurer. This will have similar functionality to the 1.2 Quester, but use Denizen as the core so it can be more flexible and powerful than ever! Please note that you can get very similar functionality with a Location Trigger if you require this functionality in the mean time.

Second, a huge sorry to current faithful users. I have made a promise to myself and you to try my best to maintain compatibility throughout the evolution of Denizen. I take that seriously and try to think things out before implementing them, but that being said, I had to change some syntax around in regards to new commands to make way for cleaner code and the ability to have greater flexibility. The upside to this is there are more options and modifiers for commands than ever before! The downside is there are a few commands/etc. that you will have to check and fix syntax for if trying to run a 0.6 Denizen Script with the new builds. I've attempted to compile a list for helping with migration for users upgrading who need a brief on what needs to be changed to become compatible.

Table of Contents

• If you are having problems getting a script working please see Denizen/Troubleshooting.
• If you are just starting out, check out Getting Started.
• If you're hooked, I recommend you read all the sections in order!

1. Getting Started
2. Troubleshooting
3. Configuration
   • Permissions
4. In Game Commands
5. Writing Scripts
   • Interact Scripts
     • Trigger Types
     • Requirements
     • Commands
   • Task Scripts
   • Activity Scripts
     • Activities
6. Assigning Scripts
7. Examples
   • Beginner Scripts
   • Advanced Scripts
8. Extending Denizen
   • Custom Commands
   • Custom Requirements
   • Custom Triggers
   • Custom Activities

Script Repository

Change Log

Here's what's changed!

0.7 BETA builds #125 - #280:

• Updated! Less bugs! We're still in beta, but there has been some major code cleanup!

• New! Triggers, Commands, Requirements and Activities are now extensible by plugin programmers. See: Custom Denizen Commands on the Citizens2 Wiki. Documentation coming soon!

• New! Debug Mode will let you see the logic of interaction and script execution to help you find problems in scripts faster than ever. I'm striving to make this as informational and clean as possible to help you test your scripts and get good feedback on behavior.

• New! Info-Click lets you see Denizen stats and specifics, such as script assignments, trigger status, activity schedule and associated bookmarks with just a crouch and a click. Requires OP.. use this!

• New! Proximity Triggers can trigger a script when a Player comes near. The most requested trigger type I got during the previous betas.

• New! Location Triggers can trigger a script when a Player walks over a Location Bookmark. This is kind of like a PLAYERTASK LOCATION, but better! :)

• New! Damage Triggers separate the left and right clicks for more control over interaction. Look forward to a whole new set of commands to go along with this!

• New! Script Overlay mode is a whole new way to assign a script. Less copying/pasting when working with multiple scripts, not to mention more control! If you're an advanced script-user, this is for you!

• New! ANNOUNCE command can make global server announcements.

• New! RANDOM command will leave command execution to chance. Duck-duck-goose.

• New! HINT command will hint to the Player acceptable Chat Triggers for the current step and script. Language support coming soon!

• New! FLAG command lets you set 'flags', on players to store progress, important information, or other variables that can be used with the FLAG requirement. This is HUGE!

• New! FLAG requirement can require special flags and values to be set in order to be eligible for a script. Again, this is HUGE!

• New! POWERED requirement can check if a block bookmark has redstone power. Great idea, instinx!

• New! The activity engine has been implemented which will allow your Denizens to do things on their own. There's a whole lot more to this concept, but you can try out the new WANDER activity in all its glory. This thing is cool, and customizable!

• New! In-game commands now let you easily manage triggers, bookmarks, and debug info.

• Updated! Extended/unified command syntax for almost every existing command. Once you get over the pain of upgrading, you will drop a jaw at the new capabilities!

You can see more at the full Denizen changelog.