Divinity Engine Wiki - User contributions [en]

Definitive Edition

2018-09-03T16:57:06Z

Jbotteram: /* Sound Modding */

__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_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-09-03T16:51:51Z

Jbotteram:

__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 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_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.

Publish project window

2018-04-05T07:15:05Z

Jbotteram:

[[File:PublishProjectPanel.png|none]]
The Publish Project Panel with each part numbered 

== Content ==
=== The Project Banner (1) ===

The project banner is at the very top of the window and shows the main image that will be displayed on the Steam Workshop page when published.

The banner can be changed in the [[Project settings window|Project Settings Window]].

 

=== The Project Configuration (2) ===

The project configuration is copied over from the project settings set in the project settings window.

The tags are the tags under which the project will be published on the Steam Workshop. The tags are automatically set based on the the project type (set when creating the project in the [[Project browser|Project Browser Window]]) and the project's dependencies.

Final changes to the title and description can be made here. Do note that changes made in the Publish Project window are not saved and will be lost after closing the window.

 
=== The Publish Settings (3) ===

There are 2 ways to publish a project: either locally (the project is published to your harddrive) or directly to the Steam Workshop (the project is published to your harddrive and then published to the Steam Workshop).

When publishing a project to the Steam Workshop, you can choose between publishing a Private project (only you will be able to see it), a Friends Only project (only you and your friends will be able to see it) or a Public project (everyone will be able to see it).

Locally published mods will show up in "User/Documents/Larian Studios/Divinity Original Sin 2/Local Mods"

Publish project window

2018-04-05T07:13:10Z

Jbotteram:

UI Colors Reference Sheet

2018-02-19T15:23:49Z

Jbotteram:

Below, you can find the color sheet for all engine-registered colors. 
There are several tables. All but the last table contain engine entries, used throughout the game for UI consistency, gameplay denotations (red = enemy,...),... 
These values are in RGBA format. 

 
The last table contains all registered colors used for text purposes. This table contains dialog colors, colors for status afflictions,... 
All of the [[Stats_Editor|Stats Editor]]'s FormatColor field values come from this table as well. 
These are defined in HEX format. 

 
{| class="wikitable sortable"
|-
! Base !! Color Value (RGBA)
|-
| Black || (0.0, 0.0, 0.0, 1.0)
|-
| Blue || (0.0, 0.470588, 1.0, 1.0)
|-
| Green || (0.0, 0.94902, 0.490196, 1.0)
|-
| Red || (1.0, 0.00784314, 0.0, 1.0)
|-
| White || (1.0, 1.0, 1.0, 1.0)
|-
| Yellow || (1.0, 1.0, 0.0, 1.0)
|}

{| class="wikitable sortable"
|-
! General !! Color Value (RGBA)
|-
| ActiveCharacter || (1.0, 1.0, 1.0, 1.0)
|-
| AoO || (1.0, 0.00784314, 0.0, 1.0)
|-
| AreaInteract || (1.0, 0.831373, 0.0, 1.0)
|-
| Attack || (1.0, 0.00784314, 0.0, 1.0)
|-
| BackstabRegion || (1.0, 1.0, 1.0, 1.0)
|-
| DefaultRangeOutlineColor || (0.294118, 0.627451, 1.0, 1.0)
|-
| DefaultTaskColor || (1.0, 0.831373, 0.0, 1.0)
|-
| FallbackOutline || (1.0, 1.0, 1.0, 1.0)
|-
| InvalidAction || (1.0, 0.00784314, 0.0, 1.0)
|-
| MaximumSkillRange || (0.8, 0.8, 0.8, 1.0)
|-
| MoveFootstep || (1.0, 1.0, 1.0, 1.0)
|-
| MoveTargetCircle || (1.0, 1.0, 1.0, 1.0)
|-
| MoveTargetCross || (1.0, 1.0, 1.0, 1.0)
|-
| MutedEffect || (0.0, 1.0, 1.0, 1.0)
|-
| OutlineInterract || (1.0, 0.831373, 0.0, 1.0)
|-
| OutlineMoveItem || (1.0, 1.0, 1.0, 1.0)
|-
| OutlineMoveItemDestination || (1.0, 1.0, 0.0, 1.0)
|-
| PeaceOutline || (1.0, 1.0, 1.0, 1.0)
|}

