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
Ever since 1.4.6 update all my denizens do not work at all. And when i try making new ones it says there is no trait called denizen.
I'm stumped! Someone please tell me what's wrong with my script.
I think it's occurring somewhere in the second step. The chat trigger when said in the server chat, doesn't do anything at all. Your message just goes straight to global chat like the npc wasn't even there. Please help!
Also an older version doenst work either :(
I have full control over the server. Also the control panel. I dont see any errors at all when i am looking in the console.
If reinstalled the plugin but still noting :(
@Dutch_Boy
Delete the server log and start the server again.
Then open the server log again and see if you see a Denizen error and post it on the issue tracker.
I dont know if someone has the same problem.
But denizen doenst do anything :S
Bukkit 1.4.6 denizen Denizen 0.7.6-FINAL
Placing Maggie and trying to show the assignments with shift + click but nothing happens :S
also saying something to her doesn't work.
Any idea how i can fix this?
Can someone help?
I'm trying to install this onto my server ( 1.4.5-R1.0 ) and no matter which one i use it says "is the plugin up to date?"
I don't know where i can find which one is for 1.4.5-R1.0 so if someone could direct me to that that'd be awesome :)
Someone help? I made a sentry denizen, and when it dies its meant to speak in chat and drop some items, but it doesnt seem to drop items, or say anything, and when its meant to die, it just runs back to its respawn point and becomes invincible but doesnt retaliate.
@Cystalize
Oh and sorry. Bukkit messed up the spacing on that last comment.
@bobbshields
Your comment made me a little more confused lol :3. So wait, you have to type a command in-game for proximity triggers to work? I thought it was all in the scripting:
Steps: 1: Proximity Trigger: Script: ....
See that doesn't work for me. But if there is a command I need to type, then maybe that's why it doesn't work. Also, do you know how I might make player chatting work? I don't want a Chat Trigger, but instead I want the player to talk just like the NPC would talk.
@Cystalize
What are you typing to activate the proximity trigger? I had trouble with this too as the help file is misleading.
I thought from reading
/denizen trigger list
that the command was
/denizen trigger toggle proximity-trigger
when really what worked was
/denizen trigger toggle proximity
Hey Im having a bit of a problem. How would you make a player chat without having to use a Chat Trigger? I tried using 'CHAT ASPLAYER' and 'CHAT AS_PLAYER' but neither of those worked. Im using CraftBukkit build #2561 and Denizen 0.76-FINAL v4.
Also on the side note, Proximity Triggers dont seem to be working for me either. :/
Can anyone help? Im trying to get Denizen to work but when I type /trait denizen it keeps saying 'unknown trait'. This only happens in the 0.8 pre releases in jenkins. The rest of the dev builds dont read the scripts. The commands work but the scripts dont. This started happening to me randomly. My scripts use to work just fine. HELP PLEASE :3
One more question... I am trying to get "Age Checking" to work.
Flagging the Age based on Input works fine. But I have no idea how to get the IF AGE is a number then go to Need Age 1 otherwise go to Need Age 2.
Any ideas?
Fantastic mod! It has been unleashing a whole wave of creativity here!
I have a question....
When I place a LOCATION block, it does not activate when I (The Player) walks over it... any idea why?
@zarakh01
Also does anyone know how to make an NPC both sentry and denizen?
EDIT: nevermind it seems like my plugins just arent working.
Hey, im new to this plugin, can anyone help me in making a simple mob killing quest? so i can look over it and see how things are done. Also i saw in a recent post someone used a script that casts a spell, is this for heroes or magicspells?
need help i want a "- LISTEN KILL TYPE:ENTITY NAME:ZOMBIE QTY:10 SCRIPT:KillComplete" for A npc with ID:13 Name:Thief has sentry and denizen traits type:PLAYER for SCRIPT:KillComplete can any body write it pls ?
trying to get denizens 0.6 to work (running CB 1.2.5 on Tekkit 3.1.2)
I keep getting this error:
12:58:06 [SEVERE] Could not load 'plugins\denizen-0.6.jar' in folder 'plugins'
org.bukkit.plugin.InvalidPluginException: java.lang.NoClassDefFoundError: net/citizensnpcs/api/npc/character/Character
at org.bukkit.plugin.java.JavaPluginLoader.loadPlugin(JavaPluginLoader.java:151)
at org.bukkit.plugin.SimplePluginManager.loadPlugin(SimplePluginManager.java:310)
at forge.bukkit.ForgePluginManager.loadPlugin(ForgePluginManager.java:55)
at org.bukkit.plugin.SimplePluginManager.loadPlugins(SimplePluginManager.java:231)
at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:221)
at org.bukkit.craftbukkit.CraftServer.<init>(CraftServer.java:197)
at net.minecraft.server.ServerConfigurationManager.<init>(ServerConfigurationManager.java:59)
at net.minecraft.server.MinecraftServer.init(MinecraftServer.java:177)
at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:438)
at net.minecraft.server.ThreadServerApplication.run(SourceFile:492)
Caused by: java.lang.NoClassDefFoundError: net/citizensnpcs/api/npc/character/Character
at java.lang.ClassLoader.defineClass1(Native Method)
at java.lang.ClassLoader.defineClass(Unknown Source)
at java.security.SecureClassLoader.defineClass(Unknown Source)
at java.net.URLClassLoader.defineClass(Unknown Source)
at java.net.URLClassLoader.access$100(Unknown Source)
at java.net.URLClassLoader$1.run(Unknown Source)
at java.net.URLClassLoader$1.run(Unknown Source)
at java.security.AccessController.doPrivileged(Native Method)
at java.net.URLClassLoader.findClass(Unknown Source)
at org.bukkit.plugin.java.PluginClassLoader.findClass(PluginClassLoader.java:41)
at org.bukkit.plugin.java.PluginClassLoader.findClass(PluginClassLoader.java:29)
at java.lang.ClassLoader.loadClass(Unknown Source)
at java.lang.ClassLoader.loadClass(Unknown Source)
at net.aufdemrand.denizen.Denizen.<clinit>(Denizen.java:49)
at java.lang.Class.forName0(Native Method)
at java.lang.Class.forName(Unknown Source)
at org.bukkit.plugin.java.JavaPluginLoader.loadPlugin(JavaPluginLoader.java:140)
... 9 more
Caused by: java.lang.ClassNotFoundException: net.citizensnpcs.api.npc.character.Character
at java.net.URLClassLoader$1.run(Unknown Source)
at java.net.URLClassLoader$1.run(Unknown Source)
at java.security.AccessController.doPrivileged(Native Method)
at java.net.URLClassLoader.findClass(Unknown Source)
at org.bukkit.plugin.java.PluginClassLoader.findClass(PluginClassLoader.java:41)
at org.bukkit.plugin.java.PluginClassLoader.findClass(PluginClassLoader.java:29)
at java.lang.ClassLoader.loadClass(Unknown Source)
at java.lang.ClassLoader.loadClass(Unknown Source)
... 26 more
solutions?
i cant get the listen kill to work with npc, i entered the TYPE:NPC NPCID:26 , just like i should and the denizen still dont see when i kill it, i tried with an entity zombie and it worked perfect, just couldnt get it to work on the NPC.
is anyone else having this issue,
im running a 1.4.5 server