Divinity Engine Wiki - User contributions [en]

Tutorial - Implementing a Basic Quest

2017-12-31T04:01:05Z

Windemere:

== Overview ==
This tutorial will provide an overview of all the steps necessary to implement a quest in a standalone campaign from scratch. It will not delve into any one area in great detail, the goal is to provide a 'big picture' walk through of some of the more commonly desired components in a quest. I will keep adding to it as time permits and when community feedback indicates additional areas of need. The end goal is to provide both video and written guides for each section. The video will be done first, followed by written guides later. 
 
'''The Quest''': It's Launch Day at Larian Studios, but there is no power! Swen is lookin for a hero to save the day. Will it be you? 
 

== Creating a New Project and Playable Terrain ==
The first video in this series starts right at the beginning of creating a new Project, Level, and then a walkable terrain. It will not go in depth on terrain editing as there are good resources already available for it. 
 
[https://youtu.be/b5hCMWNEiE4 Creating a New Project and Playable Terrain (Youtube)] 

== Building Your First Story ==
The Story is an essential element to any campaign and should be compiled soon after creating your terrain. In this episode we cover the concept of a story and how it functions in the game. We'll go over how to build it and include a basic introduction to writing your own goals. 
 
[https://youtu.be/OvXiCglVOpU Building Your First Story (Youtube)] 

== Placing and Modifying an NPC ==
An overview of how to place an NPC in the game, customize its appearance, and some of the other important properties of an NPC. 
 
[https://youtu.be/N2u1eqqzlGo Placing and Modifying an NPC (Youtube)] 

== Creating a Default Dialog for an NPC ==
How to create a very basic dialog and assign it to an NPC. 
 
[https://youtu.be/XME89rtXzKQ Creating a Default Dialog for an NPC (Youtube)] 

== Creating and Updating a Quest Journal ==
Demonstrates how to create a quest journal and cause the first stage of a quest to be triggered from the dialog that was created in the previous tutorial. 
 
[https://youtu.be/lLEgNfAEL-k Creating and Updating a Quest Journal (Youtube)] 

== Quest State Driven Dialogs and Giving an Item ==
In this tutorial we re-visit our dialog to make it reflect the quest progression. Instead of asking the same question over and over and re-offering the quest, we add some additional dialog nodes and flags to provide a better user experience. We also use the dialog to trigger the giving of a weapon to the player through a story script, and we cover some useful debugging tools for dialogs and story scripts. 
 
[https://youtu.be/t44RhWE1aRs Quest State Driven Dialogs and Giving an Item (Youtube)] 

== Customizing Doors, Containers, and Object Tooltip Display ==
In this tutorial we move on from our quest setup and create a simple building with an entrance door. We examine the properties that control whether it is locked and how it can be unlocked. We also look at how to specify the strength of the door for potential destruction. We examine containers and adding items to them as well as pseudo-random treasure tables. Finally, we look at "Tooltip Type" settings for controlling when an object's display name is visible in the world. 
 
[https://youtu.be/u7VaIvYkNog Doors, Containers, and TooltipTypes (Youtube)] 

== Character Creation ==
In this tutorial we tackle adding real Character Creation to the campaign so that it can be played both within the editor and from the game client. We'll create a new goal in the story editor and paste in some code released by Larian for a standalone campaign. Then we will edit that code to workaround a discovered bug that prevents game made characters from entering combat with hostile NPCs. After we get our script working, we'll revisit it and go over what some of the frames within the goal are doing. Lastly, we will create a player companion that automatically gets added to the party when the game starts. 
 
Wiki Page on creating an adventure and adding character creation: 
[[My_first:_Adventure#Necessary_scripting]] 
 
[https://youtu.be/Yq6Rm_Kqb5g Character Creation (Youtube)] 
[https://youtu.be/8bavkSt29js Character Creation and Story Cleanup (Youtube)] 

== Introduction to Encounters ==
In this tutorial we create a dynamically driven encounter that begins when picking up an object. We cover the meaning and uses of Combat Groups and Factions as well as some options for initiating combat from story scripts. 
 
[https://youtu.be/nlwdx2VwF2Q Introduction to Encounters (Youtube)] 

== Scripted Dialog, Timers, and Inventory Checking ==
In this tutorial we modify our quest so that combat does not start immediately when taking the generator. Instead, we'll have one of the NPCs initiate a dialog with the player and give them five seconds to drop the generator before becoming hostile. The tutorial introduces story scripting to start dialogs, create and process timers, and check the player's inventory for a specific item. Towards the end it also provides some suggestions on how to go about finding the right Osiris calls for your needs at any given time. 
 
[https://youtu.be/0OO4uFPdNJg Adding Scripted Dialog, Timers, and Inventory Checking (Youtube)]

Basic Character Creation

2017-11-09T20:48:15Z

Windemere:

NOTE: Outdated Material 
 This tutorial was written before receiving official character creation scripts from Larian and should be consulted for historical and supplemental reference only. If you are seeking to implement character creation in a standalone campaign, see the [[My_first:_Adventure#Necessary_scripting|necessary scripting]] section of the wiki. There is also a community tutorial for [[Tutorial_-_Implementing_a_Basic_Quest#Character_Creation|character creation]] that demonstrates use of the official scripts.
 

----
 

== Character Creation for Standalone Adventures ==
Larian is working on a [[My_first:_Adventure|character creation template]], but in the meantime this guide will show you how to get something working for now. Unfortunately it does not work for multiplayer.

== Requirements ==
[[https://docs.larian.game/Working_with_projects| Create an adventure mod]].
[[https://docs.larian.game/Working_with_levels| Make a basic level]]
[https://docs.larian.game/File:Basic_Character_Creation.zip Download the Scripts]

'''This tutorial is only for standalone adventure mods and will not work with mods that have "Origins" as a dependency'''

== Setting up the Story Scripts ==
* Unzip the [[File:Basic Character Creation.zip|Basic_Character_Creation.zip]] file to the folder:
\Divinity Original Sin 2\Data\mods\YOUR MOD HERE\Story\RawFiles\Goals
These scripts are pulled from D:OS 2 Origins and modified.

* Launch the editor, open your adventure mod, and open the level you intend to be the first one after character creation finishes. If your level does not have an [[https://docs.larian.game/AI_grid_panel| AI grid]], you need to generate one.

* Open the [[https://docs.larian.game/Story_editor| Story Editor]], the goals you copied should now be on the left pane.

* Expand the goal _BasicCC_Creation_Start. Open the goal file _BasicCC_CharacterCreation

[[File:BCCStoryEditor1.png|Modify the INIT section]] 
 

* Change the strings in the following entries seen above as the name of your first level.

DB_CharacterCreationTransitionInfo("Level1" 

DB_GLO_FirstLevelAfterCharacterCreation("Level1");

* Save your work.

== Setting up the Trigger ==

* Go to the Root Templates pane, find the point trigger, and place one on the level you need players to be transported to when character creation is finished.

* Name your trigger something logical then check the global box on the side bar.

* Right click your trigger and copy the TypeGUID_Name_GUID to clipboard.

*Paste the TypeGUID_Name_GUID into the goal _BasicCC_Creation_Start in the DB:
DB_CharacterCreationTransitionInfo("Level1"
* *NOTE* Do not delete the blue prefix (TRIGGERGUID), paste your information after that.

<gallery>
BCCTriggerGUID.png| Copy the GUID
BCCStoryEditor1.png| Paste it into the story editor in the blue box.
</gallery>

== Verify the Generic Origins ==

*The Generic Origin characters are inherited from the SHARED datapack.
*You need to double check that they have the same GUID in your mod as they do in the scripts. They most likely are the same.
 
* Open the [[World outliner|World Outliner]],
* Click the orange button on the top right corner to show all global objects.
* Find the character S_Player_GenericOrigin and copy the TypeGUID_Name_GUID to clipboard.
 
* Back in the story editor, compare the TypeGUID_Name_GUID you copied to the one in the DB: 
DB_GenericOrigins((CHARACTERGUID)S_Player_GenericOrigin_7b6c1f26-fe4e-40bd-a5d0-e6ff58cef4fe);

* the GUIDs are most likely the same, if not replace it.

* Still in the story editor, press CONTROL+F7 to generate definitions, build, and reload.

<gallery>
BCCOutliner.png | World Outliner
</gallery>

== Configure the Project Settings ==

* On the top menu go to Project > Project Settings
* Click the "General" tab.
* Change both the Startup Level and CharacterCreation Level to "SYS_Character_Creation_A".
* SYS_Character_Creation_A is located in the SYS folder. You will have to click on the top right corner "Show Inherited Levels"

<gallery>
BCCProjectSettings.png | Change both of the levels marked by the green arrow.
BCCLevelSelect3.png| Show the inherited levels.
</gallery>

* Save your work

== Finished ==

* Now your character should be usable both in the editor and in the game proper. Test it out!
* You will need to close out and reopen your project to see the changes in the editor.

Tutorial - Implementing a Basic Quest

2017-10-12T18:33:49Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-10-12T18:30:13Z

Windemere: /* Character Creation */

== Overview ==
This tutorial will provide an overview of all the steps necessary to implement a quest in a standalone campaign from scratch. It will not delve into any one area in great detail, the goal is to provide a 'big picture' walk through of some of the more commonly desired components in a quest. I will keep adding to it as time permits and when community feedback indicates additional areas of need. The current plan is to cover at least the following issues:
* Creating a new project and getting your first terrain testable.
* Placing and modifying an NPC
* Creating a default dialog for an NPC
* Creating a quest journal
* Enhancing dialogs to reflect quest progression
* Dealing with locked areas and containers
* Creating NPC Vendors
 
The end goal is to provide both video and written guides for each section. The video will be done first, followed by written guides. 
 
'''The Quest''': It's Launch Day at Larian Studios, but there is no power! Swen is lookin for a hero to save the day. Will it be you? 
 

== Creating a New Project and Playable Terrain ==
The first video in this series starts right at the beginning of creating a new Project, Level, and then a walkable terrain. It will not go in depth on terrain editing as there are good resources already available for it. 
 
[https://youtu.be/b5hCMWNEiE4 Creating a New Project and Playable Terrain (Youtube)] 

== Building Your First Story ==
The Story is an essential element to any campaign and should be compiled soon after creating your terrain. In this episode we cover the concept of a story and how it functions in the game. We'll go over how to build it and include a basic introduction to writing your own goals. 
 
[https://youtu.be/OvXiCglVOpU Building Your First Story (Youtube)] 

== Placing and Modifying an NPC ==
An overview of how to place an NPC in the game, customize its appearance, and some of the other important properties of an NPC. 
 
[https://youtu.be/N2u1eqqzlGo Placing and Modifying an NPC (Youtube)] 

== Creating a Default Dialog for an NPC ==
How to create a very basic dialog and assign it to an NPC. 
 
[https://youtu.be/XME89rtXzKQ Creating a Default Dialog for an NPC (Youtube)] 

== Creating and Updating a Quest Journal ==
Demonstrates how to create a quest journal and cause the first stage of a quest to be triggered from the dialog that was created in the previous tutorial. 
 
[https://youtu.be/lLEgNfAEL-k Creating and Updating a Quest Journal (Youtube)] 

== Quest State Driven Dialogs and Giving an Item ==
In this tutorial we re-visit our dialog to make it reflect the quest progression. Instead of asking the same question over and over and re-offering the quest, we add some additional dialog nodes and flags to provide a better user experience. We also use the dialog to trigger the giving of a weapon to the player through a story script, and we cover some useful debugging tools for dialogs and story scripts. 
 
[https://youtu.be/t44RhWE1aRs Quest State Driven Dialogs and Giving an Item (Youtube)] 

== Customizing Doors, Containers, and Object Tooltip Display ==
In this tutorial we move on from our quest setup and create a simple building with an entrance door. We examine the properties that control whether it is locked and how it can be unlocked. We also look at how to specify the strength of the door for potential destruction. We examine containers and adding items to them as well as pseudo-random treasure tables. Finally, we look at "Tooltip Type" settings for controlling when an object's display name is visible in the world. 
 
[https://youtu.be/u7VaIvYkNog Doors, Containers, and TooltipTypes (Youtube)] 

== Character Creation ==
In this tutorial we tackle adding real Character Creation to the campaign so that it can be played both within the editor and from the game client. We'll create a new goal in the story editor and paste in some code released by Larian for a standalone campaign. Then we will edit that code to workaround a discovered bug that prevents game made characters from entering combat with hostile NPCs. After we get our script working, we'll revisit it and go over what some of the frames within the goal are doing. Lastly, we will create a player companion that automatically gets added to the party when the game starts. 
 
Wiki Page on creating an adventure and adding character creation: 
[[My_first:_Adventure#Necessary_scripting]] 
 
[https://youtu.be/Yq6Rm_Kqb5g Character Creation (Youtube)] 
[https://youtu.be/8bavkSt29js Character Creation and Story Cleanup (Youtube)]

Community page submission

2017-10-11T19:53:10Z

Windemere:

Welcome to the community page submission section. 
First and foremost: thanks to all of you from everyone at Larian Studios! 
Without your love and feedback, we wouldn't be where we are today.

 
 
That being said, let's do our best to keep this wiki just as lovely as you guys: 
# To add your page to the main wiki pages, please add it to the list below.
# Once our moderators get a chance, they'll review the submissions and move approved pages to the appropriate location on the [[Community editor guides | Editor Guides]] and/or [[Community tutorials | Community Tutorials]] section.
# We'll leave the page link a couple of days on here with an approval stamp and a link to its new location, to give the editor a chance to find out where his/her page went.
# We love you all very much, but we do not tolerate any misbehavior. Please refrain from using foul language, messing with other people's pages,...
# This wiki follows the general open format. Anyone is allowed to edit a page. View an edit to your page as interest in your content, not as criticism.
# But do try to avoid editing someone else's pages before it has been approved and moved to the main sections, unless of course you have the permission to do so from the original editor.
# As always, stay awesome [[File: heart.png | 32px]]
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Example Submission|Example submission]]</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Subregion UI Notifications|Subregion UI Notifications]]</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[How to make an NPC sit|How to make an NPC sit]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Creating a book with TEXT inside|Creating a book with TEXT inside]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Pak Extractor Guide|Pak Extractor Guide]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community editor guides|Editor Guides]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Tutorial - Implementing a Basic Quest|Tutorial - Implementing a Basic Quest]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]]) ([[Community:_Getting_Started|Editor Guides]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[NPC Patrols|NPC Patrols]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Basic Character Creation]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Character and Item Script Triggers, Calls, and Queries]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community:_Script_editor|Editor Guides]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Scripting in New Talents, Attributes, and Combat Abilities]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]])([[Community:_Story_editor|Editor Guides]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Creating/Modifying Weapon Elements and Scaling]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]])([[Community:_Stats_editor|Editor Guides]])</big>
 

[[File:LarianLogo_Icon.png|32px]] <big>[[Adding New Icons]] [[File:LarianLogo_Icon.png|32px]] APPROVED ([[Community tutorials|Community Tutorials]])([[Community:_Texture_atlas_editor|Editor Guides]])</big>

Subregion UI Notifications

2017-10-11T19:52:23Z

Windemere:

== Description ==

Sub-regions can be used to provide some extra polish and regional distinction within a level by displaying a ribbon UI with its name to the screen. For example in Origins:

[[File:TUT SubregionText 00.png|thumb|none]]

== Procedure ==
Adding sub-region UI notifications to your level is a three step process:

=== 1. Create a Trigger to Define the Sub-region ===
You can choose a simple box trigger or poly trigger to define the boundaries. Anytime a character enters the trigger, the sub-region ribbon text will get displayed. It will be helpful to give it a unique name that you can easily identify.

[[File:TUT SubregionText 01.png|1024px|none]]
 
=== 2. Define a DB_Subregion in a Story Goal ===
Larian have provided a simple interface to identify a sub-region using the DB_Subregion() database procedure defined in the ''_GLOBAL_Subregions'' goal. 
DB_Subregion((TRIGGERGUID)_Trigger,(STRING)_,(INTEGER)_)
The first argument is the GUID of the trigger you created in step 1 above. The second argument is a string value that represents a key into a [[Translated_string_key_editor|Translated String Key Editor]] entry where the actual display name of the sub-region will be defined. 
 
Example based on the trigger created in step 1 above: 
DB_Subregion(TRIGGERGUID_TRG_Moon_Iolo_hut_09b43f5f-278c-409a-9aaa-bf31b7364538, "LVL_SUB_IOLOS_HUT", 0);
'''NOTE:''' Regarding where to add these story calls, please become acquainted with [[Osiris_Design_Patterns#Direct_Dependencies|Osiris Dependencies]] to make sure that the _GLOBAL_Subregions goal has initialized prior to the execution of this frame. 
 
=== 3. Create the Corresponding Translated String Key Entry ===
Now that your story captures the event when a character enters a trigger, it will look for an entry in the Translated String Key table with the matching 'Key' field and display whatever is found in the 'Description' field. 
 
In our example, when a player enters the trigger we want a sub-region that displays "Iolo's Hut". Given the trigger we defined in step 1 and the sub-region we created in step 2, our table entry would appear as follows: 
{| class="wikitable"
|-
| [1] Key|| LVL_SUB_IOLOS_HUT
|-
| [2] Description|| Iolo's Hut
|}
[[File:TUT SubregionText 02.png|none|1024px]] 
Note: If this is the first Translated String key entry you have needed for your mod, you made need to create a table using the create button [3] highlighted in the image above. 
Once you have created and saved the entry, you will need to restart your project to see the results (and perhaps even the editor?). 
=== Final Results ===
[[File:TUT SubregionText 03.jpg|none|thumb]]

Subregion UI Notifications

2017-10-11T19:48:16Z

Windemere:

== Description ==

Sub-regions can be used to provide some extra polish and regional distinction within a level by displaying a ribbon UI with its name to the screen. For example in Origins:

[[File:TUT SubregionText 00.png|thumb|none]]

== Procedure ==
Adding sub-region UI notifications to your level is a three step process:

=== 1. Create a Trigger to Define the Sub-region ===
You can choose a simple box trigger or poly trigger to define the boundaries. Anytime a character enters the trigger, the sub-region ribbon text will get displayed. It will be helpful to give it a unique name that you can easily identify.

[[File:TUT SubregionText 01.png|1024px|none]]
 
=== 2. Define a DB_Subregion in a Story Goal ===
Larian have provided a simple interface to identify a sub-region using the DB_Subregion() database procedure defined in the ''_GLOBAL_Subregions'' goal. 
DB_Subregion((TRIGGERGUID)_Trigger,(STRING)_,(INTEGER)_)
The first argument is the GUID of the trigger you created in step 1 above. The second argument is a string value that represents a key into a [[Translated_string_key_editor|Translated String Key Editor]] entry where the actual display name of the sub-region will be defined. 
 
Example based on the trigger created in step 1 above: 
DB_Subregion(TRIGGERGUID_TRG_Moon_Iolo_hut_09b43f5f-278c-409a-9aaa-bf31b7364538, "LVL_SUB_IOLOS_HUT", 0);

=== 3. Create the Corresponding Translated String Key Entry ===
Now that your story captures the event when a character enters a trigger, it will look for an entry in the Translated String Key table with the matching 'Key' field and display whatever is found in the 'Description' field. 
 
In our example, when a player enters the trigger we want a sub-region that displays "Iolo's Hut". Given the trigger we defined in step 1 and the sub-region we created in step 2, our table entry would appear as follows: 
{| class="wikitable"
|-
| [1] Key|| LVL_SUB_IOLOS_HUT
|-
| [2] Description|| Iolo's Hut
|}
[[File:TUT SubregionText 02.png|none|1024px]] 
Note: If this is the first Translated String key entry you have needed for your mod, you made need to create a table using the create button [3] highlighted in the image above. 
Once you have created and saved the entry, you will need to restart your project to see the results (and perhaps even the editor?). 
=== Final Results ===
[[File:TUT SubregionText 03.jpg|none|thumb]]

Subregion UI Notifications

2017-10-11T19:47:28Z

Windemere: Created page with "== Description == Sub-regions can be used to provide some extra polish and regional distinction within a level by displaying a ribbon UI with its name to the screen. For exam..."

== Description ==

Sub-regions can be used to provide some extra polish and regional distinction within a level by displaying a ribbon UI with its name to the screen. For example in Origins:

[[File:TUT SubregionText 00.png|thumb|none]]

== Procedure ==
Adding sub-regions to your level is a three step process:

=== 1. Create a Trigger to Define the Sub-region ===
You can choose a simple box trigger or poly trigger to define the boundaries. Anytime a character enters the trigger, the sub-region ribbon text will get displayed. It will be helpful to give it a unique name that you can easily identify.

[[File:TUT SubregionText 01.png|1024px|none]]
 
=== 2. Define a DB_Subregion in a Story Goal ===
Larian have provided a simple interface to identify a sub-region using the DB_Subregion() database procedure defined in the ''_GLOBAL_Subregions'' goal. 
DB_Subregion((TRIGGERGUID)_Trigger,(STRING)_,(INTEGER)_)
The first argument is the GUID of the trigger you created in step 1 above. The second argument is a string value that represents a key into a [[Translated_string_key_editor|Translated String Key Editor]] entry where the actual display name of the sub-region will be defined. 
 
Example based on the trigger created in step 1 above: 
DB_Subregion(TRIGGERGUID_TRG_Moon_Iolo_hut_09b43f5f-278c-409a-9aaa-bf31b7364538, "LVL_SUB_IOLOS_HUT", 0);

=== 3. Create the Corresponding Translated String Key Entry ===
Now that your story captures the event when a character enters a trigger, it will look for an entry in the Translated String Key table with the matching 'Key' field and display whatever is found in the 'Description' field. 
 
In our example, when a player enters the trigger we want a sub-region that displays "Iolo's Hut". Given the trigger we defined in step 1 and the sub-region we created in step 2, our table entry would appear as follows: 
{| class="wikitable"
|-
| [1] Key|| LVL_SUB_IOLOS_HUT
|-
| [2] Description|| Iolo's Hut
|}
[[File:TUT SubregionText 02.png|none|1024px]] 
Note: If this is the first Translated String key entry you have needed for your mod, you made need to create a table using the create button [3] highlighted in the image above. 
Once you have created and saved the entry, you will need to restart your project to see the results (and perhaps even the editor?). 
=== Final Results ===
[[File:TUT SubregionText 03.jpg|none|thumb]]

File:TUT SubregionText 03.jpg

2017-10-11T19:41:03Z

Windemere:

File:TUT SubregionText 02.png

2017-10-11T19:32:11Z

Windemere:

File:TUT SubregionText 01.png

2017-10-11T18:58:45Z

Windemere:

File:TUT SubregionText 00.png

2017-10-11T18:50:56Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-10-05T04:38:28Z

Windemere:

== Overview ==
This tutorial will provide an overview of all the steps necessary to implement a quest in a standalone campaign from scratch. It will not delve into any one area in great detail, the goal is to provide a 'big picture' walk through of some of the more commonly desired components in a quest. I will keep adding to it as time permits and when community feedback indicates additional areas of need. The current plan is to cover at least the following issues:
* Creating a new project and getting your first terrain testable.
* Placing and modifying an NPC
* Creating a default dialog for an NPC
* Creating a quest journal
* Enhancing dialogs to reflect quest progression
* Dealing with locked areas and containers
* Creating NPC Vendors
 
The end goal is to provide both video and written guides for each section. The video will be done first, followed by written guides. 
 
'''The Quest''': It's Launch Day at Larian Studios, but there is no power! Swen is lookin for a hero to save the day. Will it be you? 
 

== Creating a New Project and Playable Terrain ==
The first video in this series starts right at the beginning of creating a new Project, Level, and then a walkable terrain. It will not go in depth on terrain editing as there are good resources already available for it. 
 
[https://youtu.be/b5hCMWNEiE4 Creating a New Project and Playable Terrain (Youtube)] 

== Building Your First Story ==
The Story is an essential element to any campaign and should be compiled soon after creating your terrain. In this episode we cover the concept of a story and how it functions in the game. We'll go over how to build it and include a basic introduction to writing your own goals. 
 
[https://youtu.be/OvXiCglVOpU Building Your First Story (Youtube)] 

== Placing and Modifying an NPC ==
An overview of how to place an NPC in the game, customize its appearance, and some of the other important properties of an NPC. 
 
[https://youtu.be/N2u1eqqzlGo Placing and Modifying an NPC (Youtube)] 

== Creating a Default Dialog for an NPC ==
How to create a very basic dialog and assign it to an NPC. 
 
[https://youtu.be/XME89rtXzKQ Creating a Default Dialog for an NPC (Youtube)] 

== Creating and Updating a Quest Journal ==
Demonstrates how to create a quest journal and cause the first stage of a quest to be triggered from the dialog that was created in the previous tutorial. 
 
[https://youtu.be/lLEgNfAEL-k Creating and Updating a Quest Journal (Youtube)] 

== Quest State Driven Dialogs and Giving an Item ==
In this tutorial we re-visit our dialog to make it reflect the quest progression. Instead of asking the same question over and over and re-offering the quest, we add some additional dialog nodes and flags to provide a better user experience. We also use the dialog to trigger the giving of a weapon to the player through a story script, and we cover some useful debugging tools for dialogs and story scripts. 
 
[https://youtu.be/t44RhWE1aRs Quest State Driven Dialogs and Giving an Item (Youtube)] 

== Customizing Doors, Containers, and Object Tooltip Display ==
In this tutorial we move on from our quest setup and create a simple building with an entrance door. We examine the properties that control whether it is locked and how it can be unlocked. We also look at how to specify the strength of the door for potential destruction. We examine containers and adding items to them as well as pseudo-random treasure tables. Finally, we look at "Tooltip Type" settings for controlling when an object's display name is visible in the world. 
 
[https://youtu.be/u7VaIvYkNog Doors, Containers, and TooltipTypes (Youtube)] 

== Character Creation ==
In this tutorial we tackle adding real Character Creation to the campaign so that it can be played both within the editor and from the game client. We'll create a new goal in the story editor and paste in some code released by Larian for a standalone campaign. Then we will edit that code to workaround a discovered bug that prevents game made characters from entering combat with hostile NPCs. After we get our script working, we'll revisit it and go over what some of the frames within the goal are doing. Lastly, we will create a player companion that automatically gets added to the party when the game starts. 
 
Wiki Page on creating an adventure and adding character creation: 
[[My_first:_Adventure#Necessary_scripting]] 
 
[https://youtu.be/Yq6Rm_Kqb5g Character Creation (Youtube)]

Tutorial - Implementing a Basic Quest

2017-09-26T03:26:57Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-22T05:15:17Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-20T19:54:38Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-20T19:48:00Z

Windemere: /* Creating a New Project and Playable Terrain */

Secret Dirt Piles

2017-09-20T16:01:46Z

Windemere: /* Osiris Story Calls */

== Overview ==
This tutorial provides an example of how to create a secret dirt pile that needs to be dug up, with a variety of possible results following (item spawn, surface appearing, voice bark, etc.). It makes use of shared resources already provided by Larian. You will need the following:

* Root template item PUZ_Dirtpile_A_Dynamic placed in your level
* A box trigger
* A couple of Osiris calls in your story
* (optional) item or creature to appear

== The Dirt Pile ==
From the root template, place an instance of the PUZ_Dirtpile_A_Dynamic item in your level. Feel free to rename the placed instance to whatever is meaningful to you. You can then modify some behaviors of the dirt pile with the associated script by clicking on the [...] box.
{| class="wikitable"
|-
! Item !!
|-
| Scripts||[1] PUZZLE_HiddenPerception [...]
|}
 

[[File:TUT SecretDirtPile ScriptProperties.png|1024px|none|Secret Dirt Puzzle Script Properties]]
 
The script variables adjust the difficulty of perceiving the mound, the minimum range, visual effect to be played, etc. 
 
If you plan to have a specific item appear after digging up the dirt pile, a convenient place to stash it away is the inventory of the dirt pile itself. Simply add the item you want to reward to your level and then move it to the dirt pile inventory through the ''Items'' property within the Item section.
{| class="wikitable"
|-
! Item !!
|-
| Items||[0] [...]
|}
 
This will display a new box where you can filter by name and 'Level Items' to find the item you placed in your level. 
[[File:TUT SecretDirtPile ItemAssignment.png|none|1024px]]
 
Simply move your placed item into the 'Assigned' window pane and the editor will move it from wherever you placed it in the level to the inventory of the dirt pile. This way you have a concrete instance of the item that can be referenced by GUID but will not be seen by any player until it is discovered through digging up the dirt pile.

== The Box Trigger ==
A box trigger is used to inform the story scripting where a digable area exists and where to spawn any resulting objects. Select a box trigger from the Root Templates and place it on top of your dirt mound. Feel free to assign it a unique name that is easy to find later. With the trigger selected, you can then define its boundaries by selecting the "Edit Shape Bounds" Mode button on the left and dragging the corners of the trigger to cover the appropriate area. 

[[File:TUT SecretDirtPile BoxTrigger.png|none|1024px]]

== Osiris Story Calls ==
Larian has created some shared helper code to make it easy to inform your story about the behavior of your secret dirt pile. They are located in the "''__GLO_Shovel''" file. You will need to add two calls somewhere in one of your story INIT sections (do not modify __GLO_Shovel directly): 
 
* DB_ShovelArea(_Trigger,_Reward,_DirtMound) 
 
Plus one of the following: 
* DB_ShovelRewardItemAppear(_Reward,(ITEMGUID)_Item,(TRIGGERGUID)_Trigger)
* DB_ShovelRewardCharacterAppear(_Reward,(CHARACTERGUID)_Character)
* DB_ShovelRewardSurface(_Reward,(TRIGGERGUID)_Trigger, (STRING)_Type, (REAL)_Radius, (REAL)_Lifetime)
* DB_ShovelRewardVoiceBark(_Reward, (STRING)_VoiceBark)
* DB_ShovelRewardItemTemplate(_Reward,(STRING)_ItemTemplate,(INTEGER)_Amount) 
 
Note that both the DB_ShovelArea() and DB_ShovelRewardXXX() calls make use of a ''_Reward'' string variable. This is the name of a reward database entry that you are creating, and when you create a DB_ShovelArea() entry, your ''_Reward'' value should match at least one instance of a DB_ShovelRewardXXX(). 
 
'''NOTE:''' Regarding where to add these story calls, please become acquainted with [[Osiris_Design_Patterns#Direct_Dependencies|Osiris Dependencies]] to make sure that the __GLO_shovel story has initialized prior to your story. 
 
Example 
INIT

DB_ShovelArea(TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444, "hugh_pile_reward", ITEMGUID_PUZ_Dirtpile_hugh_4984f867-e69e-4579-8436-b45ebdd06358);

DB_ShovelRewardItemAppear("hugh_pile_reward", ITEMGUID_Item_Hugh_8485bd59-77fb-4800-9f5d-5071707de6b5, TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444);

In this example, the first line defines a shovel area using the trigger we added to the level and associates the reward "hugh_pile_reward" with the dirt pile we placed in that trigger. The second line defines what "hugh_pile_reward" is: an item we placed in our level (Item_Hugh_[GUID]) and the trigger in which it should spawn (the one we placed earlier).

Tutorial - Implementing a Basic Quest

2017-09-20T03:14:03Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-19T16:03:37Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-19T13:34:49Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-19T03:45:10Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-18T15:24:10Z

Windemere: /* Overview */

Tutorial - Implementing a Basic Quest

2017-09-18T15:23:15Z

Windemere:

Community page submission

2017-09-18T15:22:31Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-18T15:21:56Z

Windemere:

Tutorial - Implementing a Basic Quest

2017-09-18T15:13:27Z

Windemere: Created page with "== Overview == This tutorial will provide an overview of all the steps necessary to implement a quest in a standalone campaign from scratch. It will not delve into any one are..."

User:Windemere

2017-09-15T14:36:12Z

Windemere: Created page with "Long time Larian fan with some previous modding experience with Neverwinter Nights 2 and Dragon Age. I participated in the early access evaluation of the DOS:2 editor and hope..."

Long time Larian fan with some previous modding experience with Neverwinter Nights 2 and Dragon Age. I participated in the early access evaluation of the DOS:2 editor and hope to assist in fostering a thriving modding community for it. While far from an expert in every area of the editor, feel free to reach out to me with questions if I can be of any assistance. 
 
* Larian Forums: [http://larian.com/forums/ubbthreads.php?ubb=showprofile&User=22728 Profile for Windemere] 
* Discord: Windemere#7113
* [http://steamcommunity.com/profiles/76561198045493691 Steam Profile]

Locked Doors and Containers

2017-09-12T20:48:11Z

Windemere: /* Object Configuration */

== Object Configuration ==
In order to lock a door or container, there are two properties under the objects 'Item' sub-category that need to be addressed (shown in bold):

{| class="wikitable"
|-
! Item !!
|-
| ...||
|-
| Items||
|-
| '''Key'''|| ''<key name>''
|-
| LevelOverride||
|-
| LevelOverrideCurrent||
|-
| '''LockLevel''' || ''<level>''
|-
| ...||
|}
 
'''Key''': The name of the key that can unlock this door or container. This field must be given a value even if you never plan to create such a key in game. Otherwise, the object will not be locked. 
 
'''LockLevel''': The level of thievery required to pick the lock if the player is without the above named key.
 

== Examples ==
<ol>
<li>A simple, locked door that requires thievery level 2 to unlock
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_null
|-
| '''LockLevel''' || 2
|}
* key_null is never created in the game and does not exist
</li> 
<li>A locked door that can only be opened with a specific key named 'key_master'
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_master
|-
| '''LockLevel''' || 100
|}
* By setting the lock level to 100, it is impossible to get thievery high enough to unlock it without possession of 'key_master'
* There would need to be a key created somewhere in the game with the name 'key_master' to open the door (apart from scripting).
</li> 
<li>A locked door that can be opened with a specific key named 'key_owner' OR thievery level 3
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_owner
|-
| '''LockLevel''' || 3
|}
</li>

Locked Doors and Containers

2017-09-12T20:47:49Z

Windemere: /* Object Configuration */

== Object Configuration ==
In order to lock a door or container, there are two properties under the objects 'Item' sub-category that need to be addressed (shown in bold):

{| class="wikitable"
|-
! Item !!
|-
| ...||
|-
| Items||
|-
| '''Key'''|| ''<key name>''
|-
| LevelOverride||
|-
| LevelOverrideCurrent||
|-
| '''LockLevel''' || ''<level>''
|-
| ...||
|}
 
'''Key''': The name of the key that can unlock this door or container. This field must be given a value even if you never plan to create such a key in game. Otherwise, the object will not be locked. 
 
'''LockLevel''': The level of thievery required to open the lock if the player is without the above named key.
 

== Examples ==
<ol>
<li>A simple, locked door that requires thievery level 2 to unlock
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_null
|-
| '''LockLevel''' || 2
|}
* key_null is never created in the game and does not exist
</li> 
<li>A locked door that can only be opened with a specific key named 'key_master'
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_master
|-
| '''LockLevel''' || 100
|}
* By setting the lock level to 100, it is impossible to get thievery high enough to unlock it without possession of 'key_master'
* There would need to be a key created somewhere in the game with the name 'key_master' to open the door (apart from scripting).
</li> 
<li>A locked door that can be opened with a specific key named 'key_owner' OR thievery level 3
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_owner
|-
| '''LockLevel''' || 3
|}
</li>

Locked Doors and Containers

2017-09-12T20:46:57Z

Windemere: Created page with "== Object Configuration == In order to lock a door or container, there are two properties under the objects 'Item' sub-category that need to be addressed (shown in bold): {|..."

== Object Configuration ==
In order to lock a door or container, there are two properties under the objects 'Item' sub-category that need to be addressed (shown in bold):

{| class="wikitable"
|-
! Item !!
|-
| ...||
|-
| Items||
|-
| '''Key'''|| ''<key name>''
|-
| LevelOverride||
|-
| LevelOverrideCurrent||
|-
| '''LockLevel''' || ''<level>''
|-
| ...||
|}
 
'''Key''': The name of the key that can unlock this door or container. This field must be given a value even if you never plan to create such a key in game. Otherwise, the object will not be locked. 
 
'''LockLevel''': The level of thievery required to pick the lock if the player is without the above named key.
 
== Examples ==
<ol>
<li>A simple, locked door that requires thievery level 2 to unlock
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_null
|-
| '''LockLevel''' || 2
|}
* key_null is never created in the game and does not exist
</li> 
<li>A locked door that can only be opened with a specific key named 'key_master'
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_master
|-
| '''LockLevel''' || 100
|}
* By setting the lock level to 100, it is impossible to get thievery high enough to unlock it without possession of 'key_master'
* There would need to be a key created somewhere in the game with the name 'key_master' to open the door (apart from scripting).
</li> 
<li>A locked door that can be opened with a specific key named 'key_owner' OR thievery level 3
{| class="wikitable"
|-
! Property !! Value
|-
| '''Key'''|| key_owner
|-
| '''LockLevel''' || 3
|}
</li>

Community tutorials

2017-09-12T20:04:55Z

Windemere:

* [[Custom Menu Screens]]
* [[Locked Doors and Containers]]
* [[Secret Dirt Piles]]

Secret Dirt Piles

2017-09-12T19:46:47Z

Windemere: /* Osiris Story Calls */

== Overview ==
This tutorial provides an example of how to create a secret dirt pile that needs to be dug up, with a variety of possible results following (item spawn, surface appearing, voice bark, etc.). It makes use of shared resources already provided by Larian. You will need the following:

* Root template item PUZ_Dirtpile_A_Dynamic placed in your level
* A box trigger
* A couple of Osiris calls in your story
* (optional) item or creature to appear

== The Dirt Pile ==
From the root template, place an instance of the PUZ_Dirtpile_A_Dynamic item in your level. Feel free to rename the placed instance to whatever is meaningful to you. You can then modify some behaviors of the dirt pile with the associated script by clicking on the [...] box.
{| class="wikitable"
|-
! Item !!
|-
| Scripts||[1] PUZZLE_HiddenPerception [...]
|}
 

[[File:TUT SecretDirtPile ScriptProperties.png|1024px|none|Secret Dirt Puzzle Script Properties]]
 
The script variables adjust the difficulty of perceiving the mound, the minimum range, visual effect to be played, etc. 
 
If you plan to have a specific item appear after digging up the dirt pile, a convenient place to stash it away is the inventory of the dirt pile itself. Simply add the item you want to reward to your level and then move it to the dirt pile inventory through the ''Items'' property within the Item section.
{| class="wikitable"
|-
! Item !!
|-
| Items||[0] [...]
|}
 
This will display a new box where you can filter by name and 'Level Items' to find the item you placed in your level. 
[[File:TUT SecretDirtPile ItemAssignment.png|none|1024px]]
 
Simply move your placed item into the 'Assigned' window pane and the editor will move it from wherever you placed it in the level to the inventory of the dirt pile. This way you have a concrete instance of the item that can be referenced by GUID but will not be seen by any player until it is discovered through digging up the dirt pile.

== The Box Trigger ==
A box trigger is used to inform the story scripting where a digable area exists and where to spawn any resulting objects. Select a box trigger from the Root Templates and place it on top of your dirt mound. Feel free to assign it a unique name that is easy to find later. With the trigger selected, you can then define its boundaries by selecting the "Edit Shape Bounds" Mode button on the left and dragging the corners of the trigger to cover the appropriate area. 

[[File:TUT SecretDirtPile BoxTrigger.png|none|1024px]]

== Osiris Story Calls ==
Larian has created some shared helper code to make it easy to inform your story about the behavior of your secret dirt pile. They are located in the "''__GLO_Shovel''" file. You will need to add two calls somewhere in your story INIT section: 
 
* DB_ShovelArea(_Trigger,_Reward,_DirtMound) 
 
Plus one of the following: 
* DB_ShovelRewardItemAppear(_Reward,(ITEMGUID)_Item,(TRIGGERGUID)_Trigger)
* DB_ShovelRewardCharacterAppear(_Reward,(CHARACTERGUID)_Character)
* DB_ShovelRewardSurface(_Reward,(TRIGGERGUID)_Trigger, (STRING)_Type, (REAL)_Radius, (REAL)_Lifetime)
* DB_ShovelRewardVoiceBark(_Reward, (STRING)_VoiceBark)
* DB_ShovelRewardItemTemplate(_Reward,(STRING)_ItemTemplate,(INTEGER)_Amount) 
 
Note that both the DB_ShovelArea() and DB_ShovelRewardXXX() calls make use of a ''_Reward'' string variable. This is the name of a reward database entry that you are creating, and when you create a DB_ShovelArea() entry, your ''_Reward'' value should match at least one instance of a DB_ShovelRewardXXX(). 
 
Example 
INIT

DB_ShovelArea(TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444, "hugh_pile_reward", ITEMGUID_PUZ_Dirtpile_hugh_4984f867-e69e-4579-8436-b45ebdd06358);

DB_ShovelRewardItemAppear("hugh_pile_reward", ITEMGUID_Item_Hugh_8485bd59-77fb-4800-9f5d-5071707de6b5, TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444);

In this example, the first line defines a shovel area using the trigger we added to the level and associates the reward "hugh_pile_reward" with the dirt pile we placed in that trigger. The second line defines what "hugh_pile_reward" is: an item we placed in our level (Item_Hugh_[GUID]) and the trigger in which it should spawn (the one we placed earlier).

Secret Dirt Piles

2017-09-12T19:43:18Z

Windemere: /* The Dirt Pile */

== Overview ==
This tutorial provides an example of how to create a secret dirt pile that needs to be dug up, with a variety of possible results following (item spawn, surface appearing, voice bark, etc.). It makes use of shared resources already provided by Larian. You will need the following:

* Root template item PUZ_Dirtpile_A_Dynamic placed in your level
* A box trigger
* A couple of Osiris calls in your story
* (optional) item or creature to appear

== The Dirt Pile ==
From the root template, place an instance of the PUZ_Dirtpile_A_Dynamic item in your level. Feel free to rename the placed instance to whatever is meaningful to you. You can then modify some behaviors of the dirt pile with the associated script by clicking on the [...] box.
{| class="wikitable"
|-
! Item !!
|-
| Scripts||[1] PUZZLE_HiddenPerception [...]
|}
 

[[File:TUT SecretDirtPile ScriptProperties.png|1024px|none|Secret Dirt Puzzle Script Properties]]
 
The script variables adjust the difficulty of perceiving the mound, the minimum range, visual effect to be played, etc. 
 
If you plan to have a specific item appear after digging up the dirt pile, a convenient place to stash it away is the inventory of the dirt pile itself. Simply add the item you want to reward to your level and then move it to the dirt pile inventory through the ''Items'' property within the Item section.
{| class="wikitable"
|-
! Item !!
|-
| Items||[0] [...]
|}
 
This will display a new box where you can filter by name and 'Level Items' to find the item you placed in your level. 
[[File:TUT SecretDirtPile ItemAssignment.png|none|1024px]]
 
Simply move your placed item into the 'Assigned' window pane and the editor will move it from wherever you placed it in the level to the inventory of the dirt pile. This way you have a concrete instance of the item that can be referenced by GUID but will not be seen by any player until it is discovered through digging up the dirt pile.

== The Box Trigger ==
A box trigger is used to inform the story scripting where a digable area exists and where to spawn any resulting objects. Select a box trigger from the Root Templates and place it on top of your dirt mound. Feel free to assign it a unique name that is easy to find later. With the trigger selected, you can then define its boundaries by selecting the "Edit Shape Bounds" Mode button on the left and dragging the corners of the trigger to cover the appropriate area. 

[[File:TUT SecretDirtPile BoxTrigger.png|none|1024px]]

== Osiris Story Calls ==
Larian has created some shared helper code to make it easy to inform your story about the behavior of your secret dirt pile. They are located in the "''__GLO_Shovel''" file. You will need to add two calls somewhere in your story INIT section: 
 
* DB_ShovelArea(_Trigger,_Reward,_DirtMound) 
 
Plus one of the following: 
* DB_ShovelRewardItemAppear(_Reward,(ITEMGUID)_Item,(TRIGGERGUID)_Trigger)
* DB_ShovelRewardCharacterAppear(_Reward,(CHARACTERGUID)_Character)
* DB_ShovelRewardSurface(_Reward,(TRIGGERGUID)_Trigger, (STRING)_Type, (REAL)_Radius, (REAL)_Lifetime)
* DB_ShovelRewardVoiceBark(_Reward, (STRING)_VoiceBark)
* DB_ShovelRewardItemTemplate(_Reward,(STRING)_ItemTemplate,(INTEGER)_Amount) 
 
Note that both the DB_ShovelArea() and DB_ShovelRewardXXX() calls make use of a ''_Reward'' string variable. This is the name of a reward database entry that you are creating, and when you create a DB_ShovelArea() entry, your '_Reward' value should match at least one instance of a DB_ShovelRewardXXX(). 
 
Example 
INIT

DB_ShovelArea(TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444, "hugh_pile_reward", ITEMGUID_PUZ_Dirtpile_hugh_4984f867-e69e-4579-8436-b45ebdd06358);

DB_ShovelRewardItemAppear("hugh_pile_reward", ITEMGUID_Item_Hugh_8485bd59-77fb-4800-9f5d-5071707de6b5, TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444);

In this example, the first line defines a shovel area using the trigger we added to the level and associates the reward "hugh_pile_reward" with the dirt pile we placed in that trigger. The second line defines what "hugh_pile_reward" is: an item we placed in our level (Item_Hugh_[GUID]) and the trigger in which it should spawn (the one we placed earlier).

File:TUT SecretDirtPile ItemAssignment.png

2017-09-12T19:27:49Z

Windemere:

Secret Dirt Piles

2017-09-12T19:10:44Z

Windemere: /* Osiris Story Calls */

== Overview ==
This tutorial provides an example of how to create a secret dirt pile that needs to be dug up, with a variety of possible results following (item spawn, surface appearing, voice bark, etc.). It makes use of shared resources already provided by Larian. You will need the following:

* Root template item PUZ_Dirtpile_A_Dynamic placed in your level
* A box trigger
* A couple of Osiris calls in your story
* (optional) item or creature to appear

== The Dirt Pile ==
From the root template, place an instance of the PUZ_Dirtpile_A_Dynamic item in your level. Feel free to rename the placed instance to whatever is meaningful to your mod and level.

You can modify some behaviors of the dirt pile with the associated script by clicking on the [...] box. Search the item properties of the dirt pile for the following entry: 
... 
'''[Scripts][[1] PUZZLE_HiddenPerception]''' 

[[File:TUT SecretDirtPile ScriptProperties.png|1024px|none|Secret Dirt Puzzle Script Properties]]

The script variables adjust the difficulty of perceiving the mound, the minimum range, visual effect to be played, etc.

== The Box Trigger ==
A box trigger is used to inform the story scripting where a digable area exists and where to spawn any resulting objects. Select a box trigger from the Root Templates and place it on top of your dirt mound. Feel free to assign it a unique name that is easy to find later. With the trigger selected, you can then define its boundaries by selecting the "Edit Shape Bounds" Mode button on the left and dragging the corners of the trigger to cover the appropriate area. 

[[File:TUT SecretDirtPile BoxTrigger.png|none|1024px]]

== Osiris Story Calls ==
Larian has created some shared helper code to make it easy to inform your story about the behavior of your secret dirt pile. They are located in the "''__GLO_Shovel''" file. You will need to add two calls somewhere in your story INIT section: 
 
* DB_ShovelArea(_Trigger,_Reward,_DirtMound) 
 
Plus one of the following: 
* DB_ShovelRewardItemAppear(_Reward,(ITEMGUID)_Item,(TRIGGERGUID)_Trigger)
* DB_ShovelRewardCharacterAppear(_Reward,(CHARACTERGUID)_Character)
* DB_ShovelRewardSurface(_Reward,(TRIGGERGUID)_Trigger, (STRING)_Type, (REAL)_Radius, (REAL)_Lifetime)
* DB_ShovelRewardVoiceBark(_Reward, (STRING)_VoiceBark)
* DB_ShovelRewardItemTemplate(_Reward,(STRING)_ItemTemplate,(INTEGER)_Amount) 
 
Note that both the DB_ShovelArea() and DB_ShovelRewardXXX() calls make use of a ''_Reward'' string variable. This is the name of a reward database entry that you are creating, and when you create a DB_ShovelArea() entry, your '_Reward' value should match at least one instance of a DB_ShovelRewardXXX(). 
 
Example 
INIT

DB_ShovelArea(TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444, "hugh_pile_reward", ITEMGUID_PUZ_Dirtpile_hugh_4984f867-e69e-4579-8436-b45ebdd06358);

DB_ShovelRewardItemAppear("hugh_pile_reward", ITEMGUID_Item_Hugh_8485bd59-77fb-4800-9f5d-5071707de6b5, TRIGGERGUID_BoxTrigger_hugh_pile_79c5bc2b-421b-42ff-b987-a4ac282d5444);

In this example, the first line defines a shovel area using the trigger we added to the level and associates the reward "hugh_pile_reward" with the dirt pile we placed in that trigger. The second line defines what "hugh_pile_reward" is: an item we placed in our level (Item_Hugh_[GUID]) and the trigger in which it should spawn (the one we placed earlier).

Secret Dirt Piles

2017-09-12T18:54:24Z

Windemere:

Secret Dirt Piles

2017-09-12T18:33:55Z

Windemere: /* The Box Trigger */

Secret Dirt Piles

2017-09-12T18:21:42Z

Windemere: Created page with "== Overview == This tutorial provides an example of how to create a secret dirt pile that needs to be dug up, with a variety of possible results following (item spawn, surface..."

File:TUT SecretDirtPile BoxTrigger.png

2017-09-12T18:21:00Z

Windemere:

File:TUT SecretDirtPile ScriptProperties.png

2017-09-12T17:55:20Z

Windemere:

Custom Menu Screens

2017-09-05T23:28:32Z

Windemere:

== Preparing the Level ==
Custom Menu Screens are created by adding a Spectator Camera Trigger to a level and then linking it to the project settings for your mod. There are some special rules to know about when designing your level to be used as a Menu Screen. When the menu screen is displayed from the game menu, there is no server running, which means that spawned creatures and interactive items will not display. For this reason, most artists prefer to create levels or terrains specifically tailored as menus screens rather than using the ones played in game. Doing this also allows for more creativity in moving objects around and adjusting the lighting for the specific field of view that the camera will have.

== Placing Your Menu Camera ==

* Select the SpectatorCameraTrigger from your Root Templates and add it somewhere in your level. Alternatively, the editor has a convenience option under the Tools menu to ''Place spec cam at current pos'', which will place a SpectatorCameraTrigger at the current position of the camera in the editor.

* Give your new SpectatorCameraTrigger the name 'Camera_Start'.
[[File:StartMenuTut SpectatorCameraAdd.png|frame|left|Adding a Spectator Camera Trigger]]
[[File:Tut StartMenu SpectatorCameraName.png|none|x300px|Assign 'Start_Camera' to the name]]
 

* Once your Spectator Camera is placed in your level, you can move it around and rotate it with the translation controls like any other object.

* You can get a live preview of how the Start Menu will look by selecting the ''Spectator Camera->right mouse click->"Activate in FX Preview"''.
<gallery>
File:Tut StartMenu SpectatorCameraActivateFx.png|Activating Fx Preview to Evaluate Camera Placement
File:Tut StartMenu SpectatorCameraFxPreview.png | Live Preview of Spectator Camera Field of View
</gallery>

* Keep in mind that the game places a thin UI overlay towards the right hand of the screen, so you may want to account for it.

== Assigning the Menu Level to your Mod ==

Once you are happy with the placement and field of view of the Start Camera in your menu level, you simply assign it to the project through the "''Project->Project Settings...''" menu under the 'General' tab.

[[File:Tut StartMenu MenuLevelAssignment.png|frame|none|Assigning a Start Menu Level to the Project]]
 
When you start up the game, you will see your menu anytime you return to playing your mod!

[[File:Tut StartMenu FinalProduct.png|frame|none|Custom Start Menu Final Product]]

[[Category:Levels]]

Custom Menu Screens

2017-09-05T18:47:13Z

Windemere:

== Preparing the Level ==
Custom Menu Screens are created by adding a Spectator Camera Trigger to a level and then linking it to the project settings for your mod. There are some special rules to know about when designing your level to be used as a Menu Screen. When the menu screen is displayed from the game menu, there is no server running, which means that spawned creatures and interactive items will not display. For this reason, most artists prefer to create levels or terrains specifically tailored as menus screens rather than using the ones played in game. Doing this also allows for more creativity in moving objects around and adjusting the lighting for the specific field of view that the camera will have.

== Placing Your Menu Camera ==

* Select the SpectatorCameraTrigger from your Root Templates and add it somewhere in your level.
* Give it the name 'Camera_Start'.
[[File:StartMenuTut SpectatorCameraAdd.png|frame|left|Adding a Spectator Camera Trigger]]
[[File:Tut StartMenu SpectatorCameraName.png|none|x300px|Assign 'Start_Camera' to the name]]
 

* Once your Spectator Camera is placed in your level, you can move it around and rotate it with the translation controls like any other object.

* You can get a live preview of how the Start Menu will look by selecting the ''Spectator Camera->right mouse click->"Activate in FX Preview"''.
<gallery>
File:Tut StartMenu SpectatorCameraActivateFx.png|Activating Fx Preview to Evaluate Camera Placement
File:Tut StartMenu SpectatorCameraFxPreview.png | Live Preview of Spectator Camera Field of View
</gallery>

* Keep in mind that the game places a thin UI overlay towards the right hand of the screen, so you may want to account for it.

== Assigning the Menu Level to your Mod ==

Once you are happy with the placement and field of view of the Start Camera in your menu level, you simply assign it to the project through the "''Project->Project Settings...''" menu under the 'General' tab.

[[File:Tut StartMenu MenuLevelAssignment.png|frame|none|Assigning a Start Menu Level to the Project]]
 
When you start up the game, you will see your menu anytime you return to playing your mod!

[[File:Tut StartMenu FinalProduct.png|frame|none|Custom Start Menu Final Product]]

[[Category:Levels]]

Custom Menu Screens

2017-09-05T18:46:33Z

Windemere:

== Preparing the Level ==
Custom Menu Screens are created by adding a Spectator Camera Trigger to a level and then linking it to the project settings for your mod. There are some special rules to know about when designing your level to be used as a Menu Screen. When the menu screen is displayed from the game menu, there is no server running, which means that spawned creatures and interactive items will not display. For this reason, most artists prefer to create levels or terrains specifically tailored as menus screens rather than using the ones played in game. Doing this also allows for more creativity in moving objects around and adjusting the lighting for the specific field of view that the camera will have.

== Placing Your Menu Camera ==

* Select the SpectatorCameraTrigger from your Root Templates and add it somewhere in your level.
* Give it the name 'Start_Camera'.
[[File:StartMenuTut SpectatorCameraAdd.png|frame|left|Adding a Spectator Camera Trigger]]
[[File:Tut StartMenu SpectatorCameraName.png|none|x300px|Assign 'Start_Camera' to the name]]
 

* Once your Spectator Camera is placed in your level, you can move it around and rotate it with the translation controls like any other object.

* You can get a live preview of how the Start Menu will look by selecting the ''Spectator Camera->right mouse click->"Activate in FX Preview"''.
<gallery>
File:Tut StartMenu SpectatorCameraActivateFx.png|Activating Fx Preview to Evaluate Camera Placement
File:Tut StartMenu SpectatorCameraFxPreview.png | Live Preview of Spectator Camera Field of View
</gallery>

* Keep in mind that the game places a thin UI overlay towards the right hand of the screen, so you may want to account for it.

== Assigning the Menu Level to your Mod ==

Once you are happy with the placement and field of view of the Start Camera in your menu level, you simply assign it to the project through the "''Project->Project Settings...''" menu under the 'General' tab.

[[File:Tut StartMenu MenuLevelAssignment.png|frame|none|Assigning a Start Menu Level to the Project]]
 
When you start up the game, you will see your menu anytime you return to playing your mod!

[[File:Tut StartMenu FinalProduct.png|frame|none|Custom Start Menu Final Product]]

[[Category:Levels]]

Custom Menu Screens

2017-09-05T18:41:16Z

Windemere:

== Preparing the Level ==
Custom Menu Screens are created by adding a Spectator Camera Trigger to a level and then linking it to the project settings for your mod. There are some special rules to know about when designing your level to be used as a Menu Screen. When the menu screen is displayed from the game menu, there is no server running, which means that spawned creatures and interactive items will not display. For this reason, most artists prefer to create levels or terrains specifically tailored as menus screns rather than using the ones played in game. Doing this also allows for more creativity in moving objects around and adjusting the lighting for the specific field of view that the camera will have.

== Placing Your Menu Camera ==

* Select the SpectatorCameraTrigger from your Root Templates and add it somewhere in your level.
* Give it the name 'Start_Camera'.
[[File:StartMenuTut SpectatorCameraAdd.png|frame|left|Adding a Spectator Camera Trigger]]
[[File:Tut StartMenu SpectatorCameraName.png|none|x300px|Assign 'Start_Camera' to the name]]
 

* Once your Spectator Camera is placed in your level, you can move it around and rotate it with the translation controls like any other object.

* You can get a live preview of how the Start Menu will look by selecting the ''Spectator Camera->right mouse click->"Activate in FX Preview"''.
<gallery>
File:Tut StartMenu SpectatorCameraActivateFx.png|Activating Fx Preview to Evaluate Camera Placement
File:Tut StartMenu SpectatorCameraFxPreview.png | Live Preview of Spectator Camera Field of View
</gallery>

* Keep in mind that the game places a thin UI overlay towards the right hand of the screen, so you may want to account for it.

== Assigning the Menu Level to your Mod ==

Once you are happy with the placement and field of view of the Start Camera in your menu level, you simply assign it to the project through the "''Project->Project Settings...''" menu under the 'General' tab.

[[File:Tut StartMenu MenuLevelAssignment.png|frame|none|Assigning a Start Menu Level to the Project]]
 
When you start up the game, you will see your menu anytime you return to playing your mod!

[[File:Tut StartMenu FinalProduct.png|frame|none|Custom Start Menu Final Product]]

[[Category:Levels]]

File:Tut StartMenu FinalProduct.png

2017-09-05T18:36:45Z

Windemere:

Custom Menu Screens

2017-09-05T18:27:26Z

Windemere:

== Preparing the Level ==
Custom Menu Screens are created by designing a level with a Spectator Camera Trigger and then linking it to the project settings for your mod. There are some special rules to observe when designing your level, however. When the menu screen is displayed from the game menu, there is no server running, which means that spawned creatures and interactive items will not display. For this reason, most artists prefer to create levels specifically tailored for start menus rather than employing the ones used in game.

== Placing Your Menu Camera ==

* Select the SpectatorCameraTrigger from your Root Templates and add it somewhere in your level.
* Give it the name 'Start_Camera'.
[[File:StartMenuTut SpectatorCameraAdd.png|frame|left|Adding a Spectator Camera Trigger]]
[[File:Tut StartMenu SpectatorCameraName.png|none|x300px|Assign 'Start_Camera' to the name]]
 

* Once your Spectator Camera is placed in your level, you can move it around and rotate it with the translation controls like any other object.

* You can get a live preview of how the Start Menu will look by selecting the ''Spectator Camera->right mouse click->"Activate in FX Preview"''.
<gallery>
File:Tut StartMenu SpectatorCameraActivateFx.png|Activating Fx Preview to Evaluate Camera Placement
File:Tut StartMenu SpectatorCameraFxPreview.png | Live Preview of Spectator Camera Field of View
</gallery>

== Assigning the Menu Level to your Mod ==

Once you are happy with the placement and field of view of the Start Camera in your menu level, you simply assign it to the project through the "''Project->Project Settings...''" menu under the 'General' tab.

[[File:Tut StartMenu MenuLevelAssignment.png|frame|none|Assigning a Start Menu Level to the Project]]
 
When you start up the game, you will see your menu anytime you return to playing your mod!

[[Category:Levels]]

Custom Menu Screens

2017-09-05T18:22:16Z

Windemere:

== Preparing the Level ==
Custom Menu Screens are created by designing a level with a Spectator Camera Trigger and then linking it to the project settings for your mod. There are some special rules to observe when designing your level, however. When the menu screen is displayed from the game menu, there is no server running, which means that spawned creatures and interactive items will not display. For this reason, most artists prefer to create levels specifically tailored for start menus rather than employing the ones used in game.

== Placing Your Menu Camera ==

* Select the SpectatorCameraTrigger from your Root Templates and add it somewhere in your level.
* Give it the name 'Start_Camera'.
[[File:StartMenuTut SpectatorCameraAdd.png|frame|left|Adding a Spectator Camera Trigger]]
[[File:Tut StartMenu SpectatorCameraName.png|none|x300px|Assign 'Start_Camera' to the name]]
 

* Once your Spectator Camera is placed in your level, you can move it around and rotate it with the translation controls like any other object.

* You can get a live preview of how the Start Menu will look by selecting the Spectator Camera, right mouse click, and choose "Activate in FX Preview".
<gallery>
File:Tut StartMenu SpectatorCameraActivateFx.png|Activating Fx Preview to Evaluate Camera Placement
File:Tut StartMenu SpectatorCameraFxPreview.png | Live Preview of Spectator Camera Field of View
</gallery>

== Assigning the Menu Level to your Mod ==

Once you are happy with the placement and field of view of the Start Camera in your menu level, you simply assign it to the project through the "''Project->Project Settings...''" menu under the 'General' tab.

[[File:Tut StartMenu MenuLevelAssignment.png|frame|none|Assigning a Start Menu Level to the Project]]

[[Category:Levels]]

File:Tut StartMenu MenuLevelAssignment.png

2017-09-05T18:19:40Z

Windemere:

File:Tut StartMenu SpectatorCameraFxPreview.png

2017-09-05T17:52:30Z

Windemere: