Difference between revisions of "Setting up Database"

From Nexus Mods Wiki
Jump to: navigation, search
(Fixed typing, styles. Hope it looks better now. And default styles should be changed because od bad visibility, for eg. special container.)
Line 1: Line 1:
<div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr"><div class="OutlineElement Ltr BCX2 SCXW209497143" style="direction: ltr">
+
 
<span class="TextRun SCXW209497143 BCX2" data-contrast="none" style="color: rgb(47, 84, 150);  font-size: 13pt;  font-family: Calibri Light, Calibri Light_MSFontService, sans-serif;  line-height: 22.6625px" lang="EN-GB"><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">Database</span></span><span class="EOP SCXW209497143 BCX2" data-ccp-props="{" style="font-size: 13pt;  line-height: 22.6625px;  font-family: Calibri Light, Calibri Light_MSFontService, sans-serif">&nbsp;</span>
+
= Database =
</div> <div class="OutlineElement Ltr BCX2 SCXW209497143" style="direction: ltr">
+
 
<span class="TextRun SCXW209497143 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">The Game database contains all the game data, such as items, dialogues, perks etc... The </span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">modding</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">pack contains a dump of the game database in SQL format. You are going to need to run a </span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">postgreSQL</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">server on your computer, which the </span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">modding</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">tools will connect to.</span></span><span class="EOP SCXW209497143 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
+
The Game database contains all the game data, such as items, dialogues, perks, etc. The modding pack contains a dump of the game database in SQL format. In this tutorial we are going to use PostreSQL hosted locally on your computer, which the modding tools will connect to.&nbsp;
</div> <div class="OutlineElement Ltr BCX2 SCXW209497143" style="direction: ltr">
+
 
<span class="TextRun SCXW209497143 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">First download and install </span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">postgresql</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">from their website</span></span><span class="TextRun SCXW209497143 BCX2" data-contrast="none" style="color: rgb(255, 0, 0);  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">([https://www.postgresql.org/ https://www.postgresql.org/])</span></span><span class="TextRun SCXW209497143 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">, then install it. DB server should automatically start. Then you need to connect to the server, create a database called </span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">ConfigDB</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">(the name is </span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">unforunately</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">hardcoded into some of the tools), and add extension “</span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">uuid-ossp</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">”.</span></span><span class="EOP SCXW209497143 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
+
First download and install PostreSQL from [https://www.postgresql.org/ their website]. After install the database server should be up and running. Then we open pgAdmin (comes with the PostgreSQL package)&nbsp;tool and connect to the server. After connecting to the server we have to create a new database called&nbsp;<tt><q>ConfigDB</q></tt>&nbsp;(the name is unfortunatley hardcoded into some of the tools). When created add new <tt><q>uuid-ossp</q></tt> extention to this database.
</div> <div class="OutlineElement Ltr BCX2 SCXW209497143" style="direction: ltr">
+
 
<span class="TextRun SCXW209497143 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">In </span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">pgAdmin</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">(a tool that comes with </span><span class="ContextualSpellingAndGrammarError SCXW209497143 BCX2" style="background-color: inherit">basic</span><span class="SpellingError SCXW209497143 BCX2" style="background-color: inherit">postgresql</span><span class="NormalTextRun SCXW209497143 BCX2" style="background-color: inherit">package):</span></span><span class="EOP SCXW209497143 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
+
[https://wiki.nexusmods.com/images/0/0c/Setting_Up_Database_image1.jpgIf https://wiki.nexusmods.com/images/0/0c/Setting_Up_Database_image1.jpgIf] you do not have acces to the pgAdmin you can run this via command line using&nbsp;''psql.exe''&nbsp;(comes with PostgreSQL package) with the following commands.&nbsp;
</div>
+
<div style="background:#000;border:1px solid #cccccc;padding:5px 10px;"><tt>CREATE DATABASE ConfigDB<br/> CREATE EXTENSION "uuid-ossp"</tt></div>  
[[File:Setting Up Database image1.jpg|RTENOTITLE]]<br/> <br/> <span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-US"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">Or run psql.exe (also comes with</span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">postgresql</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">) and input following commands:</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
+
After&nbsp;completing first step we use&nbsp;''psql.exe&nbsp;''&nbsp;to restore the database from provided dumps.
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
+
<div style="background:#000;border:1px solid #cccccc;padding:5px 10px;">
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt; font-family: Consolas, Consolas_MSFontService, monospace; line-height: 19.425px" lang="EN-US"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">CREATE DATABASE </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">ConfigDB</span></span><span class="LineBreakBlob BlobObject DragDrop SCXW122478776 BCX2" style="font-size: 11pt;  line-height: 19.425px;  font-family: Consolas, Consolas_MSFontService, monospace"><span class="SCXW122478776 BCX2">&nbsp;</span></span><br/> <span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-US"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">CREATE EXTENSION “</span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">uuid-ossp</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">”</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt; line-height: 19.425px;  font-family: Consolas, Consolas_MSFontService, monospace">&nbsp;</span>
+
<tt>psql.exe -f&nbsp;Data_reference/modding.sql -U&nbsp;postgres –d&nbsp;ConfigDB -q&nbsp;</tt>
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
+
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun CommentStart SCXW122478776 BCX2" style="background-color: inherit">Then run psql.exe to restore the database from provided dumps:</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
+
<tt>psql.exe -f&nbsp;Data_reference/public.sql -U&nbsp;postgres –d&nbsp;ConfigDB -q&nbsp;</tt>
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt; font-family: Consolas, Consolas_MSFontService, monospace; line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">psql.exe -f </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">Data_reference</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">/</span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">modding.sql</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">-U </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">postgres</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">–d </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">ConfigDB</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">-q</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Consolas, Consolas_MSFontService, monospace">&nbsp;</span>
 
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">psql.exe -f </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">Data_reference</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">/</span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">public.sql</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">-U </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">postgres</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">–d </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">ConfigDB</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">-q</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Consolas, Consolas_MSFontService, monospace">&nbsp;</span>
 
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">Ideally this command should run with no output of any kind (the -q switch hides all non-errors, and there should be no errors). In your database, there should be now a schema called “</span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">modding</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">” with 468 tables.</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
 
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
 
<span class="TextRun SCXW108787113 BCX2" data-contrast="none" style="color: rgb(47, 84, 150);  font-size: 13pt;  font-family: Calibri Light, Calibri Light_MSFontService, sans-serif;  line-height: 22.6625px" lang="EN-GB"><span class="NormalTextRun SCXW108787113 BCX2" style="background-color: inherit">Autoincrement</span></span>
 
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr"><div class="OutlineElement Ltr BCX2 SCXW224964571" style="direction: ltr">
 
<span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">Some tables use autoincrement to generate IDs for new entries. If you are going to create new dialogues, you are going to need to adjust the initial value for this autoincrement to a value unique for your mod. If you don’t, your mod will clash with any other mods that also failed to set a unique value.</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">To do this, open</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">file</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">Data_references.sql</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">/</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">sequences.sql</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">and change the value 10578 to any value unique to your mod (</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">ideally a value that is far enough from other mod’s values, by at least seve</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">ral hundreds</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">. Since the first ids are used by KCD’s entries,</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">choose a number higher than 100</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">000</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">)</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">.</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">Then run</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">following</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">command:</span></span><span class="EOP SCXW224964571 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
 
</div> <div class="OutlineElement Ltr BCX2 SCXW224964571" style="direction: ltr">
 
<span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">psql.exe -f</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt; font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">Data_reference</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">/</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">sequences</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">.</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">sql</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">-U</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt; font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">postgres</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">–d</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace; line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">ConfigDB</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">–</span></span><span class="TextRun SCXW224964571 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Consolas, Consolas_MSFontService, monospace;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW224964571 BCX2" style="background-color: inherit">q</span></span><span class="EOP SCXW224964571 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Consolas, Consolas_MSFontService, monospace">&nbsp;</span>
 
 
</div>  
 
</div>  
 +
Ideally this command should run with no output of any kind (the -q switch hides all non-errors, and there should be no errors). In your database, there should be now a schema called <q><tt>modding</tt></q>&nbsp;with 468 tables.&nbsp;&nbsp;
 +
 +
&nbsp;
 +
 +
== Autoincrement ==
 +
 +
Some tables use autoincrement to generate IDs for new entries. If you are going to create new dialogues, you are going to need to adjust the initial value for this autoincrement to a value unique for your mod. If you don’t, your mod will clash with any other mods that also failed to set a unique value. To do this, open file <tt>Data_references.sql/sequences.sql</tt> and change the value 10578 to any value unique to your mod (ideally a value that is far enough from other mod’s values, by at least several hundreds. Since the first ids are used by KCD’s entries,choose a number higher than 100000).Then run following command:&nbsp;
 +
<div style="background:#000;border:1px solid #cccccc;padding:5px 10px;"><tt>psql.exe -f Data_reference/sequences.sql -U postgres –d ConfigDB –q&nbsp;</tt></div>
 +
&nbsp;
 +
 +
== Setting up tools&nbsp; ==
 +
 +
There are several tools that work with the SQL database. Most of them require you to set up correct registry keys which they read connection information from. To do that, modify file <q><tt>Tools/!registry/db.reg</tt></q>&nbsp; (you only need to modify the password, <tt><q>postgres</q></tt>&nbsp;is the default user) and then run it.&nbsp;All of the tools, except the Sandbox editor, use these registry keys. To get the Sandbox to connect, fill in correct connection information in <tt><q>user.cfg</q></tt>. Sandbox editor also requires an ''ODBC Driver'' to use. Install one for&nbsp;postgreSQL from [https://odbc.postgresql.org/ their&nbsp;site] (use 64-bit version).&nbsp;
 +
 
&nbsp;
 
&nbsp;
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
+
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="none" style="color: rgb(47, 84, 150);  font-size: 13pt;  font-family: Calibri Light, Calibri Light_MSFontService, sans-serif;  line-height: 22.6625px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">Setting up tools</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 13pt;  line-height: 22.6625px;  font-family: Calibri Light, Calibri Light_MSFontService, sans-serif">&nbsp;</span>
+
== Working with Database ==
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
+
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">There are several tools that work with the SQL database. Most of them require you to set up correct registry keys which they read connection information from. To do that, modify file</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-weight: bold;  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">Tools</span><span class="ContextualSpellingAndGrammarError SCXW122478776 BCX2" style="background-color: inherit">/</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-weight: bold;  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="ContextualSpellingAndGrammarError SCXW122478776 BCX2" style="background-color: inherit">!</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-weight: bold;  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="ContextualSpellingAndGrammarError SCXW122478776 BCX2" style="background-color: inherit">registry/db.reg</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">&nbsp; (you only need to modify the password, “</span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">postgres</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">” is the default user) and then run it. </span><span class="AdvancedProofingIssue SCXW122478776 BCX2" style="background-color: inherit">All of</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">the tools, except the Sandbox editor, use these registry keys. To get the Sandbox to connect, fill in correct connection information in</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-weight: bold;  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">user.cfg</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">.</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">Sandbox editor also requires</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">an</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">ODBC driver to use. Install one for </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">postgreSQL</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">from</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="none" style="color: rgb(255, 0, 0);  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">their </span><span class="ContextualSpellingAndGrammarError SCXW122478776 BCX2" style="background-color: inherit">site(</span></span>[https://odbc.postgresql.org/ <span class="TextRun Underlined SCXW122478776 BCX2" data-contrast="none" style="color: rgb(255, 0, 0);  text-decoration: underline;  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">https://odbc.postgresql.org/</span></span>]<span class="TextRun SCXW122478776 BCX2" data-contrast="none" style="color: rgb(255, 0, 0);  font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">)</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">(use 64-bit version).</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
+
The database can be edited with any SQL client you prefer, or you can use our custom tool.&nbsp; It is a plugin for MS Excel, which simplifies editing tables by unpacking foreign keys. To use it, you need to install in from <tt><q>Tools/ExcelDbAddin2</q></tt>, which installs it directly into MS Excel (it can be removed at any time in “Add or Remove programs”). It will appear as a new menu item called <tt><q>WHS DB</q></tt>.&nbsp;
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
+
 
<span class="TextRun SCXW108787113 BCX2" data-contrast="none" style="color: rgb(47, 84, 150);  font-size: 13pt;  font-family: Calibri Light, Calibri Light_MSFontService, sans-serif;  line-height: 22.6625px" lang="EN-GB"><span class="NormalTextRun SCXW108787113 BCX2" style="background-color: inherit">Working with Database</span></span>
+
Any changes made to the database will be visible in the Sandbox editor (with the exception of Localization). The game, however, reads the database from XML files inside&nbsp;''Tables.pak'' or mod PAK files. To create such PAKs, use the editor’s&nbsp;[https://wiki.nexusmods.com/index.php/Modding_Tool modding&nbsp;][https://wiki.nexusmods.com/index.php/Modding_Tool window]&nbsp;.&nbsp;
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">The database can be edited with any SQL client you prefer, or you can use our custom tool.&nbsp; It is a plugin for MS Excel, which simplifies editing tables by unpacking foreign keys. To use it, you need to install in from Tools/ExcelDbAddin2, which installs it directly into MS Excel (it can be removed at any time in “Add or Remove programs”). It will appear as a new menu item called “WHS DB”.</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt;  line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
 
</div> <div class="OutlineElement Ltr BCX2 SCXW122478776" style="direction: ltr">
 
<span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">Any changes made to the database will be visible in the Sandbox editor (</span><span class="AdvancedProofingIssue SCXW122478776 BCX2" style="background-color: inherit">with the exception of</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">Localization). The game, however, reads the database from XML files inside </span><span class="SpellingError SCXW122478776 BCX2" style="background-color: inherit">Tables.pak</span><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">or mod PAK files. To create such PAKs, use the editor’s [[Modding_Tool|modding ]][[Modding_Tool|window]]&nbsp;</span></span><span class="TextRun SCXW122478776 BCX2" data-contrast="auto" style="font-size: 11pt;  font-family: Calibri, Calibri_MSFontService, sans-serif;  line-height: 19.425px" lang="EN-GB"><span class="NormalTextRun SCXW122478776 BCX2" style="background-color: inherit">.</span></span><span class="EOP SCXW122478776 BCX2" data-ccp-props="{" style="font-size: 11pt; line-height: 19.425px;  font-family: Calibri, Calibri_MSFontService, sans-serif">&nbsp;</span>
 
</div> 
 
[[Category:Kingdom Come Deliverance]] [[Category:Getting Started]]
 

Revision as of 09:08, 30 October 2019

Database

The Game database contains all the game data, such as items, dialogues, perks, etc. The modding pack contains a dump of the game database in SQL format. In this tutorial we are going to use PostreSQL hosted locally on your computer, which the modding tools will connect to. 

First download and install PostreSQL from their website. After install the database server should be up and running. Then we open pgAdmin (comes with the PostgreSQL package) tool and connect to the server. After connecting to the server we have to create a new database called ConfigDB (the name is unfortunatley hardcoded into some of the tools). When created add new uuid-ossp extention to this database.

https://wiki.nexusmods.com/images/0/0c/Setting_Up_Database_image1.jpgIf you do not have acces to the pgAdmin you can run this via command line using psql.exe (comes with PostgreSQL package) with the following commands. 

CREATE DATABASE ConfigDB
CREATE EXTENSION "uuid-ossp"

After completing first step we use psql.exe  to restore the database from provided dumps.

psql.exe -f Data_reference/modding.sql -U postgres –d ConfigDB -q 

psql.exe -f Data_reference/public.sql -U postgres –d ConfigDB -q 

Ideally this command should run with no output of any kind (the -q switch hides all non-errors, and there should be no errors). In your database, there should be now a schema called modding with 468 tables.  

 

Autoincrement

Some tables use autoincrement to generate IDs for new entries. If you are going to create new dialogues, you are going to need to adjust the initial value for this autoincrement to a value unique for your mod. If you don’t, your mod will clash with any other mods that also failed to set a unique value. To do this, open file Data_references.sql/sequences.sql and change the value 10578 to any value unique to your mod (ideally a value that is far enough from other mod’s values, by at least several hundreds. Since the first ids are used by KCD’s entries,choose a number higher than 100000).Then run following command: 

psql.exe -f Data_reference/sequences.sql -U postgres –d ConfigDB –q 

 

Setting up tools 

There are several tools that work with the SQL database. Most of them require you to set up correct registry keys which they read connection information from. To do that, modify file Tools/!registry/db.reg  (you only need to modify the password, postgres is the default user) and then run it. All of the tools, except the Sandbox editor, use these registry keys. To get the Sandbox to connect, fill in correct connection information in user.cfg. Sandbox editor also requires an ODBC Driver to use. Install one for postgreSQL from their site (use 64-bit version). 

 

Working with Database

The database can be edited with any SQL client you prefer, or you can use our custom tool.  It is a plugin for MS Excel, which simplifies editing tables by unpacking foreign keys. To use it, you need to install in from Tools/ExcelDbAddin2, which installs it directly into MS Excel (it can be removed at any time in “Add or Remove programs”). It will appear as a new menu item called WHS DB

Any changes made to the database will be visible in the Sandbox editor (with the exception of Localization). The game, however, reads the database from XML files inside Tables.pak or mod PAK files. To create such PAKs, use the editor’s modding window .