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
@watdidyusaey
Indeed... :) Start small.
@Kiak
I'm working on making the start-up kit a little easier to read.
@Kiak
I've had this idea too... thought about making a 'RELOCATE' command or something that did just this.
@silentnight18
They should be... at least moving up to 100 blocks or so shouldn't be any issue. Not sure about making them trek across the globe.
@watdidyusaey
The config examples confused me so much
Im making some new ones for other noobs like me :)
look out in a day or two cause im just trying to just mash all possible commands onto one or 2 npcs so people can deconstruct it
Already my NPCS
and i'm not forever alone anymore YAY
@silentnight18
Don't use "/npc path" anymore Denizens Wander and specific move commands are the shiz nickle.
If you really need them to walk real far make them Cheat
This is so powerful and complicated its overwhelming.
awesome
@aufdemrand
Longer pathing issue ever resolved? if not, there may be some things to look into with some of the PathFinders and Navigation Classes with CraftBukkit.
@aufdemrand:
Got it all working. However, made a script using CitizensUI, and the click-trigger isn't working. Was using the example one for hireable mercenaries.
Secondly, if I create an Inkeeper denizen, and wish to assign timed regions, what would be an appropriate script for this?
E.g. Room1, Room2, Deluxe1, Deluxe2 Player pays 10 coins for 24-hours (in-game) time, then ownership is revoked. If Room1 is occupied, then assign Room2.
Also, can you assist with Herochat? When a player talks to a Denizen, other players can hear what he says in that channel, as well as in the Denizen channel.
@Andarne
Just create them by hand.
http://wiki.citizensnpcs.com/Denizen/Before_Using_Denizen#config.yml explains why Denizen doesn't make it's own assignments.yml or config.yml.
Some reason the plugin isn't making the Denizen folder, so I can't edit the scripts/assignments.yml files.
Using .75 snapshot, build 441
Huge update just posted. Waiting for bukkit team to approve the JAR - use the Denizen Jenkins for a link in the meantime. Also updated links to reflect new .COM web address, added a youtube video, and added a few more sample scripts.
@silentass1n
Look in Saves.yml at each npcs settings
Look in bookmarks for each until you find one called "spawn"
Try Remove it.
Try Removing all location bookmarks
Try Removing all Npcs
Add all that stuff back in 1 by 1
our denizen plugin has been spamming the server a ton with all these errors heres a piece i grabbed from the console but it spams with the ending standing and everything its getting really annoying
21:36:53 Denizen: Found location: spawn 21:36:53 Denizen: Found location: spawn 21:36:55 Denizen: Found location: spawn 21:36:55 Denizen: Found location: spawn 21:36:57 Denizen: Found location: spawn 21:36:57 Denizen: Found location: spawn 21:36:57 Denizen: Found location: spawn 21:37:01 Denizen: Found location: spawn
i cant get to the website or the wiki at all is it just me i really want to start making some quests but i need to get to the wiki for a tutorial. I hope it come back online soon its been down for a while for me now.
For some reason the assignment thing isn't working if I type /denizen info the script is there but when I right click the NPC he only says the default sentences. I tried it in game and out of game, niether work. and I'm reloading the server too.
I'm stuck too.
Denizen and Citizens2 load fine. I've created an NPC named Jakob of type Denizen. Any chance you could give a short step-by-step how-to from creating an NPC to using the example script? I'm just not sure what I'm missing here...
Hey guys, sorry been SUPER busy... hoping to get a first version of 0.7 out this weekend, which will allow me to fix up bugs on the fly again... thanks for being patient!
We also have an IRC channel on irc.esper.net now.. join us in #denizen-dev.
@thorincumming
Denizen .7 isn't stable yet, don't use it. Use 0.6 build 124, which can be downloaded here http://wiki.citizensnpcs.net/Denizen
There is no way to control the player's camera.
You can make a npc walk back to his spot by using the /npc path command and selecting one point. This will break on sever reload though, known bug in citizens2.
This plugin is a very cool idea! ;) I want to use it on a RPG-server with spout. Is it possible to add custom items? So that I can add specific quest items, which the npc can take?