{| class="wikitable sortable"
|-
! Arena Team !! Color Value (RGBA)
|-
| ArenaTeam1 || (0.192157, 0.52549, 0.4, 1.0)
|-
| ArenaTeam2 || (0.235294, 0.411765, 0.513726, 1.0)
|-
| ArenaTeam3 || (0.521569, 0.4, 0.184314, 1.0)
|-
| ArenaTeam4 || (0.529412, 0.211765, 0.360784, 1.0)
|}

{| class="wikitable sortable"
|-
! Skill School !! Color Value (RGBA)
|-
| SchoolAir || (0.458824, 0.47451, 0.831373, 0.85098)
|-
| SchoolEarth || (0.666667, 0.537255, 0.356863, 0.85098)
|-
| SchoolFire || (0.780392, 0.396078, 0.215686, 0.85098)
|-
| SchoolNecromancy || (0.603922, 0.313726, 0.521569, 0.85098)
|-
| SchoolPolymorph || (0.960784, 0.721569, 0.0705882, 0.85098)
|-
| SchoolRanger || (0.352941, 0.588235, 0.27451, 0.85098)
|-
| SchoolRogue || (0.337255, 0.423529, 0.423529, 0.85098)
|-
| SchoolSource || (0.431373, 0.690196, 0.615686, 0.85098)
|-
| SchoolSummoning || (0.580392, 0.25098, 0.701961, 0.85098)
|-
| SchoolWarrior || (0.631373, 0.0980392, 0.0980392, 0.85098)
|-
| SchoolWater || (0.341176, 0.611765, 0.792157, 0.85098)
|}

{| class="wikitable sortable"
|-
! Alignments !! Color Value (RGBA)
|-
| Party_Base || (0.0, 0.639, 0.992, 1.0)
|-
| Party_Light || (0.424, 0.796, 1.0 1.0)
|-
| Ally_Base || (0.067, 0.847, 0.478 1.0)
|-
| Ally_Light || (0.502, 1.0, 0.765, 1.0)
|-
| Neutral_Base || (0.953, 0.827, 0.278, 1.0)
|-
| Neutral_Light || (1.0, 0.918, 0.549, 1.0)
|-
| Enemy_Base || (0.843, 0.0, 0.122, 1.0)
|-
| Enemy_Light || (1.0, 0.302, 0.404, 1.0)
|-
| Item_Base || (0.953, 0.827, 0.278, 1.0)
|-
| Item_Light || (1.0, 0.918, 0.549, 1.0)
|}

