IntroductionBecause here at Emps we highly support custom content, we'd like everyone to invite and try to make custom quests for Emps World. New quests are written in Thomy's newly created Emps script: a simple script language that helps the server understand what kind of quest directions you're giving, without having to complicate things in java.
FeaturesThe script has a lot of limitations, and gets features added over time when they are necessary.
Currently Emps script covers the following quest features:
- Player to NPC dialogue
- Any NPC to player dialogue
- Different options and progress to continue (different) dialogues
- Player gives (multiple) item(s) to NPC
- Player requires (multiple) item(s) to advance
- Player requires (multiple) equipped item(s) to advance
- NPC gives item to player
- Player advances to the next state in the quest (dialogue will start where the player left it)
- NPC can check if a player owns a certain item(s) anywhere in their account
- NPC can check if a player has a certain item(s) in their inventory
- NPC can check if a player has a certain item(s) equipped
- Add yellow markers on maps and to NPCs
- You can be teleported
- Interfaces like guides and bank can be opened
- A game status message can be sent
This means that only custom quests that require gathering of items, search quests or a quiz can be made with this script. Small additions to the game code that cannot be covered by Emps script, like spawning npcs, simple monsters and combining items (with level requirements) are no problem to include in your quest, but will have to be mentioned in detail.
Before you'd like to create a custom quest, keep these limitations in mind and first write a short step-by-step story that will cover the entire quest and your checkpoints. For the example I'll use the Halloween 2015 event quest I made with this system.
Script storyThe player needs to help the grim reaper with halloween: talk to the grim reaper and accept the quest. (here you flag the first checkpoint in the quest, the player will directly skip the introduction if met again)
The grim reaper gives the player several tasks. First i wanted to let the player decide which task he was going to do first, which second etc. (This is not feasible with the current system, because you would have to create all the possible combinations and write questlines for each combination.)
The grim reaper gives you the first task: Meet with the barbarian. If you talk to the grim reaper again (without talking to the barbarian yet) he should give you a tip for the barbarian, and thus you need to assign another checkpoint here so your dialogue starts with this tip.
Once you finish all the dialogue with the barbarian, you meet another checkpoint. This signals that the grim reaper dialogue will advance into the next task
The grim reaper gives you the second task: The cook, you need to combine some items to give him the combined item.
Now this is where I cheated a little. In this script you cannot create the recipe for the combined item, this has to be done in the game code itself (any custom or new npcs will have to be spawned in the game config aswell).
Once you do have the combined item, you tell the script the player needs to have this item to advance in the dialogue. The item will then be removed by the script if necessary.
The same thing for the third and last task: in the script the grim reaper will give you a jack-o-lantern mask, and only if you equip the mask farmer fromund will answer on your quest and you will be able to advance. In this case however, the mask will not be removed from the player. Another checkpoint is added here so the grim reaper knows that you completed this task.
This sounds rather easy, but you have to cover any missing dialogue holes! For example, you need to create a dialogue that happens when you do not have a certain item, when you are already done with that quest or when a player loses items that are required in the quest and obtained by the quest npc!
Script syntaxLike any other language emps script has a certain syntax for the program to recognize. Individual commands are seperated by tabs (and not spaces!)
A dialogue starts with
d = dialogue_nameAny quest starts with all the NPCs listed, and the dialogues that belong to them, with the appropiate checkpoints (the progress in your quest determines with which dialogue the npc will start)
d = quest_options
opt | 8977 "Begin quest" | hween_grim_reaper
opt | 384 "Continue quest with the Barbarians" | hween_1_barbarian
opt | 794 "Continue quest with Charlie the Cook" | hween_2_cook
opt | 3917 "Continue quest with Farmer Fromund" | hween_3_farmeropt | 8977 is the option with the NPC id, so the server knows which npc is talking. NPC 8977 is the grim reaper in Emps.
hween_grim_reaper, hween_1_barbarian, hween_2_cook and hween_3_farmer are dialogue names.
This is an overview dialogue of all the dialogues that the grim reaper uses in the halloween quest. At every checkpoint ($q_quest) the grim reaper answers with a different dialogue. The dialogue names are behind the checkpoint number. This does not need to be done for every npc, it can be shorter, but it definitely keeps the overview.
You can use >= and <= to group dialogues: if a quest has started and you get to checkpoint 1, the npc will always answer with dialogue_name if you use $q_quest >= 1 dialogue_name.
d = hween_grim_reaper
if $q_hween == 0 hween_begin
if $q_hween == 1 hween_1
if $q_hween == 2 hween_1_hint
if $q_hween == 3 hween_1_finished
if $q_hween == 4 hween_2
if $q_hween == 5 hween_2_hint
if $q_hween == 6 hween_2_hint
if $q_hween == 7 hween_2_finished
if $q_hween == 8 hween_3
if $q_hween == 9 hween_mask_check
if $q_hween == 10 hween_3_finished
if $q_hween == 11 hween_grim_reaper_end_decide$q_hween == 0 is checkpoint 0 and thus at the start of the quest the player will be met with the dialogue hween_begin:
d = hween_begin
npc "Hello mortal."
plr "Hi @name@, you look grim. I'm sure you have a quest for me!"
npc "Of course I look grim, I'm the @dbl@Grim Reaper@bla@ you fool!"
npc "And yes, I might actually need you to do something for me."
qst "Help the Grim Reaper" "Yes." | hween_cont "No." | hween_abortHere a question (qst) is asked, and each answer leads to a different dialogue name (d = hween_cont and d = hween_abort). Maximum of 5 answers.
After the player selected yes, the continued dialogue is the following (shortened)
npc "Lets start with the Barbarian." $q_hween = 1
to "Start quest" | hween_grim_reaper
Here you set your first checkpoint, $q_hween = 1
This means that the next time you talk to the grim reaper, you go to dialogue name hween_1 (it goes first to hween_grim_reaper and then sees that you are on checkpoint 1, so it starts hween_1).
If you use an overview like mentioned before, make sure you use the 'to' syntax to this same overview everytime you set a checkpoint. This makes it easier to see where the dialogue is heading. Even though the checkpoint is $q_hween == 1, that doesn't mean you should set it 'to hween_1' !
You get the point by now I think. Now you just have to be careful that for every checkpoint in the quest, every npc has an answer when the player talks to him. If you got your first task, but didn't clear the checkpoint with the barbarian yet, the grim reaper has to give you a tip or something. So after the first task you need to set another checkpoint.
Other commandsYou can add various other commands to the script that include actions and items:
Here an npc adds a marker for you to the npc you should go to. The marker numbers include the npc id and the location (x and y) of the npc.
npc "Come back to me once you succeeded." $q_hween = 2 mark(id, x, y)Here the barbarian will have a standard answer if your checkpoints do not meet 2 and 3. If your checkpoint is 2 it'll go to the dialogue hween_1_barbarian_treat, same goes for 3. If your checkpoint is not 2 or 3 it will continue to finish the dialogue below and end. This is basically a shorter version of the hween_grim_reaper overview mentioned before.
d = hween_1_barbarian
if $q_hween == 2 hween_1_barbarian_treat
if $q_hween == 3 hween_1_barbarian_go_back
npc "Get lost!"
plr "Okay okay... easy..."Here you check if a player has a certain item in his inventory. If you are looking for a multitude of items you should put (id-amount), else just the id. If a player does not have the item it will continue with the dialogue behind 'else'.
d = hween_2_cook_1
plr hasItem(2197) "Hello cook, would you be interested to taste this special recipe?" | hween_2_cook_okay else "I should make those special crunchies that the Grim reaper told me to make." | hween_2_cook_no_itemIdentify the npc that is talking to you inside the dialogue_name if you haven't identify this before. You can also use this to have two NPCs talking to you in the same dialogue (like a three-way argument). To find a npc id, use runelocus.com's npc list, or use ::devon ingame:
http://i.imgur.com/MpRWCLJ.pngnpc | 559Deletes the item from the inventory of the player if inserted in a dialogue frame. At least 1 item id is required.
delItem(id-amount, id-amount) Adds an item to the inventory of a player if inserted in a dialogue frame. If the player's inventory is full, it will be dropped. At least 1 item id is required.
addItem(id-amount, id-amount)Equips the player with this item, but only if the slot is already empty. I'll add the slot id's later.
equip(items, slot)Checks if the player has one of the following item(s) in his inventory (Don't forget to add an 'else' if the item is not owned!):
hasItem([id-amount, id-amount]) "dialogue" else "dialogue"has([id-amount, id-amount]) "dialogue" else "dialogue"or if the player has all of the following item(s) in his inventory (Don't forget to add an 'else' if the item is not owned!):
hasItem({id-amount, id-amount}) "dialogue" else "dialogue"has({id-amount, id-amount}) "dialogue" else "dialogue"Checks if the player owns the item (inventory, bank, or equipped). Don't forget to add an 'else' if the item is not owned!
ownsItem(id-amount) "dialogue" else "dialogue"Checks if the player has this item equipped. Atleast 1 item id required. Don't forget to add an 'else' if the item is not equipped!
hasEquipment(item, amount) "dialogue" else "dialogue"Opens an interface popup, like the bank, a guide or note. This interface needs to exist in the game code. I'll list common interface id's later.
interface(id)Puts a yellow marker on the minimap. If the given npc id is close to the location the npc will be marked instead.
mark(id, x, y)Teleports the player to the given coordinates. Commonly z = 0 for ground level. To find coordinates, use the command ::devon ingame:
http://i.prntscr.com/942c201f47354a7b8aa87b65268d436d.pngteleport(x, y, z)Name of the player or NPC talking to
@name@
Colors, add these tags around the dialogue text similar to the colors used in the chat ingame.
@dre@, @dbl@, @gre@, @dre@, @mag@
Here is the entire Halloween script for study:
http://pastebin.com/raw/LjDMZyhPPlease pay close attention to the tabs, spaces and symbols in this script.
Enjoy, I hope some will take up the challenge and know a good story to try it out! If you have any questions, please post!
