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
@thorincumming
You don't have the permission to access the requested resource. It is either read-protected or not readable by the server.
If you find this to be in error, please notify the administrators. I cant download the files D:
@goraxer I am giving you the latest dev-builds as of the date of this post.
here you go download this version of Denizen:
http://ci.citizensnpcs.net/view/Characters/job/Denizen/152/artifact/target/denizen-0.7-SNAPSHOT.jar
And this version of Citizens2(must be version 2):
http://ci.citizensnpcs.net/job/Citizens2/lastSuccessfulBuild/artifact/target/citizens-2.0-SNAPSHOT.jar
let me know if it works for you it should now.
I am getting the same thing just be patient. And wait for a response did you fill out a ticket? That will be more help full to him!
Dude i really need your help!
I think im going to work on a demonstration vid for you :)
Wow this looks amassing is there a way to have the npc grab the players attention (have them look at the npc and lock them there) or have them look a specific way?
Still same error: 2012-06-25 15:18:46 [SEVERE] Could not pass event EntityTargetEvent to Citizens org.bukkit.event.EventException at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.java:304) at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:62) at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:460) at net.citizensnpcs.EventListen.onPlayerInteractEntity(EventListen.java:156) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(Unknown Source) at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source) at java.lang.reflect.Method.invoke(Unknown Source) at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.java:302) at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:62) at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:460) at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:979) at net.minecraft.server.Packet7UseEntity.handle(SourceFile:33) at net.minecraft.server.NetworkManager.b(NetworkManager.java:229) at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:113) at net.minecraft.server.NetworkListenThread.a(NetworkListenThread.java:78) at net.minecraft.server.MinecraftServer.w(MinecraftServer.java:567) at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:459) at net.minecraft.server.ThreadServerApplication.run(SourceFile:492) Caused by: java.lang.NullPointerException at net.aufdemrand.denizen.utilities.GetRequirements.check(GetRequirements.java:46) at net.aufdemrand.denizen.utilities.GetScript.getInteractScript(GetScript.java:106) at net.aufdemrand.denizen.DenizenCharacter.DenizenClicked(DenizenCharacter.java:33) at net.aufdemrand.denizen.DenizenCharacter.onRightClick(DenizenCharacter.java:241) at net.citizensnpcs.EventListen.onEntityTarget(EventListen.java:136) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(Unknown Source) at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source) at java.lang.reflect.Method.invoke(Unknown Source) at org.bukkit.plugin.java.JavaPluginLoader$1.execute(JavaPluginLoader.java:302) ... 18 more
Script: http://pastebin.com/FVdRbfs1
Answer my Pm!
How to make the denizens not move while they are pushed by another player?
@Smashskull3460
Some of your requirements/commands are spelled wrong. FINISHED, NARRATE, for example.
But let me write up an example... I'll post the link.
thank man that helped alot. sorry for bugging you but i cant seem to work out how to make a Item collection quest. you see i want to make it so you have to collect 5 spider silk from a spider spawner i have put in the Forrest. but i seem to be stuck at checking to see if the player has them in their inventory. this is my Script so far: "Collection Quest": Type: Trigger Requirements: Mode: All List: FINNISHED 'Regular Joe' Steps: '1': Click Trigger: Script: - LOOK CLOSE - CHAT Welcme to my General Store. - ZAP - LOOK AWAY '2': Click Trigger: Script: - LOOK CLOSE - CHAT Ahh thats a fine training blade Steve gave you. - CHAT Lets put it to work shall we? Chat Trigger: '1': Trigger: /Sure/, Were do i start? Script: - LOOK CLOSE - CHAT You can start by bringing me 5 Spider Silk. - NARATE I guess i better head into the forrest and collect some Silk - ZAP '2': Trigger: /No/, Not Yet Script: - LOOK CLOSE - CHAT Oh ok. - LOOK AWAY '3': Click Trigger: Script: - LOOK CLOSE - CHAT Nice to see you again! - ZAP 1 - LOOK AWAY
@Smashskull3460
You can either make a new file, or simply add another script at the end in the same format.
etc.
hey man really loving ur work, i got a question tho. ho do i add more than 1 Script? do i add a new 1 to the same script file or do a create a new file inside the folder?
keep up the good work man and thanks in advance
@trerick
That probably be the #1 use of the feature I have planned called Activity Scripts. Basically will allow the Denizens to follow a schedule based on the time of day. For example, at 12 Noon, go fishing. At 17:00 go home, etc.
Coming soon!
Is it possible to get a denizen to wander around on a preset path with out needing a player to send him their.
I'd love to have one wander around my town in a preset path, and if at all possible have it respond to triggers such as day/night/rain.
Not sure if that is in the plans or even possible but figured I'd ask.
@aufdemrand
I recopied just your test files in though that is what I had before but the new copy is working well. Thanks for your help. Now to test it out now that is working.
@trerick
The line it is erroring out on is where it reads the requirements mode.
It would appear that you either: 1) have a script assigned that doesn't have an actual corresponding script (check carefully that everything is spelled correctly) or 2) a requirement mode is missing from your script.
@aufdemrand
I figured I was missing something, but this now brings us to a new issue. I get an error message upon left or right clicking a denizen. It doesn't occur on any of my other npc's.
@trerick
Have you applied the character trait to the NPCs?
Ok I am running the latest build, tried both the current recommended builds for denizen and citizens 2. My issue remains the same, my npc's don't trigger responses. They are properly named both my test one and the Steve file you provide, with just Steve I get nothing as well.
I do get a message Denizen Trigger List built. Size:0 if that helps.
The scripts say they loaded correctly both with the default starter-kit and my changes but no triggers. All required plugins are installed as well.
tested the example script as well tried both server restart and denizen reload