Denizen

Denizen

Meta Documentation | Issue Tracker | New Script Repository | Old Script Repository | Tutorial Videos

Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk.

Denizen uses a pasting service provided by its developers to enable recording of debug sessions. This allows an easy and universal way to troubleshoot a script. It is only used on '/denizen submit', however this service is not endorsed by the BukkitDev staff. Use it at your own risk.

IRC channel | Source code | Development builds

About

Hey there! Thanks for using Denizen for Bukkit and Citizens2. Looking for a quick starting guide? Here's the place!

So, what is Denizen? It's is best classified as a scripting platform. Denizen for Bukkit and Citizens2 utilizes the scripting, and various other components provided by DenizenAPI. The scripting component of Denizen features easy to use script containers, replaceable tags, commands, and a queue system. Built aside is a slew of components that deal with many kinds of event handlers, many additional NPC features, a fully-featured variable system (we call them 'flags'), and a rich object-oriented set of features. I encourage users to start small when first getting into Denizen, but rest assured there are tons of features to explore.

Denizen NPCs? Yep, that's right. Denizen is probably best known as a way to create scripted Citizen NPCs. In fact, this whole project started out as an extension to Citizens2. You can use it to make interactive NPCs with the use of Assignment Scripts and Interact Scripts. This is pretty easy to do, and there's a bunch of cool NPC specific (among many other) commands and tags that you can utilize as well.

Here's a small example I call 'cookies'. I normally like to comment my scripts, but this one below is presented without any as to show the flow.

Cookies:
  type: assignment 
  interact scripts: 
  - 100 Cookie Handler 

Cookie Handler:
  type: interact 
  steps: 
    'Spreading the Word*': 
      click trigger: 
        script: 
        - random 3 
        - chat 'I like cookies!' 
        - chat 'MMmm.. cookies are favorite!' 
        - chat 'Cocoa and wheat me freak!' 
      chat trigger: 
        'Cookies': 
          trigger: 'I love /cookie/s!' 
          script:  
          - chat 'Me too!' 
          - narrate '<npc.name> gives you some cookies.' 
          - give i@cookie qty:6 
          - zap 'step:Cookies given' 
    'Cookies given': 
        click trigger: 
            script: 
            - chat 'How were the cookies?' 
            - zap 'step:Spreading the Word'

It's a simple 2-step, multi-trigger script that creates a cookie loving NPC. For some reason I think it's funny to name the NPC 'Notch'. Making a NPC use this script couldn't be easier, either. Simply use a bukkit command while having the NPC selected. It looks like this:

/npc assignment --set cookies

Now clicking on your NPC will use Denizen Triggers to activate the script above. An instant Denizen NPC! Cookies is funny, but hardly useful, and it's my personal philosophy that NPCs should be useful. How 'bout a simple healer? This NPC will heal you, but only when you're seriously injured.

Basic Healer: 
  type: assignment 
  interact scripts: 
  - 100 heal me, bro! 

Heal me, bro!: 
  type: interact 
  steps: 
    "Need a heal?*": 
      click trigger: 
        script: 
        - if '<player.health>' < '<m:<player.health.max> / 2>' { 
            - look <player.location> 
            - chat 'Woah dude, you are <player.health.formatted>! You could use a heal!' 
            - chat 'Just give me another click to get some power!' 
            - zap "Healin'" duration:30s 
          } else { 
            - look <player.location> 
            - chat 'Nice an healthy. Keep it up!'  
          } 
    "Healin'": 
      click trigger: 
        script: 
        - ^zap 'need a heal?' 
        - ^engage 
        - chat "Here goes nothin'!" 
        - playeffect instant_spell <npc.location> qty:25 
        - playeffect heart <player.location> qty:25 offset:1 
        - heal <player> 
        - disengage

How do you make a Healer NPC with this script? You guess it! Just select that NPC, and type:

/npc assignment --set 'basic healer'

It's not just for NPCs. I guess I already told you that, but Denizen has some other script types that open up possibilities that extend far beyond it's core functionality of utilizing NPCs. One of my favorite 'simple scripts' that I like to show people is one that my friend Blankiito showed me. The one below is slightly modified, but basically it enables a 'rogue-like feature' that makes a player invisible when sneaking. It's a simple concept, but perfectly illustrates the flow of a Denizen Script.

Rogue:
  type: world
  debug: false
  events:
    on player starts sneaking:
    - playeffect <p.location> magic_crit qty:10
    - invisible <player> state:true

    on player stops sneaking:
    - invisible <player> state:false

Even small scripts can be incredibly useful for your server. Sometimes scripts can replace entire bukkit plugins, and since the 'code' is in Denizen Script, the end result is often times more flexible to you, the server operator. Have a plugin that run some commands every once in awhile? Replace it with a simple Denizen script.

Auto Save Event Handler:
  type: world
  debug: false
  events:
    on 5:00 in world:
    - announce 'Autosaving...'
    - execute as_server 'denizen save'
    - execute as_server 'citizens save'
    - execute as_server 'save-all'

Use Denizen to solve problems, or to make features easier to use. Example: If you're familiar with Citizens, you may have realized that WorldGuard's /butcher command is not friendly to mob-type NPCs. It removes them, too, which can be a pain! Why not write your own /butcher command?

Safer Butcher Handler: 
  type: world 
  debug: false 
  events: 
    on sbutcher command:  
    - narrate 'Removing all mob entities within 15 blocks... your NPCs are safe!'  
    - foreach <player.location.find.entities.within[15]> {  
        - if <%value%.is_mob>  
          remove %value%  
      }