{| class="wikitable sortable"
|-
! Text !! Color Value (HEX) !! Color Example
|-
| White || #ffffff || sample
|-
| DarkGray || #454545 || sample
|-
| Gray || #a8a8a8 || sample
|-
| LightGray || #dbdbdb || sample
|-
| Red || #c80030 || sample
|-
| Blue || #188ede || sample
|-
| DarkBlue || #004672 || sample
|-
| LightBlue || #cfecff || sample
|-
| Green || #40b606 || sample
|-
| PoisonGreen || #00aa00 || sample
|-
| Yellow || #fcd203 || sample
|-
| Orange || #ff9600 || sample
|-
| Pink || #ffc3c3 || sample
|-
| Purple || #7f00ff || sample
|-
| Brown || #b97a57 || sample
|-
| Gold || #c7a758 || sample
|-
| Black || #000000 || sample
|-
| Normal || #ffffff || sample
|-
| Storyitem || #d040d0 || sample
|-
| Shadow || #797980 || sample
|-
| Poison || #65c900 || sample
|-
| Earth || #7f3d00 || sample
|-
| Air || #7d71d9 || sample
|-
| Water || #4197e2 || sample
|-
| Fire || #fe6e27 || sample
|-
| Source || #46b195 || sample
|-
| Decay || #b823cb || sample
|-
| Polymorph || #f7ba14 || sample
|-
| Ranger || #81ab00 || sample
|-
| Rogue || #639594 || sample
|-
| Summoner || #7f25d4 || sample
|-
| Void || #73f6ff || sample
|-
| Warrior || #da2512 || sample
|-
| Special || #c9aa58 || sample
|-
| Healing || #97fbff || sample
|-
| Charm || #ffb8b8 || sample
|-
| Reputation || #ffab00 || sample
|-
| Karma || #7f00ff || sample
|-
| Stats_Off_Def || #411600 || sample
|-
| Stats_LvlUp || #007431 || sample
|-
| Stats_Greyed_Out || #403625 || sample
|-
| Stat_Boosted || #00547f || sample
|-
| Dialog_NoPlayer || #ffffff || sample
|-
| Dialog_Peer_Owns_Player || #9a6a46 || sample
|-
| Dialog_Peer_Not_Owns_Player || #745035 || sample
|-
| Dialog_Player_Is_Enemy || #aa3938 || sample
|-
| Dialog_Player_Not_Popular || #ed9d07 || sample
|-
| Dialog_Player_Neutral || #fcd203 || sample
|-
| Dialog_Player_Popular || #88a25b || sample
|-
| Dialog_Player_Super_Popular || #34789c || sample
|-
| Rps_Charm || #d66565 || sample
|-
| Rps_Intimidate || #d85b00 || sample
|-
| Rps_Reason || #e4ce93 || sample
|-
| Illegal_Action || #cd1f1f || sample
|-
| PlayerColor_Green || #318666 || sample
|-
| PlayerColor_Blue || #3c6983 || sample
|-
| PlayerColor_Yellow || #85662f || sample
|-
| PlayerColor_Red || #87365c || sample
|-
| Sticky || #f1d466 || sample
|-
| TutorialKey || #008858 || sample
|}

Creating a book with TEXT inside

2017-11-08T13:11:08Z

Jbotteram: Reverted edits by Kevin (talk) to last revision by Scottworld

This article describes how to create a basic information Book which contains some readable TEXT for the players.

1: Open the "Translated String" editor (Little Japanese Character in the top menu bar)

2: FILE.. NEW - to create a new "TranslatedStringKey"

3: Now you can fill in your attributes in the new key.
Use something along the lines of...

<pre>
key = Book_Modding_Guide (you need to remember this)
ExtraData = "Here is where you cut and paste what text you want in the book."
</pre>

4: Save All and close the Translated Sting Editor.

5: Grab a book from the resources and drop into your level. (Book_Book_A is the sort of thing you want)

6: Edit the "Use Actions" attibute on the side bar for the book.

7: Remove the "Book: Gen_Unreadable" action if it is present. (red minus button)

8: Ok now add a new BOOK action. (Green + button)

9: Now in the "Bood ID" (yeah I think it is spelled wrong) attibute, type in the name of the string Key you created - in this case it was "Book_Modding_Guide" apply and save.

10: Now go back into your level and try it... pick up the book and read it from your inventory you should see the "Extra Text"

My first: Custom portrait

2017-11-06T13:11:23Z

Jbotteram:

== Description ==
The icons for characters in Divinity: Original Sin 2 are rendered by the portrait renderer, in the editor. Although fully automatic, the portrait renderer requires some setting up to know which portraits to render.

