Divinity Engine Wiki - User contributions [en]

File:Larian Maya Tools.zip

2018-11-30T14:04:54Z

Kevin:

Setup: Maya Exporter

2018-11-30T14:04:24Z

Kevin:

{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These scripts were written for Maya 2015 on Windows.
|-
|}

The files should be present in the editor data ''~DivinityEngineDataPath~\Data\Editor\Tools\Maya\'' 
 
All the files you need you'll find in ''~DivinityEngineDataPath~\Data\Editor\Tools\Maya\'' 
If they don't appear to be available there, you can also download the required files [[:File:Larian_Maya_Tools.zip|here]]

To have the granny plugin working in Maya 2015 copy ''larian_maya2015_x64.mll '' to your maya plugin folder ''~Maya2015InstallFolder~\Maya2015\bin\plug-ins'' 
To have the scripts working in Maya 2015 copy the ''userSetup.py'' and ''LarianStudiosModTools'' folder into ''~YourDocuments~''\maya\scripts 
 
When starting up Maya the userSetup.py should automaticly create a Larian_Mod_Tools shelf for you with the relevant scripts saved into buttons. 
 
Once you have launched Maya with this userSetup for the first time use the modify path script (ModP Button on the shelf) to set up your divinity engine data path for the exporter. This info will be saved in you maya scripts folder. 
 
 
{| class="wikitable"
|
===For advanced users===
If you already have a python userSetup file taking care of several preferences you can add this method and add a call to it during your start up sequence:
 
 
<nowiki>

def scriptRun():
mainPath = os.environ['MAYA_APP_DIR']+ "/scripts/LarianStudiosModTools/" #Best guess for maya path install
#Load toolbar creation script
setupScript = imp.load_source('secondary', mainPath+"LarianToolbarSetup.py")
setupScript.run() </nowiki>
 
Then you only need to copy the ''LarianStudiosModTools'' folder

|}

{| class="wikitable"
|-
|For more information on how to use the exporter tools, look here: [[Modding:_Maya_Exporter]]
|-
|}

Light probes

2018-09-13T16:13:33Z

Kevin: /* Best Practice */

= General =

Light probes are the Larian Engine's system for indirect lighting and reflections. A pre-calculated approximation to global illumination. 
In short, a light probe is an object you place in the level. It looks at the surrounding lighting and objects and uses that information to calculate realistic indirect lighting. 
This includes light bouncing off of objects, causing colors to carry over to nearby objects (this effect is called ''color bleeding''). 
It also provides accurate reflections of surrounding objects.

 
= Probe Types =

There are 2 types of light probes, used for different parts of the overall lighting: distant and local light probes.

 
=== Distant ===

Distant probes are used to account for far away lighting information: the sun and sky. 
It uses the information of the surrounding atmosphere to apply an approximation of sun and sky light bouncing and color bleeding to everything in that atmosphere. 
Since the probe contains atmosphere information, it applies to everything in that atmosphere. So in editor terms, you only need one distant probe per atmosphere trigger.

{| class="wikitable"
|-
|For more information on atmospheres, look here: [[Atmosphere panel]]
|-
|}

{| class="wikitable"
|-
|More information on atmosphere triggers can be found here: [[Triggers]]
|-
|}

 
=== Local ===

Local probes are used to simulate color bleeding and reflections related to nearby lights and objects. 
Local probes only gather information within a defined area around them and thus, only apply to objects in that same area. 
Contrary to distant probes, you can place as many local probes as you want. Even probes inside other probe areas are allowed. 
The lighting of the smallest probes always gets priority over the lighting of a larger probe that covers the same area.
With local probes, you fine-tune illumination and reflections where the distant probe, or a larger local probe proves to be insufficient.

 
= Shapes =

Probe influence areas are approximated by 2 shape types: spheres and boxes. 
This only applies to local probes. Distant probes capture all information visible, without being limited within a specific area.

 

= Lighting Types =

Probes can capture two types of lighting. 
Diffuse light is of a very low resolution and captures the general color of the surroundings. 
The performance cost of this light type is very low and produces what we know as 'bounce light'. 
Specular lighting is of a high resolution and is used to produce reflections on smooth surfaces and metals. 
This lighting is far more expensive. It is also most notable on smooth surfaces and metals. 
These materials accurately reflect their surrounding, thus an accurate reflection is necessary. In other situations, a more general capture might suffice.

Given how dynamic a world can be (characters with metal armors running around), generally you'll want to have both diffuse and specular capture enabled on a probe. 
But because mirror-like surfaces are very rare (metal armor is not a mirror), for performance it is beneficial to use less specular probes. 
Don't worry too much though. Performance impact will only be noticeable when having multiple tens of probes visible on screen at the same time. 

=== Rule of thumb ===
Capture both. 
If you start having a multitude of probes in one screen, look to reducing performance impact by generalizing the specular probe. 

=== Sidenote ===
Don't tweak too much. There might be intensity scaling on probes, but working with several probes and/or splitting diffuse and specular probes can have unwanted side effects. 
Start with an intensity of 1, and slowly adjust situations. Again from big to small.

 
= Atmospheres =

Atmospheres (sun direction, sky color) naturally influence the lighting and probes account for this. 
Atmospheres are defined by atmosphere triggers. 

As mentioned earlier, always place one distant probe per atmosphere trigger. 
Local probes will gather lighting information from the atmosphere trigger they are in. 

To account for atmosphere changes (day to night), which can be achieved through scripting, atmosphere triggers can be assigned multiple atmospheres (through atmosphere resources). 
Probes will gather information from every atmosphere assigned to the atmosphere trigger they are in.

