↜ Create your own quests! by WNG ↝
Introduction
In this tutorial, you will learn how to make and play your own quests and include them in your custom maps. Quests can be logged into your journal or used to control some events in the world every session, making them very powerful tools to make your world interactive.
I may assume you have some basic knowledge and overlook some manipulations. Feel free to tell me if anything is unclear.
Without further ado, let's get started.
I. Create a .qst file
This step will require:
- Quest Editor
Located in your game installation file, this tool is necessary to create quest files, manage triggers and whatnot.
Procedure:
I. Have a functioning mod (optional but recommended):
Prepare a mod that will include in its database all the new entries that will be used for your quests. If you need custom monsters or new rewards, you should prepare them before using the Quest Editor.
II. Load your mod in the Quest Editor:
Locate the Quest Editor in your game folder and open it. It might take a while to open. It may prompt you to select a mod; this allows the Quest Editor to use your mod's database and use any new ressources you've added. If you aren't prompted, you can still proceed by selecting File > Select Mod...
III. Create a .qst file:
You can now simply press on File > New Quest Document or the Two-pages icon to create a new quest document!
II. Understanding the quest components
I. Quest Steps:
(https://i.imgur.com/r8RR7rf.png)
Quest steps are the big sections of your quest. You can name them by clicking on them and leave comments on them too. Their only use is to contain triggers. Quest steps can contain multiple triggers at once, although I suggest you stick to using one trigger per quest step.
II. Triggers:
(https://i.imgur.com/7RU8XHv.png)
Triggers represent the events that can occur. You can name them by clicking on them and leave comments on them too. Triggers contain conditions and actions.
III. Conditions:
(https://i.imgur.com/F9xwSim.png)
Self-explanatory; conditions are criterias that need to be met to trigger the action below. All conditions must be fulfilled before proceeding.
IV. Actions:
(https://i.imgur.com/eP8IhVj.png)
Self-explanatory; actions are events that will occur once the conditions are fulfilled.
V. Tokens:
(https://i.imgur.com/Qg261xw.png)
Tokens are switches that can be used to keep track of the progress of the player's quests, enemies defeated, who it has talked to or not and a lot more. Unlike switches, however, tokens are not exactly booleans; they are granted to the player which means you can either own a token or miss a token (the difference is very subtle.)
You must create your own tokens; they are not generated automatically. Simply press on the wrench icon on the top bar and on the Create Token button.
!! If the window says the Tokens.bin file is not editable, make sure 1) the file exists in your mod directory, 2) the file itself (and its parent directories) are not set on Read-only. !!
III. Analyzing a quest example
To build a quest from scratch, it is necessary to understand how each action and condition operates, but we will get to that later. For now, let's make sure that you understand how a quest is built by looking at an example quest from one of my old custom maps.
The Broodmother : To complete this simple quest, the player must find a kill a huge spider. Here is the structure as seen in its .qst file.
(https://i.imgur.com/g3ak0k8.png)
Step 1: Initialization
Conditions
- When the game loads
- If the player does NOT own the token "sq1_complete" (which will be granted later upon finishing the quest)
Actions
- Add the "!" indicator on the top of the head of the NPC "shanzung_qg1"
(https://i.imgur.com/y3Mi560.png)
Step 2: Receive quest
Conditions
- When the player discusses with the NPC "shanzung_qg1"
- If the player does NOT own the token "sq1_spiderkilled" (which will be granted later upon killing the spider)
Actions
- Adds/updates the quest to the player's journal
(https://i.imgur.com/msWQQpi.png)
Step 3: Defeat spider
Conditions
- Upon killing the creature "giantwidow_1"
Actions
- Adds/updates the quest to the player's journal (with new information)
- Grant the token "sq1_spiderkilled" to the player
- Add the "!" indicator on the top of the head of the NPC "shanzung_qg1" anew
- Changes the dialog package of the NPC "shanzung_qg1"
(https://i.imgur.com/9OGfPr6.png)
Step 4: Report back
Conditions
- When the player discusses with the NPC "shanzung_qg1"
- If the player does owns the token "sq1_spiderkilled" (which has been granted at step 3)
Actions
- Updates the quest to the player's journal (with new information) and now tags it as completed
- Give the player one instance of a random item from the referenced loot table (in this case, a relic shard)
- Grant the player some experience points
- Give the player the token "sq1_spiderkilled"
- Changes the dialog package of the NPC "shanzung_qg1" once more
- Completes the quest (the .qst file is now sealed)
(https://i.imgur.com/nkFRfNz.png)
IV. Implement a quest in your mod
We now know how a quest file looks like and how it is built. I will explain in the posts below the function of some conditions and actions, but before that, let's look how we include a new quest to our mod.
This step will require:
- Art Manager
Also located in your game installation file, this tool manages your mod's assets and database. Here, it is required to build your quest into your mod and make it usable. - Editor
Also located in your game installation file, this powerful tool is used to make maps. It will be necessary later to include your quest in your map.
Procedure:
I. Make an asset of your .qst:
Once you have finished and saved your .qst file, open the ArtManager with your mod selected. In the Source tab, select the folder you want to store your quests in (every mod starts with a Quests folder by default.) Right-click on the window on the right and click Import... From there, find your quest. Once it's imported, right-click on it and press Auto-Create Asset.
II. Build the asset:
Visit the Assets tab and locate your quest file in the same folder you left it in Sources. Right click on it and click on Build. Once it's done (should display "added: ./_questname_.qst" in the console), press F7 to build your mod. The quest is now incorporated in your mod, but remains unused...
III. Add the quest in your map:
Launch your custom map. On the top bar, press on Quest > Selected Files... You will see the entirety of the quest files used by this map. Press Add and locate your quest. Once it's added, make sure to save your map (no need to rebuild pathing or maps.) For changes to take effect, you may need to rebuild your map and your mod with the Art Manager.
↜ Annex I : Function of basic conditions ↝
Here's the function of some conditions used in the Quest Editor. To my experience, not all of them work (or I don't know how they function?) but I will list down below the basic/essential conditions for starters.
- Animation completed: The unit "CharacterDatabaseRecord" is finished playing the animation "IdTag" referenced in its Animation pack.
- Got Token X: The player owns the token X, and the action will be fired immediately when it is received.
- Has Item X: The player owns a specified item in its inventory.
- Kill all creatures from proxy X: All the creatures from the proxy "ProxyDatabaseRecord" are now eliminated.
- Monster X Health == N%: The monster "CharacterDatabaseRecord" has Health or Energy "Mode" to the "Value".
- On Conversation with X: The NPC X has been discussed with.
- Owns Token X: The player owns the token X, and the action will be activated when another active condition is fired.
- Picks Up Item X: The player picks up the item X.
- Player Enter Bounding Volume: The unit "EntityDatabaseRecord" steps in the range of the bounding volume "BaseDatabaseRecord". If "EntityDatabaseRecord" is left empty, it will be treated as the player. (Bounding Volumes are invisible spherical objects that cover an area and detect which units step in and out.)
↜ Annex II : Function of basic actions ↝
Here's the function of some actions used in the Quest Editor. To my experience, not all of them work (or I don't know how they function?) but I will list down below the basic/essential actions for starters.
- Add Journal Entry in Region: Update the quest log. In "RegionNumber" (1= Greece, 2=Egypt, etc.), in the category "LocationTag" (Helos, Sparta, etc.), add/update/complete the entry "TitleTag" with the description "FullTextTag".
- Boat Dialog X with target N,N,N: The NPC will prompt the player with a window "Tag" to travel to the coordinates X, Y, Z in the world.
- Clear X's Dialog: The NPC will return to its default dialog pack.
- Close door X: Closes the door X.
- Complete Quest Now: Completes a quest file.
- Disable proxy X: Deactivates the proxy X.
- Drop Item X,X,X from X: The NPC will drop the item X, X, X (depending on difficulty.)
- Give Player Item X(xN), X(xN), X(xN): Gives the player the item X in quantity N (depending on difficulty.)
- Give Player N, N, N attribute points: Gives the player N attribute points (depending on difficulty.)
- Give Player N, N, N Experience: Gives the player N experience points (depending on difficulty.)
- Give Player N, N, N gold: Gives the player N gold (depending on difficulty.)
- Give Player N, N, N skill points: Gives the player N skill points (depending on difficulty.)
- Give Token X: Grants the player the token X.
- Hide X: Renders the NPC invisible.
- Illuminate X as Primary: Renders an icon on the top of the NPC. (1 or Primary = Exclamation mark, 2 or Secondary = Diamond, 3 or Tertiary = ???, 4 or more = Nothing)
- Initiate Conversation with X: Automatically initiates a dialog with the NPC.
- Lock Fixed Item X: Locks certain items such as doors or chests.
- Make X invincible: The NPC or monster X becomes invincible.
- Remove Item X From Inventory: Removes the item X from the player's inventory.
- Remove Token X: Removes the token X from the player.
- Show X: Makes the NPC visible (often used with Hide X action.)
- Spawn X at X: Make "Entity" appear at the "Location" (which must be a .dbr with the template "questlocation.tpl".)
- Update X's Dialog to X: Overwrites the NPC's dialog pack with a new one, referenced in "DialogPak".