This article will not be going over creating a new character root template. If you do not yet know how to create a character root template, I recommend you read [[My first: Character]] first.

 
== Rendering a character portrait ==
=== Step 1: the photobooth level ===
In order to render character portraits, we will need a photobooth level. The photobooth level is a level that contains photobooths for each character for which an icon is rendered. Each photobooth consists of a background plane, lights, a point trigger and a spectator trigger. The spectator trigger is the camera from which the icon will be rendered.

First, we will open the ''SYS_NPC_Portrait_A'' level, which is inherited from the Shared project. We could create a photobooth level from scratch, but using an existing one is easier, as it allows us to copy an existing photobooth.

 
[[File:Step1_OpenPhotoboothLevel.png|none]]
Opening the ''SYS_NPC_Portrait_A'' level

To open the photobooth level, check the "Show Inherited Levels" toggle (1). Then, navigate to the "SYS" folder (2) and select (or double click) the ''SYS_NPC_Portrait_A'' level (3). With the level selected, click "Select" to load (4).

If you can not see anything in the level, try changing your work atmosphere trigger, as the default level atmosphere for the photobooth level is very dark.

Next, we need to set the level as our project's default photobooth level.

 
[[File:Step2_ConfigureProjectProperties.png|none]]
Setting the photobooth level for this project

To set the photobooth level of your project, go to the [[Project settings window]] (under Project > Project Settings...) and navigate to the "General" tab (1).

In the general tab, click the [...] button next to "Photo Booth Level" (2) and select your photobooth level (''SYS_NPC_Portrait_A''). If the level is set correctly, hit "Save" back in the project settings window (3).

We can now render portraits for our level. However, the portrait texture atlas will be empty, as we have not yet defined any templates to render.

 
=== Step 2: setting up the photobooth ===
[[File:Step3_CopyingPhotobooth.png|none]]
Copying a photobooth for our own root template

First, copy an existing photobooth by selecting it (lights, background, camera trigger and point trigger) (1), enabling the translate interaction mode (2) and shift-dragging it along the X-axis (3).

Next, we will customize the copied photobooth.

 
[[File:Step4_SetupPhotobooth_Trigger.png|none]]
Setting the name of the photobooth's point trigger

The portrait renderer needs the location where your character will stand when the portrait is rendered. For this, it uses the point trigger we copied.

To rename the point trigger, select it (1) and change its name in the [[Sidebar]] (2). I named my point trigger ''Icon_Goblin_Wayfarer''.

 
[[File:Step4_SetupPhotobooth_Camera.png|none]]
Copying a photobooth for our own root template

We will also need to name our camera trigger. Select the camera trigger (1) and change its name to to Cam_{PointTriggerName} (replace {PointTriggerName} with the name you gave the point trigger) (2). I named my camera ''Cam_Icon_Goblin_Wayfarer''.

 
[[File:Step4_SetupPhotobooth_Character.png|none]]
Copying a photobooth for our own root template

The last thing we need to do is set up the character whose portrait will be rendered. My character is created from a root template named ''Creatures_Goblins_Wayfarer'', a copy of the ''Creatures_Goblins_Grunt_A'' template with a custom visual set.

Create an instance of the character in the photobooth level with the [[File:InteractionMode_Creation.png|32px]] creation interaction mode (1), select it (2) and change its "Portrait Generation Trigger" property to the name of your point trigger in the sidebar (3). I set the value of the property to ''Icon_Goblin_Wayfarer''.

Our photobooth is now all set up! It's time to render the portrait.

 
=== Step 3: rendering ===
[[File:Step5_RenderPortraits.png|none]]
The "Render Character Portraits" button

Finally, start the portrait render by clicking "Render Character Portraits" under the "Project" menu in the menu bar.

If the render is successful, your character should now have a portrait icon! Make sure to copy the icon property from the character back to the character's root template so it applies to all instances of that template.

 
[[File:Step6_RenderPortrait_Result.png|none]]
The resulting character portrait

 
== Notes ==
* Portraits that exist in inherited projects will not be re-rendered, making it impossible to render icons for existing templates. However, it is possible to create a new photobooth with a copy of the root template you wish to modify, render the icon for that template, and then assign the rendered icon to the original template.
* The photobooth level is very dark, make sure to use a custom work atmosphere.
* Characters need to have a visual set in order to be included in the portrait render