{| class="wikitable"
|-
|Information on atmosphere resources can be found here: [[Resources]]
|-
|}

{| class="wikitable"
|-
|For more information on atmosphere triggers, look here: [[Triggers]]
|-
|}

 
= Best Practice =

Light probes make a scene's lighting feel more natural. 
To optimally make use of light probes, try to follow these guidelines:

* Always '''1 distant probe''' per atmosphere. Always place one distant probe to capture far off lighting and apply it to everything in that atmosphere. This is your base layer of natural lighting.
* Place '''distant probes low to the ground'''. This way, they are more heavily influences by the ground color, making color bleeding more apparent.
* '''Follow geometry''' when placing local probes. Try to align the probe's influence area as closely as possible to its surrounding. F.e. shape a probe like the room the probe is in.
* '''Start big'''. Too many probes can be bad for performance. Start with the distant probe and large/rough local probes. Only place a smaller probe where necessary.

Definitive Edition

2018-09-12T16:09:16Z

Kevin: /* Imported Resource Path Fixer */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

=== Imported Resources ===

After import, resources can suffer from outdated Source File path properties. To that end the Path Fixer has been added to the [[Content browser]]: 

[[File:PathFixerLocation.PNG|Path Fixer Location|1200px|center]]
 

When opening the path fixer, you'll get an overview of all resources with outdated file paths and the suggested correction. For each file the correction can be toggled on/off. When happy with the proposed correction, press Ok on the bottom of the window and all files will be updated and resaved. Be aware that this may take some time, depending on the amount of resources. 

[[File:PathFixer.PNG|Path Fixer Location|1200px|center]]
 

=== Imported Texture Atlases ===

Texture atlases will also suffer from outdated paths. Simply resave your custom texture atlases in the Texture Atlas editor to make them work again in your DE project.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-12T16:05:23Z

Kevin: /* Imported Resource Path Fixer */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

=== Imported Resource Path Fixer ===

During the initial release, imported projects did not update the Source File properties of their resources correctly. This could potentially cause crashes and made various resource types, texture atlases and stats unusable.
By now, iporting has been improved. And texture atlases can be fixed by resaving them. 

After import, resources can suffer from outdated path properties. To that end the Path Fixer has been added to the [[Content browser]]: 

[[File:PathFixerLocation.PNG|Path Fixer Location|1200px|center]]
 

When opening the path fixer, you'll get an overview of all resources with outdated file paths and the suggested correction. For each file the correction can be toggled on/off. When happy with the proposed correction, press Ok on the bottom of the window and all files will be updated and resaved. Be aware that this may take some time, depending on the amount of resources. 

[[File:PathFixer.PNG|Path Fixer Location|1200px|center]]
 

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-12T15:06:08Z

Kevin: /* Imported Resource Path Fixer */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

=== Imported Resource Path Fixer ===

During the initial release, imported projects did not update the Source File properties of their resources correctly. This could potentially cause crashes and made various resource types, texture atlases and stats unusable.
By now, importing classic projects has been improved, solving these issues automatically. And texture atlases can be fixed by resaving them. 

Previously imported projects, as well as manually copied resources can still suffer from outdated path properties. To that end the Path Fixer has been added to the [[Content browser]]: 

[[File:PathFixerLocation.PNG|Path Fixer Location|1200px|center]]
 

When opening the path fixer, you'll get an overview of all resources with outdated file paths and the suggested correction. For each file the correction can be toggled on/off. When happy with the proposed correction, press Ok on the bottom of the window and all files will be updated and resaved. Be aware that this may take some time, depending on the amount of resources. 

[[File:PathFixer.PNG|Path Fixer Location|1200px|center]]
 

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-12T15:05:53Z

Kevin: /* Imported Resource Path Fixer */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

=== Imported Resource Path Fixer ===

During the initial release, imported projects did not update the Source File properties of their resources correctly. This could potentially cause crashes and made various resource types, texture atlases and stats unusable.
By now, importing classic projects has been improved, solving these issues automatically. And texture atlases can be fixed by resaving them. 

Previously imported projects, as well as manually copied resources can still suffer from outdated path properties. To that end the Path Fixer has been added to the [[Content browser]]: 

[[File:PathFixerLocation.PNG|Path Fixer Location|center]]
 

When opening the path fixer, you'll get an overview of all resources with outdated file paths and the suggested correction. For each file the correction can be toggled on/off. When happy with the proposed correction, press Ok on the bottom of the window and all files will be updated and resaved. Be aware that this may take some time, depending on the amount of resources. 

[[File:PathFixer.PNG|Path Fixer Location|center]]
 

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-12T15:05:37Z

Kevin: /* Welcome, brave Sourcerer! */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

=== Imported Resource Path Fixer ===

During the initial release, imported projects did not update the Source File properties of their resources correctly. This could potentially cause crashes and made various resource types, texture atlases and stats unusable.
By now, importing classic projects has been improved, solving these issues automatically. And texture atlases can be fixed by resaving them. 

Previously imported projects, as well as manually copied resources can still suffer from outdated path properties. To that end the Path Fixer has been added to the [[Content browser]]: 

[[File:PathFixerLocation.PNG|Path Fixer Location|800px|center]]
 

When opening the path fixer, you'll get an overview of all resources with outdated file paths and the suggested correction. For each file the correction can be toggled on/off. When happy with the proposed correction, press Ok on the bottom of the window and all files will be updated and resaved. Be aware that this may take some time, depending on the amount of resources. 

