Denizen
Meta Documentation | Issue Tracker | New Script Repository | Old Script Repository | Tutorial Videos | Forums
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.
HEY!
This project is moved!
Please download from:
https://www.spigotmc.org/resources/denizen.21039/
View resources at:
This Bukkit page won't be updated much!
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
Other useful links
- Denizen Handbook (Outdated kind of, but has some useful information still.)
- User-made beginner's guide
- Citizens2 Wiki
@krzycho001
How to add more than one Denizen on assigment list?
@nhoclesnar
I'll see what I can do to accomodate.
@silentnight18
We have not yet worked on that limitation.
Forgive my lack of drive to read through all the changes since I looked a few weeks ago, but have you got any WALKTO or TRAVEL or walk features working yet? Since you were having issues with moving longer distances.
@aufdemrand
Thanks :) Oh yeah, beside that, when a sentry is attacking something/someone, NoCheatPlus thinks that it is using hack lol. It says the sentry is using NoSwing. So yeah can you please add a few lines of code to make it compatible with NoCheatPlus? The other false detection NoCheatPlus got is FightSpeed. Please take a look at NoCheatPlus's API.
Another problem is that Guard starts attacking each other as soon as I set their targets as a group name. PEX somehow thinks Guard belongs to the, lets say, 'default' group. So as soon as I do '/sentry target add default', they start jumping into each other, killing each other malevolently. I hope you can put some kind of check to make sure they don't massacre each other.
@nhoclesnar
I'll work on Sentry tonight.
There is an error within Sentry. When I set the NPC's owner as Server, I cannot control him. It says 'You must be the owner of the sentry to execute commands.' And when I execute commands through console, it says 'You must be in-game to execute commands.' Plus, can you make sentries attack whoever attack them first, and have an option to make them not to drop items upon death? Being able to change a sentry's guarding radius would be cool also. The not lose items on death is pretty critical because once a guard dies, it drops all of its items. Guard then will re-spawn with the exact same set of item. Using this, players can duplicate their items easily. And I found a bug where you set speed to 1.0 it says speed must be between 0.1 and 1.0. Setting speed to 0.1 works fine tho. Thanks.
Hey all, the newest build on the Denizen Jenkins fixes an error that overwrites location bookmarks when you make a new location bookmark. If you are running into that problem, follow the link at the bottom of the post and get the latest recommended build.
Sorry about that! I have a few more things I'd like to add before posting a new build here.
@LMGH
Stop by IRC again when you get a chance, so we can help you out live. Sorry I missed you earlier.
@Curttron
Let's make sure it's not a spacing issue, first. Try this: http://pastie.org/4094633
Also: Try to download the latest build on the Citizens Jenkins: http://ci.citizensnpcs.net/view/Characters/job/Denizen/
No matter what I try, it never works and I seem to get no error messages. I even tried using examples from the wiki, everytime I click the npc that is setup with a click trigger, the npc just says: I'm sorry I have nothing to say to you at this time.
At the momment I have this very small test script/assignment setup and it still refuses to work.
===== plugins/Denizen/scripts/scripts.yml =====
'swag':
Type: Trigger
Requirements:
Mode: NONE
Steps:
'1':
Click Trigger:
Script:
- CHAT Hello this is a test
===== plugins/Denizen/assignments.yml =====
Denizens:
'TaskManager':
Interact Scripts:
- 1 swag
Can anyone help me please? much appreciated
@LMGH
Try out the latest build. By the way, the Denizen: node (that was in config.yml) now goes in its own file called assignments.yml. I'm working on documenting this for the wiki before releasing another build here on devbukkit.
Any other questions just stop by #citizens on irc.esper.net.
@aufdemrand
I'm using the latest Citizens and Denizen build.
BTW, now im getting this error 11:07:52 [WARNING] Task of 'Denizen' generated an exception java.lang.ArrayIndexOutOfBoundsException: 2 at net.aufdemrand.denizen.CommandExecuter.execute(CommandExecuter.java:290) at net.aufdemrand.denizen.ScriptEngine.commandQue(ScriptEngine.java:38) at net.aufdemrand.denizen.Denizen$1.run(Denizen.java:335)
@LMGH
Curious as to what build you are using. Also, what does your Denizens: node assignments look like?
im always getting this error when i try to interact with an Denizen NPC: 21:13:10 [WARNING] Task of 'Denizen' generated an exception java.lang.NullPointerException at net.aufdemrand.denizen.CommandExecuter.execute(CommandExecuter.java:112) at net.aufdemrand.denizen.ScriptEngine.commandQue(ScriptEngine.java:38) at net.aufdemrand.denizen.Denizen$1.run(Denizen.java:335)
Here is my readonlyscripts.yml
@nhoclesnar
Not sure why 210 would break Sentry... but as soon as I work through this next update for Denizen I will update the Sentry build. I have some neat updates for that coming as well.
You might try just using an earlier build of Citizens2 for now.
Hey I know it's the wrong topic but, can you please update Sentry for Citizens 2 build #210? Thanks.
@schlomoo
Other users have reported similar problems. I'm not sure the cause... but I will investigate further. For now, try ASNPC.
Great work!
I have a Problem with the EXECUTE Command. When I use the time day command it works. But when I use "pex user <USER> group add <GROUPE>" it wont work (i use EXECUTE ASSERVER and ASPLAYER.