Denizen Quests are the best quests. If you're like me, this whole thing started by using the Quester for Citizens1. It featured a fairly simple questing structure to implement things like 'kill quests' and 'collection quests'. When Citizens went to version 2, that functionality was no longer 'core', but no worries Denizen can help! By utilizing Denizen's Player Listeners, simple questing can be done easily, and it's more robust because you can use all the other features implemented by Denizen, too!

So, how do you best get started? This is a question we get all the time. Because of the enormous amount of ways to use and customize Denizen, we suggest that you simply START SMALL! Checking out the videos, scripts, and articles on denizen-docs you're sure to find a comfortable place to start. While scripting, utilize the tools provided, such as the SublimeText2 grammar pack, and the reference and search for meta lookup on this site.

Like any programming language, there is a learning curve with code structure and syntax that will only be overcome by trial and error. While using some user-made scripts can be as easy as dragging-and-dropping, many scripts will likely require at least a basic understanding of the denizen-script structure to fully utilize their features. But don't worry! Denizen is purposefully made to be easy to read and easy to customize! Tags, commands and events are all very verbose, easy to follow. With a little bit of research we know you'll soon be drunken with power, just like us!

Videos

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of HalestormXV HalestormXV Aug 28, 2015 at 17:48 UTC - 0 likes

    Hey there. I am using Denizen, for my 1.7.10 version. Yes I know it is an older version however I am curious to know if this issue could be fixed. It is actually causing my log file to get upwards of 300MB in size. The error seems to have actually been reproduced already here: https://github.com/DenizenScript/Denizen-for-Bukkit/issues/227

    However as indicated it says this is no longer an issue in the .9+ updates.

    Now I do know that his error is actually harmless as it is having no negative impact on my server whatsoever EXCEPT spamming my log files to kingdomcome. Is there anyway that the 0.9.5 version can be fixed just to stop this error from spamming? Hell I'd be more than happy to do it if I could casue like I said, it really is harmless but the huge log file sizes are not cool. I ask this because I know it is an older version but I am sure many might still use that version.

  • Avatar of speedsnip speedsnip Aug 26, 2015 at 22:43 UTC - 0 likes

    Hi !

    Denizen crash my server with spigot 1.8.7 and 1.8.8 :/

    Fix that plzzzzzz !

    EDIT : ... sorry i delete Citizens and ALL Works...

    EDIT : :/ i don't understand.. all works now but i do nothing...

    Last edited Aug 27, 2015 by speedsnip
  • Avatar of Sean_Amor Sean_Amor Aug 26, 2015 at 19:13 UTC - 0 likes

    Top notch Plugin, completely what you make of it. 5 STARS! Below is Very Simple Example Template for Fetch Quests w/Cooldown : http://pastebin.com/GCxwsmQT

    Last edited Aug 26, 2015 by Sean_Amor
  • Avatar of Keitokun Keitokun Aug 18, 2015 at 13:07 UTC - 0 likes

    @omgitsbob12: Go

    I can confirm that. Same here.

  • Avatar of omgitsbob12 omgitsbob12 Aug 18, 2015 at 02:08 UTC - 0 likes

    @mcmonkey4eva: Go

    If I removed Denizen it stops crashing but when I re-add it starts crashing again I tried testing it with other plugins Citizens etc it started since the 0.9.7 build

  • Avatar of mcmonkey4eva mcmonkey4eva Aug 18, 2015 at 01:21 UTC - 0 likes

    @omgitsbob12: Go

    That's not Denizen.

  • Avatar of omgitsbob12 omgitsbob12 Aug 17, 2015 at 17:57 UTC - 0 likes

    Denizen randomly crashing

    http://pastebin.com/K1ry0A9s

  • Avatar of dwatsX dwatsX Aug 11, 2015 at 14:51 UTC - 0 likes

    Can you recommend what version of spigot to use with the latest dev builds of Denizen and Citizens? I've got it working flawlessly on 1.7.9 but as soon as I run any 1.8+ version of spigot, Denizen won't read my scripts properly. I've tried several versions of each plugin, while trying to use corresponding versions of spigot that I figure should be compatible. I figure the reason my scripts aren't reading properly has to be due to a version compatibility issue. Unless you can suggest another reason why the scripts would run on 1.7.9 but not 1.8+?

  • Avatar of mcmonkey4eva mcmonkey4eva Aug 02, 2015 at 23:44 UTC - 0 likes

    @ineedhelpplz: Go

    You need to post the error if you expect any support.

    Your Server Folder -> logs -> latest.log (a text file) -> copy/paste everything into http://pastebin.com -> submit it -> post the link here as a reply comment

  • Avatar of ineedhelpplz ineedhelpplz Aug 02, 2015 at 21:46 UTC - 0 likes

    Okay, so I just wanna download Denizen but for some reason I get an error every time i try. My plugins include: Animal Shop, BlackSmith, Builder, Chairs, Citizens, dltTraders, Essentials (regular, chat, and spawn) pEX, Sentry, Timber, Vault, and WorldEdit.

    Don't try and tell me its the outdated version of denizen because its not, i swear (denizen-0.9.7-SNAPSHOT.jar). Also if you need my latest log or something please tell me how to post it.

    please please help

    Last edited Aug 02, 2015 by ineedhelpplz

Facts

Date created
May 21, 2012
Categories
Last update
Jul 18, 2015
Development stage
Beta
Language
  • enUS
License
GNU General Public License version 3 (GPLv3)
Curse link
Denizen
Downloads
46,166
Recent files

Authors