[[File:PathFixer.PNG|Path Fixer Location|800px|center]]
 

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

File:PathFixer.PNG

2018-09-12T15:05:23Z

Kevin:

File:PathFixerLocation.PNG

2018-09-12T15:05:11Z

Kevin:

Definitive Edition

2018-09-12T15:04:57Z

Kevin: /* Imported Custom Content */

__TOC__
= Welcome, brave Sourcerer! =

{{warning|We are currently working hard to fix the following issues on importing classic projects. We advise to wait for a fix if you experience any of them:}} [http://larian.com/forums/ubbthreads.php?ubb=showflat&Number=649147&#Post649147 Explaining about issues can be found on the forum] 
 

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

=== Imported Resource Path Fixer ===

During the initial release, imported projects did not update the Source File properties of their resources correctly. This could potentially cause crashes and made various resource types, texture atlases and stats unusable.
By now, importing classic projects has been improved, solving these issues automatically. And texture atlases can be fixed by resaving them. 

Previously imported projects, as well as manually copied resources can still suffer from outdated path properties. To that end the Path Fixer has been added to the [[Content browser]]: 

[[File:PathFixerLocation.PNG|Path Fixer Location|800px|center]]
 

When opening the path fixer, you'll get an overview of all resources with outdated file paths and the suggested correction. For each file the correction can be toggled on/off. When happy with the proposed correction, press Ok on the bottom of the window and all files will be updated and resaved. Be aware that this may take some time, depending on the amount of resources. 

[[File:PathFixer.PNG|Path Fixer Location|800px|center]]
 

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-07T21:57:22Z

Kevin: /* Welcome, brave Sourcerer! */

__TOC__
= Welcome, brave Sourcerer! =

{{warning|We are currently working hard to fix the following issues on importing classic projects. We advise to wait for a fix if you experience any of them:}} [http://larian.com/forums/ubbthreads.php?ubb=showflat&Number=649147&#Post649147 Explaining about issues can be found on the forum] 
 

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-07T21:56:39Z

Kevin: /* Welcome, brave Sourcerer! */

__TOC__
= Welcome, brave Sourcerer! =

{{warning|We are currently working hard to fix the following issues on importing classic projects. We advise to wait for a fix if you experience any of them:}} [http://larian.com/forums/ubbthreads.php?ubb=showflat&Number=649147&#Post649147 forum link] 
 

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-07T21:56:17Z

Kevin:

__TOC__
= Welcome, brave Sourcerer! =

{{warning|We are currently working hard to fix the following issues on importing classic projects. We advise to wait for a fix if you experience any of them:}} [http://larian.com/forums/ubbthreads.php?ubb=showflat&Number=649147&#Post649147 forum link]

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-07T21:55:49Z

Kevin:

__TOC__
= Welcome, brave Sourcerer! =

{{warning|We are currently working hard to fix the following issues on importing classic projects. We advise to wait for a fix if you experience any of them http://larian.com/forums/ubbthreads.php?ubb=showflat&Number=649147&#Post649147}}

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-07T21:52:05Z

Kevin:

__TOC__
{{warning | We are currently working hard to fix the following issues on importing classic projects. We advice to wait for a fix if you experience any of them: http://larian.com/forums/ubbthreads.php?ubb=showflat&Number=649147&#Post649147}}
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-07T19:03:54Z

Kevin: /* Imported Materials */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. If they are pink, you need to convert them. But that can be done easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-04T12:51:01Z

Kevin: /* Imported Stats */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. But they can be converted easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | As before, the Engine does not support manually editing the stats .txt files. Only stats made in the Engine's Stats Editor can be converted. }}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-04T12:12:24Z

Kevin: /* Imported Stats */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. But they can be converted easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-09-04T12:09:08Z

Kevin: /* Imported Stats */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. But they can be converted easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do. 

{{warning | Stats are imported from the Stats Editor files and are assume to be up to date. Make sure you saved your stats with the latest Classic Engine version before importing! As before, the Engine does not support manual changes to the .txt stats files!}}

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Sound Volume Triggers
*The Effect Editor
*The Story Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_GLO_FirstLevelAfterCharacterCreation("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

My first: Adventure

2018-09-03T14:24:09Z

Kevin: /* Necessary scripting */

For creating and publishing an adventure in The Divinity Engine 2, please read [[Working with projects]]. 
Below, we detail any extra requirements to get an adventure working in-game and how to check if it works as intended.

== Necessary scripting ==

{{warning| This is no longer required for the Definitive Edition as Character Creation is unified for all mods. We refer to [[https://docs.larian.game/Definitive_Edition|The Definitive Edition Guide]] for more information on Unified Character Creation}}

When you want your adventure to start off with the character creation screen, you need to initiate this with story scripting. 
We recommend taking a look at the following scripts in Origins and Game_Master mods, to get a feel for how it works:
* ''GLOBAL_CharacterCreation'' and ''FortJoy_CharacterCreation'' in Origins
* ''GLO_GameMasterCharacterCreation'' in Game_Master

You'll quickly notice that these can become quite complex. But don't fret because we've got you covered!

 
=== When loading no data ===
This basic version includes everything you need to get your story adventure up and running: [[:File:CharacterCreationTemplate.zip|Character Creation Template]] 
You'll notice that after character creation, you'll get teleported to the [[Sandbox]]. This can be changed by editing the following lines:
 

[[File: CCTeleport.png | none]]
 Lines that define the teleport location after Character Creation. In the [[Story editor|Story Editor]], these lines are in the INIT section 

 

=== When loading data from one of the existing modes (Story/Arena/GM) ===
Existing modes require specific cases to be handled. Story for example has multiple origin characters.
Hence, instead of using the clean template, we suggest using (and if necessary adapting) the existing Character Creation scripts that are already part of the mode's data:
* Story: ''FortJoy_CharacterCreation''
* Arena: ''__StartArena''
* Game Master: ''GLO_GameMasterCharacterCreation''
 

== My adventure in-game ==

External mods (f.e. from Steam Workshop) are always placed under ''"Documents/Larian Studios/Divinity Original Sin 2/Mods". 
But your own mods are magically loaded as well! So close the Divinity Engine 2, launch the game and check it out! 

[[File:Menu.png|800px]] [[File:MenuAdventures.png|800px]] 

To play your adventure, select it in the appropriate story or game master drop down menu. (The story drop down is only available when at least one custom adventure was loaded) 
ATTENTION: If your adventure has no valid story, it will not be visible in these drop down menus. So always make sure you build the story in the toolset before testing.
{| class="wikitable"
|-
|More information on the story editor can be found here: [[Story editor]]
|-
|}
 

Story: 
[[File:MenuStory.png|800px]] [[File:StoryAdventure.png|800px]] 

Game Master Mode: 
[[File:MenuGM.png|800px]] [[File:MenuGMPrepare.png|800px]] 

[[File:MenuGMSettings.png|800px]] [[File:MenuGMAdventure.png|800px]] 

That's it! Now it's time to go on an adventure!

My first: Adventure

2018-09-03T14:23:49Z

Kevin: /* Necessary scripting */

For creating and publishing an adventure in The Divinity Engine 2, please read [[Working with projects]]. 
Below, we detail any extra requirements to get an adventure working in-game and how to check if it works as intended.

== Necessary scripting ==

{{warning| This is no longer required for the Definitive Edition as Character Creation is unified for all mods. We refer to [[https://docs.larian.game/Definitive_Edition|The Definitive Edition Guide]] for more information on Unified Character Creation]]

When you want your adventure to start off with the character creation screen, you need to initiate this with story scripting. 
We recommend taking a look at the following scripts in Origins and Game_Master mods, to get a feel for how it works:
* ''GLOBAL_CharacterCreation'' and ''FortJoy_CharacterCreation'' in Origins
* ''GLO_GameMasterCharacterCreation'' in Game_Master

You'll quickly notice that these can become quite complex. But don't fret because we've got you covered!

 
=== When loading no data ===
This basic version includes everything you need to get your story adventure up and running: [[:File:CharacterCreationTemplate.zip|Character Creation Template]] 
You'll notice that after character creation, you'll get teleported to the [[Sandbox]]. This can be changed by editing the following lines:
 

[[File: CCTeleport.png | none]]
 Lines that define the teleport location after Character Creation. In the [[Story editor|Story Editor]], these lines are in the INIT section 

 

=== When loading data from one of the existing modes (Story/Arena/GM) ===
Existing modes require specific cases to be handled. Story for example has multiple origin characters.
Hence, instead of using the clean template, we suggest using (and if necessary adapting) the existing Character Creation scripts that are already part of the mode's data:
* Story: ''FortJoy_CharacterCreation''
* Arena: ''__StartArena''
* Game Master: ''GLO_GameMasterCharacterCreation''
 

== My adventure in-game ==

External mods (f.e. from Steam Workshop) are always placed under ''"Documents/Larian Studios/Divinity Original Sin 2/Mods". 
But your own mods are magically loaded as well! So close the Divinity Engine 2, launch the game and check it out! 

[[File:Menu.png|800px]] [[File:MenuAdventures.png|800px]] 

To play your adventure, select it in the appropriate story or game master drop down menu. (The story drop down is only available when at least one custom adventure was loaded) 
ATTENTION: If your adventure has no valid story, it will not be visible in these drop down menus. So always make sure you build the story in the toolset before testing.
{| class="wikitable"
|-
|More information on the story editor can be found here: [[Story editor]]
|-
|}
 

Story: 
[[File:MenuStory.png|800px]] [[File:StoryAdventure.png|800px]] 

Game Master Mode: 
[[File:MenuGM.png|800px]] [[File:MenuGMPrepare.png|800px]] 

[[File:MenuGMSettings.png|800px]] [[File:MenuGMAdventure.png|800px]] 

That's it! Now it's time to go on an adventure!

My first: Adventure

2018-09-03T14:23:33Z

Kevin: /* Necessary scripting */

For creating and publishing an adventure in The Divinity Engine 2, please read [[Working with projects]]. 
Below, we detail any extra requirements to get an adventure working in-game and how to check if it works as intended.

== Necessary scripting ==

{{warning|This is no longer required for the Definitive Edition as Character Creation is unified for all mods. We refer to [[https://docs.larian.game/Definitive_Edition|The Definitive Edition Guide]] for more information on Unified Character Creation]]

When you want your adventure to start off with the character creation screen, you need to initiate this with story scripting. 
We recommend taking a look at the following scripts in Origins and Game_Master mods, to get a feel for how it works:
* ''GLOBAL_CharacterCreation'' and ''FortJoy_CharacterCreation'' in Origins
* ''GLO_GameMasterCharacterCreation'' in Game_Master

You'll quickly notice that these can become quite complex. But don't fret because we've got you covered!

 
=== When loading no data ===
This basic version includes everything you need to get your story adventure up and running: [[:File:CharacterCreationTemplate.zip|Character Creation Template]] 
You'll notice that after character creation, you'll get teleported to the [[Sandbox]]. This can be changed by editing the following lines:
 

[[File: CCTeleport.png | none]]
 Lines that define the teleport location after Character Creation. In the [[Story editor|Story Editor]], these lines are in the INIT section 

 

=== When loading data from one of the existing modes (Story/Arena/GM) ===
Existing modes require specific cases to be handled. Story for example has multiple origin characters.
Hence, instead of using the clean template, we suggest using (and if necessary adapting) the existing Character Creation scripts that are already part of the mode's data:
* Story: ''FortJoy_CharacterCreation''
* Arena: ''__StartArena''
* Game Master: ''GLO_GameMasterCharacterCreation''
 

== My adventure in-game ==

External mods (f.e. from Steam Workshop) are always placed under ''"Documents/Larian Studios/Divinity Original Sin 2/Mods". 
But your own mods are magically loaded as well! So close the Divinity Engine 2, launch the game and check it out! 

[[File:Menu.png|800px]] [[File:MenuAdventures.png|800px]] 

To play your adventure, select it in the appropriate story or game master drop down menu. (The story drop down is only available when at least one custom adventure was loaded) 
ATTENTION: If your adventure has no valid story, it will not be visible in these drop down menus. So always make sure you build the story in the toolset before testing.
{| class="wikitable"
|-
|More information on the story editor can be found here: [[Story editor]]
|-
|}
 

Story: 
[[File:MenuStory.png|800px]] [[File:StoryAdventure.png|800px]] 

Game Master Mode: 
[[File:MenuGM.png|800px]] [[File:MenuGMPrepare.png|800px]] 

[[File:MenuGMSettings.png|800px]] [[File:MenuGMAdventure.png|800px]] 

That's it! Now it's time to go on an adventure!

Definitive Edition

2018-08-29T15:52:31Z

Kevin: /* GM Story Scripting */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. But they can be converted easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

{{warning|GM Story scripting and GM add-on support in general (when playing the campaign) will be brought live on the first patch after release. }}

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined in story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_CharacterCreationTransitionInfo("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Divinity Engine Wiki:Privacy policy

2018-08-29T08:34:34Z

Kevin: Protected "Divinity Engine Wiki:Privacy policy" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

This wiki site uses Larian Studios' Privacy Policy. See https://larian.com/privacy for more information.

Divinity Engine Wiki:Copyrights

2018-08-29T08:34:20Z

Kevin: Protected "Divinity Engine Wiki:Copyrights" ([Edit=⧼protect-level-larianeditonly⧽] (indefinite) [Move=⧼protect-level-larianeditonly⧽] (indefinite))

Content posted to this wiki by anyone on or after 28 August 2018, and also textual content posted to this wiki before that date by Larian Studios Games Ltd employees, is licensed under the Creative Commons CC BY-NC-SA 4.0 license, except where stated otherwise. Community content posted before that date falls under the contribution guidelines outlined on the [[Community_page_submission|Community Submissions Page]].

Larian Studios, Divinity, all other Larian Studios Games Ltd. product names, and their respective logos are trademarks of Larian Studios Ltd. in the USA and other countries. All company names, brand names, trademarks and logos are the property of their respective owner.

Definitive Edition

2018-08-28T20:52:53Z

Kevin: /* Welcome, brave Sourcerer! */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[:File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. But they can be converted easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_CharacterCreationTransitionInfo("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T20:51:28Z

Kevin: /* Welcome, brave Sourcerer! */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the [[File:ConversionEssentials.zip|guide]], look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. But they can be converted easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =
The basic Character Creation scripting has been unified into one spot.
This way, your mod will always have character creation logic without you having to add that by hand!
Furthermore, it is easily moddable by overriding the new files.

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented.
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''.
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''.

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order,
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called.
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure.
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor.
You can perform extra tweaks to that character at this time.
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
<pre>
DB_Origin((CHARACTERGUID)Your_OriginCharacter1);
DB_Origin((CHARACTERGUID)Your_OriginCharacter2);
...
</pre>
The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone.
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database.
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

Before Character Creation finishes (can be in the init section of the same goal as above):
<pre>
DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");
</pre>
* You can define multiple of these databases. Which one gets used is defined by the next database.
* The StartMovie can be empty if no movie should be shown between character creation and the start of the first level.
* StartTrigger has to be a global trigger.
* StartLevel is just an identifier; it does not have to be an actual level name.

Before Character Creation finishes (can be in the init section of the same goal as above)
<pre>
DB_CharacterCreationTransitionInfo("StartLevel");
</pre>
This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

In addition, there are a number of optional databases that you can define.
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information.
In general, you won’t have to touch these.

==Standard CC for an adventure that loads data==
This is for mods that load data from Story, GM, and/or Arena.
All of these mods contain a functional Character Creation already.
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point.
GM and Arena contain custom character creation code due to their specific nature.

==Custom CC==
If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod.
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

<pre>
IF
RegionStarted(_Level)
AND
IsGameLevel(_Level, 1)
AND
DB_CharacterCreationDummy(_Npc)
THEN
CharacterMakeNPC(_Npc);
</pre>
Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones.
All for the better, of course!

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]

== Orphan Databases/Queries ==
Sometimes, the Osiris compiler did not catch typos in database names. For example:

<pre>
IF
CharacterDied(_Player)
AND
DB_FreeResurrect(_Player)
AND
DB_Player(_Player)
THEN
// Free resurrect for players!
CharacterResurrect(_Player);
Not twice in a row
NOT DB_FreeResurrected(_Player);
</pre>

The '''DB_Player''' in the above fragment should read '''DB_IsPlayer''', and the '''DB_FreeResurrected''' should be '''DB_FreeResurrect'''.
Osiris did not notice anything wrong with this fragment because it can infer the type of the '''''_Player''''' variable from the '''CharacterDied''' event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on.
After all, such checks will always fail and such defines will never be used.

However, this can result in false positives.
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers.
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name ''story_orphanqueries_ignore_local.txt''.
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all ''story_orphanqueries_ignore_local.txt'' files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
*''story_orphanqueries_ignore.txt'': this file is recreated by the story editor every time you compile story (so no need to restart after changing the ''story_orphanqueries_ignore_local.txt'' file). It simply contains the contents of all relevant ''story_orphanqueries_ignore_local.txt'' files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*''story_orphanqueries_found.txt'': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by ''story_orphanqueries_ignore_local.txt'', so you can just copy/paste its contents in case these are new false positives that should be suppressed.

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T19:26:36Z

Kevin: /* Importing 3.0 Mods */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

== Imported Custom Content ==
=== Imported Materials ===
Some materials parameters have changed slightly to improve performance. 
Your material files might not be loadable from the start. But they can be converted easily! 
Open your material in the Resource Browser and simply save. 
Be wary that (since your material was broken before) your material will only be loaded again after a mod reload or editor restart!

=== Imported Stats ===

As stats were tweaked, some definitions changed. Makes some pages (e.g. Potions), incompatible. 
But again, conversion is easy! It will happen auto-magically when importing/opening your DE project. 
Beware though that some columns might have changed and we tweaked several base values, so be sure to go over your stats changes, to ensure they still do exactly what you intend them to do.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T19:18:31Z

Kevin: /* Finding Definitive Edition Mods */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other pages to download mods from, please check the description on the page or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T19:17:44Z

Kevin: /* Finding Definitive Edition Mods */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
New mods will get their own download page, so classic mods will still be available for download/maintenance via their respective pages, as they are now. 
For all other sources of mods, please check the description or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T19:16:50Z

Kevin: /* Finding Definitive Edition Mods */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the '''Definitive Edition''' tag. (A new filter that is automatically applied when publishing in the Definitive Engine). 
For all other sources of mods, please check the description or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T19:16:37Z

Kevin:

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Finding Definitive Edition Mods =

On the Steam workshop, updated mods can be found under the Definitive Edition tag. (A new filter that is automatically applied when publishing in the Definitive Engine).
For all other sources of mods, please check the description or ask the content creator to find information on the version the mod is made for.

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:58:35Z

Kevin: /* No CC */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==
If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:58:26Z

Kevin: /* No CC */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:

 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:58:08Z

Kevin: /* Orphan Databases/Queries */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:57:52Z

Kevin: /* Orphan Databases/Queries */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 

The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.
 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:56:30Z

Kevin: /* Orphan Databases/Queries */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:56:01Z

Kevin: /* Orphan Databases/Queries */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:55:39Z

Kevin: /* Orphan Databases/Queries */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:55:31Z

Kevin: /* Orphan Databases/Queries */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''DB_Player(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;// Free resurrect for players! 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;// Not twice in a row 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:54:47Z

Kevin: /* Orphan Databases/Queries */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterDied(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_FreeResurrect(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_Player(_Player)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''// Free resurrect for players!''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterResurrect(_Player);''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''// Not twice in a row''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''NOT DB_FreeResurrected(_Player);''' 
 


The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. 
Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

 

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. 
After all, such checks will always fail and such defines will never be used.

 

However, this can result in false positives. 
A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. 
To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. 
Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

 

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

 
In addition to the previous file, there are two more files you may now see in the Story directory of a Mod: 
*'''story_orphanqueries_ignore.txt''': this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
*'''story_orphanqueries_found.txt''': this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.
 

'''One final note''': the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Definitive Edition

2018-08-28T18:52:25Z

Kevin: /* Scripting */

__TOC__
= Welcome, brave Sourcerer! =

So you have some old modifications you’d like to bring up to date for this new day and age? Well, look no further!

Many things changed in Divinity: Original Sin 2 Definitive Edition, but we've got you covered! 
Below, you can find a guide containing all essential information needed to make your content Definitive Edition - ready. 
For more information on topics mentioned in the guide, look at the information on this page.

<gallery mode=packed heights=600px>
File:ConversionFront.jpeg|link=File:ConversionEssentials.zip|Essential Conversion Guide
</gallery>

= Installing the Divinity Engine 2 Definitive Edition =

The game and the tool are available under the same game page on whichever store you use. So, simply use the existing [[Setting_up_the_editor|setup guide]]. 
{{warning|'''One exception''': You’ll be opening the Divinity Engine 2 Definitive Edition instead of the regular one, and where the guide talks about linking the Engine to the Original Sin 2 Data, be sure to link to the Definitive Edition data. }}

= Importing 3.0 Mods =

We added a handy, little “Import Project” button to the [[Project_browser|Project Browser]].

[[File:ImportProject.PNG|Import Project Window|800px|center]]


When pressing “Import Project”, you’ll be prompted with a File Explorer window. 
Navigate to the Data folder of Divinity Original Sin 2 (classic edition) and select the following: 

&emsp; '''''Divinity Original Sin 2\Data\Mods\{YourMod}'''''

The editor will then copy all project data over to the Definitive Edition data folder and give your project a new ID. 
Later on, when publishing, this will ensure that your project will have a separate page on the workshop and will be recognized as a different mod in-game.

== No Backwards Compatibility. Conversion Is Required. ==

We would like to remind you at this point that Classic Mods are not compatible with the Definitive Edition and vice versa. 
If you happen to have an incompatible mod in your game’s mod folder, the Mod Menu in-game will show you that that mod is incompatible and block loading/enabling that mod.

= Sound Modding =

Sound Resource updated to recognize external .wav files. 
This .wav support is provided everywhere where sound resources are used, with the exception of Music Volume Triggers. 
More specifically, this means you can use custom music files (.wav extension) in the following cases:
*Point Sound Triggers
*Point Volume Triggers
*The Effect Editor
*The Script Editor '''(*)'''
 

'''(*)''' Two new calls have been added to allow playing a sound through story scripting:
* [[Osiris/API/CharacterPlayHUDSoundResource|CharacterPlayHUDSoundResource]]
* [[Osiris/API/PlaySoundResource|PlaySoundResource]]

= GM Story Scripting =

Story (Osiris) scripting in Game Master mode is now fully supported!
 

This means that all your add-on scripting will work in Game Master, the same way it does in Story mode. 
As always, simply make sure in your [[Project_settings_window|Project Settings]] (''CTRL + P'') that your project has the correct game mode enabled as Target. 
Your project only works for the modes it targets! In this case, the target would be ''GM''.

= Save/Load Support =

Saving/Loading of save games is supported in the Divinity Engine 2 Definitive Edition. 
All your save games are loaded into the editor and available through the [[Level_browser|Level Browser]] 

{{warning| Always make sure you make save all changes before making save games. Otherwise, If you alter the save game but not the project data, you could cause the game to crash due to missing data.}}

= Unified Character Creation =

The basic Character Creation scripting has been unified into one spot. 
This way, your mod will always have character creation logic without you having to add that by hand! 
Furthermore, it is easily moddable by overriding the new files. 

 

The basic Character Creation (CC) functionality has been moved to the Shared mod and has been documented. 
You can find the code in the story goals '''''Z_Shared_CharacterCreation''''' and '''''Z_SharedCharacterCreation_AfterEvents'''''. 
Character creation code that is specific to the DOS2 main campaign (DivinityOrigins mod) can be found in '''''Shared_DOS_CharacterCreation'''''. 

 

The names of these goals (and their parent goal) start with '''''Z_''''' because story goals are initialised in alphabetical order, 
and this way any database (specifically, the databases described below) defined story goals with names that do not start with “Z” initialise before the generic CC scripting tries to use them.

 

You can detect that Character Creation pipeline from the Shared mod has completely finished by the fact that at this point the procedure '''''PROC_Shared_CharacterCreationFinished()''''' gets called. 
This happens both when testing a mod in the editor (and hence no character creation ever happened, in which case a random character from the '''''DB_Origins()''''' database gets selected the first time you enter game mode in a session), and in a regular game.

 

The '''''Shared_DOS_CharacterCreation''''' goal also overloads the '''''ProcSetupGenericOrigin((CHARACTERGUID)_Char)''''' procedure. 
This procedure gets called with as parameter the random character that was selected when starting game mode in the editor. 
You can perform extra tweaks to that character at this time. 
The code in '''''Shared_DOS_CharacterCreation''''' randomly turns that character into an undead to encourage people to test their situations also with undead characters.

 

== Standard CC for adventure that does not load data ==
In a goal that is initialised before or when the '''''GameModeStarted(“Campaign”, _)''''' event fires:
 

&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter1);''''' 
&emsp;'''''DB_Origin((CHARACTERGUID)Your_OriginCharacter2);''''' 
&emsp;'''''...'''''
 


The generic character creation code will turn all of these characters into player characters when character creation starts, and make them NPCs again once it is finished if they were not selected by anyone. 
Note that these characters also need to be prepared as described in [[My_first:_Character_creation_origin|The Custom Origin Character Tutorial]] either in your own mod, or in a mod on which you depend.

 


You can also add characters from the DB_GenericOrigins() database to the DB_Origins() database. 
If you do this, then when starting a level from this mod in the editor you may also be assigned a generic character rather than an origin character.

 

Before Character Creation finishes (can be in the init section of the same goal as above):

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel",(TRIGGERGUID)StartTrigger,"StartMovie");'''''
 


You can define multiple of these databases. 
Which one gets used is defined by the next database. 
The StartMovie can be empty if no movie should be shown between character creation and the start of the first level. 
StartTrigger has to be a global trigger. 
StartLevel is just an identifier; it does not have to be an actual level name.

 

Before Character Creation finishes (can be in the init section of the same goal as above)

 

&emsp;'''''DB_CharacterCreationTransitionInfo("StartLevel");'''''
 


This database determines which of the DB_CharacterCreationTransitionInfo entries gets used, i.e., to which start trigger and with which movie the players are teleported after Character Creation finishes.

 

In addition, there are a number of optional databases that you can define. 
See the comments in the INIT section of the '''''Z_Shared_CharacterCreation''''' goal for more information. 
In general, you won’t have to touch these.

 

==Standard CC for an adventure that loads data==

This is for mods that load data from Story, GM, and/or Arena. 
All of these mods contain a functional Character Creation already. 
Story (DivinityOrigins mod) uses the Character Creation scripts from Shared as described in the previous point. 
GM and Arena contain custom character creation code due to their specific nature.

 

==Custom CC==

If you wish to create a custom character creation script, you can do so by overriding the '''''Z_Shared_CharacterCreation''''' and/or '''''Z_Shared_CharacterCreation_AfterEvent''''' goals in your own mod. 
Make sure to carefully read the original code and to provide support for all edge cases such as the lobby level (even it works fine by default, it may not when you start switching mods within a single session) and testing in the editor.

 

==No CC==

If you do not wish to have a Character Creation at all and instead statically define the player characters, then
*Override the Z_Shared_CharacterCreation goal, and
*Copy everything from the INIT section of the original goal to the new one
*Copy the PROC_Shared_CharacterCreation_Init() from the original goal to the new one
*Copy the “Lobby level support” region from the original goal to the new one
*In your mod, go to the Project -> Project Settings, and set the Startup Level to the level in which you wish the game to start. Clear the Character Creation Level.
*Override the Z_Shared_CharacterCreation_AfterEvents goal and add the following code to it:
 

<code>
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''IF''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''RegionStarted(_Level)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''IsGameLevel(_Level, 1)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''AND''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''DB_CharacterCreationDummy(_Npc)''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp; '''THEN''' 
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;'''CharacterMakeNPC(_Npc);''' 
</code>
 

*Change the properties of all characters that you wish players to be able to control as follows:
*Check their “Global” property
*Check their “Player” property
 

= Scripting =

Both Behaviour as well as Story (Osiris) Scripting have received a plethora of new calls as well as changes to exiting ones. 
All for the better, of course! 

* [[:Category:Osiris_APIs|Osiris]]
* [[Character_and_Item_Script_Triggers,_Calls,_and_Queries|Behaviour Scripting]]
 

== Orphan Databases/Queries ==

Sometimes, the Osiris compiler did not catch typos in database names. For example:
 

'''IF'''
'''CharacterDied(_Player)'''
'''AND'''
'''DB_FreeResurrect(_Player)'''
'''AND'''
'''DB_Player(_Player)'''
'''THEN'''
'''// Free resurrect for players!'''
'''CharacterResurrect(_Player);'''
'''// Not twice in a row'''
'''NOT DB_FreeResurrected(_Player);'''
 

The DB_Player in the above fragment should read DB_IsPlayer, and the DB_FreeResurrected should be DB_FreeResurrect. Osiris did not notice anything wrong with this fragment because it can infer the type of the _Player variable from the CharacterDied event signature.

In order to catch such errors, the Osiris compiler now gives warnings (which are treated as errors) for all databases that either only checked or only defined in all story goals of the current mod and any mod it depends on. After all, such checks will always fail and such defines will never be used.

However, this can result in false positives. A common example is helpers in the Shared mod, which often check databases that will only be defined in other mods that actually make use of these helpers. To suppress these false positives, a new file can be added in the Story directory of a mod, with the name story_orphanqueries_ignore_local.txt. Every line of this file contains the name of a database followed by its arity (= number of fields/parameters).

When compiling a mod, the contents of all story_orphanqueries_ignore_local.txt files from the dependent mod and this mod are merged, so the ones defined in the Shared mod will also apply to your own mod.

In addition to the previous file, there are two more files you may now see in the Story directory of a Mod:
story_orphanqueries_ignore.txt: this file is recreated by the story editor every time you compile story (so no need to restart after changing the story_orphanqueries_ignore_local.txt file). It simply contains the contents of all relevant story_orphanqueries_ignore_local.txt files: the one from the current mod and any mod it depends on. This is the file that is read by the Osiris compiler to determine which warnings it should not show. Since it gets overwritten every time, don’t make changes to it since they will get lost.
story_orphanqueries_found.txt: this file is generated by the Osiris compiler every time you build story, and contains all of the databases for which it gave the aforementioned warning. These databases are in the same format as used by story_orphanqueries_ignore_local.txt, so you can just copy/paste its contents in case these are new false positives that should be suppressed.

One final note: the line number printed for these warnings is bogus, as no line number information is available anymore at the time it gets shown. In general ctrl-shift-f for the database name will be the easiest way to find the location(s) where it is used/defined.

Divinity Engine Wiki:Copyrights

2018-08-28T18:34:58Z

Kevin: Created page with "Content posted to this wiki on or after 28 August 2018, and also content posted to this wiki before that date by Larian Studios Games Ltd employees, is licensed under the Crea..."

Content posted to this wiki on or after 28 August 2018, and also content posted to this wiki before that date by Larian Studios Games Ltd employees, is licensed under the Creative Commons CC BY-NC-SA 4.0 license, except where stated otherwise. Community content posted before that date falls under the contribution guidelines outlined at [[Community_page_submission|Community Submissions Page]].

Larian Studios, Divinity, all other Larian Studios Games Ltd. product names, and their respective logos are trademarks of Larian Studios Ltd. in the USA and other countries. All company names, brand names, trademarks and logos are the property of their respective owner.

File:Dos2banner.jpg

2018-08-28T18:33:10Z

Kevin: Kevin uploaded a new version of File:Dos2banner.jpg

File:Overriding.png

2018-08-28T18:32:45Z

Kevin: Kevin uploaded a new version of File:Overriding.png

File:PublishProjectPanel.png

2018-08-28T18:32:15Z

Kevin: Kevin uploaded a new version of File:PublishProjectPanel.png

publish project panel step-by-step

File:Publish.png

2018-08-28T18:31:51Z

Kevin: Kevin uploaded a new version of File:Publish.png

File:FAQ.png

2018-08-28T18:31:20Z

Kevin: Kevin uploaded a new version of File:FAQ.png

File:GM Banner.jpg

2018-08-28T18:31:00Z

Kevin: Kevin uploaded a new version of File:GM Banner.jpg