2017-09-25T07:35:48Z

Jbotteram:

File:ProjectBrowser Inherited.png

2017-09-25T07:35:43Z

Jbotteram:

Modding: The main campaign

2017-09-25T07:33:31Z

2017-09-21T13:07:41Z

Jbotteram:

== Description ==
Item combinations in the Divinity Engine 2 are used for a wide range of crafting possibilities, and whether you want to brew a deadly potion or craft a powerful weapon, it's all done via the Stats Editor.

In this guide we will be creating 2 new recipes:
* Combining a red pepper and whisperwood to create a fire resistance potion
* Combining a red pepper, whisperwood and augmenting it with a human skull

What this guide will ''not'' be covering is crafting custom objects or crafting using custom ingredients. For this you would first need a new stats object and a new root template.

 
== Creating a new recipe ==
=== Step 1: setting up your level ===
[[File:Step1_Setup.png|none]]
Setting up a test scene

The first thing we will need to do is to set up a test scene. I placed the following templates:
* LOOT_Skull_Human_A (1)
* 2x CON_Food_Pepper_A (2)
* 2x CON_Herb_Whisperwood_A (3)

To reference these object types we will need the name of the ''stats object'', not the name of the root template! You can find the name of the stats object in the template's properties (Ctrl+B to open the sidebar) under the property named "Stats".

=== Step 2: the stats editor ===
[[File:Step2_StatsItemCombinations.png|none]]
2 ItemCombination stats entries for our 2 new recipes

Next, open the [[File:StatsEditor_Icon.png|32px]] [[Stats editor]]. The Stats editor is where we will be defining our recipes.

In the stats editor, locate the "ItemCombos" document in your project. If it does not yet exist, click the '''+''' icon next to ItemCombos and create it.

I added 2 new entries to the ItemCombos document: CON_Herb_Whisperwood_A_CON_Food_Pepper_A_01 (1) and CON_Herb_Whisperwood_A_CON_Food_Pepper_A_02 (2). The former will be our base recipe and the former will be the augmented version (with the skull).

First, let's set the base properties:
{| class="wikitable"
|-
|''Name''
|''RecipeCategory''
|''Result 1''
|''PreviewStatsID''
|-
|01
|Potions
|CON_Potion_Fire_Res_Medium_A
|CON_Potion_Fire_Res_Medium_A
|-
|02
|Potions
|CON_Potion_Fire_Res_Large_A
|CON_Potion_Fire_Res_Large_A
|}

These properties define the type of item combination, the crafting result and the crafting result preview.

Next, we will configure the ingredients for the item combination:
{| class="wikitable"
!colspan="4"|Ingredient 1
|-
|''Name''
|''Type 1''
|''Object 1''
|''Transform 1''
|-
|01
|Object
|CON_Food_Pepper_A
|Transform
|-
|02
|Object
|CON_Food_Pepper_A
|Transform
|}

 
{| class="wikitable"
!colspan="4"|Ingredient 2
|-
|''Name''
|''Type 2''
|''Object 2''
|''Transform 2''
|-
|01
|Object
|CON_Herb_Whisperwood_A
|Consume
|-
|02
|Object
|CON_Herb_Whisperwood_A
|Consume
|}

 
{| class="wikitable"
!colspan="4"|Ingredient 3
|-
|''Name''
|''Type 3''
|''Object 3''
|''Transform 3''
|-
|01
|
|
|
|-
|02
|Object
|LOOT_Skull_Human_A
|None
|}

Important to note are the different ''Transform'' types:
* Transform means the object will be transformed into the result
* Consume means the object will be consumed after crafting
* None means the object will remain intact after crafting

 
=== Step 3: testing our recipes ===