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
@ursak
No need to beg, just download a dev build :) http://ci.mineconomy.org/job/Denizen_Developmental/lastSuccessfulBuild/
Now I'm sad. :(
CONSOLE: [WARN]: [Denizen] This Denizen version is not compatible with this CraftBukkit version! Deactivating Denizen!
Any fix for 1.8.3 on the way?
Please?
Pretty Please?
Pretty Pretty Please?
Pretty Pretty Please with suggar on top?
@Shahblox
With a bit more work than would be required than NoItem, but yes, quite possible.
Well the Owner of NoItem said this plugin can do the same things as it such as block placing/breaking of certain blocks, holding/keeping certain items in your inventory, opening certain containers all with perms of course. Are these things possible? (Examples)
@mcmonkey4eva
nooooo, not even a only 1.7.10 version of /npc sit? just the code for npc sit
@mcmonkey4eva
nooooo, not even a only 1.7.10 version of /npc sit? just the code for npc sit
@jpell1221
We can only provide support for latest 1.8 servers, sorry.
Please update.
does /npc sit not work on 1.7.10? I tried using latest version but newest version does not support 1.7.10. When i use /npc sit the npc really bugs out
@Oniromancie
- equip <npc> helmet:<Your_Item>
Hi, On my server we use 3D models item(in the same style as Hypixel in Warlords) and not all of them are normal equipment. One of my helmet is in vanilla a wooden slabs. I'd like to know if we could make npcs wear block on their heads like with the /hat command?
ok ok well i'd love to update but i'm waiting for sponge to be released and all the other plugins i use to update I'll use the mechanism once all this is done
thanks
@silentspectr
Please update to Minecraft 1.8 and Denizen 0.9.6
You're using features that were still in-development at the time of 0.9.4
Hi @lANTHONYl thanks for your answer i tried to do what this video says but i m kinda lost.
when i type "ex spawn ..." or "ex adjust ..." it works (exept when i tried to adjust the color of the sheep, the console told me that "color is not a valid mechanism")
and then i tried with other commands but the sonsole always says "invalid dCommand" where can i get a list of those dCommands and the mechanism attached? or is it because i have an old version of denizen ? I'm on denizen 0.9.4
thanks
@silentspectr
You'll need to adjust the skin mechanism.
Hi I saw in here that there is a command to define a NPC skin but i didn't find any tutorial on how to implement it in my script
is it possible to change a NPC skin via denizen ? thanks
@sakura_blades
sakura_blades,
The biggest different between this plugin and others is that isn't just a plugin that you configure and let run. It is an entire programmatic scripting language. You have to learn the language before you can do anything. There is a repository of already written scripts you can learn from, there is a huge amount of reference material and a lot of videos on how to. My recommendation for watching videos is to watch it one or two times before you try to do something. That way you can get a feel for the whole thing before you try. As |Anthony| suggested, join the IRC chat room, we help a lot in there.
@sakura_blades
You can learn a lot by chatting with the folks in the irc chan which is linked at the top of this page. We're generally willing to help folks that are interested in learning. The learning curve is different for everyone so don't be discouraged if you don't pick it up as fast as you had hopped for. But once you get past the "wall-o-text" misunderstanding, you'll see that it really is very logical and fairly simple to grasp.
@lANTHONYl
I sadly cannot afford to hire anyone to do anything with my server, as it alone is a struggle to maintain paying the host. I appreciate the offer though.
I will find a way to learn the beast and make it work in my favor in my freetime.
Thank you though
@sakura_blades
I am for hire, if you can't cope with the beast that is Denizen
@mcmonkey4eva
I learn best by examples, by explanations of how things work by example.
Not a wall of text that just says "do this and that and watch" or a video that I'll have to pause and study for 5 minutes what's on screen, to hear a next step/explanation, and have to "rewind" to see it again.
Give me a paragraph with nothing to visualize, it's not helpful. Give me a video with someone talking past what their doing, and I'm rewinding and getting lost.
Why is it so hard for people to write simple/basic how-to's without paragraphs of extra garbage in there.
There are plenty of how-to's out there for other plugins that explain how to do certain things with certain commands, or setups. This one doesn't have it.. This one's setup, from what I can tell, is just like writing Java, and I don't know how to write Java. The basics I get are "else" and some very minor syntax setup. Outside of that, I'm clueless, and there is no where that explains this clearly for me to learn how to use it.
EDIT: Since it's apparent I won't get any further help that I need in learning how to use this from anyone here.. I will have to do what I can with whatever everyone has already provided.. Don't know why I wasted my time trying to get help to learn how to use this. I will either figure it out like I said, I just give up on using Denizens again.
Forget I bothered any of you..