Editing Mod:Create a dialogue

This tutorial shows how to create or edit dialogs in ''[[Wikipedia 2197|The Sum]]''.
[[file:Notepad++.jpg|thumb|This tutorial uses mainly the Notepad++ text editor.]]

== Required tools ==
* [[Mod:Editors#Notepad.2B.2B|Notepad++]]
* [[Mod:Editors#Level_editor|Level Editor]]

== Before You Begin ==
Please take some time to browse the "Speech" section of the [http://10projets.org/nousaurons/editor_readme.html#Levelsection8 readme file from the Fallout Tactics editor].

== Create a dialogue ==
=== Access the '''.txt''' file of the location ===
Each location has its dialog file (with an eponymous code name) already imported. It is in ''Game/NousAurons/locale/'' (French version) and ''Game/core/locale/'' (English version). Some of these files are in a folder of the same name to allow to also store voice files.{{Idea|Any '''.mp3''' file (in the same folder) with the same file name as a dialog entry (ex: '''AJOUT_Di_1_1.mp3''' will be heard in the game.}}
=== Writing introduction ===
# Open the two files '''location_code_name_where_the_dialogue_takes_place.txt'' and for each of them:
## Press {{False button|ctrl|color=white}}+{{False button|f|color=white}} and search for "// DIALOGUES"
## Copy/paste the following code: <syntaxhighlight>
ADD_Di_1 = {<Ck>- Dialog portion}
</syntaxhighlight>
# Add as many dialog portions as you need.
# Go to the {{Fake button|File|color=white}} menu and then {{Fake button|Save|color=gray}}.

=== Writing convention ===
* Each dialog code name (ex: ''AJOUT_Di_1'') must be unique in the file where it is added.
* '''''AJOUT_'':''' helps to find the dialog first in the alphabetical list when it is integrated in the [[Mod:Editors#Level_editor|Level editor]].
* '''''Di_'':''' indicates that it is a portion of a dialog.
* '''''Acc'':''' indicates that this is the character's first piece of dialogue.
* '''''R'':''' indicates that this is a response from the player.
* '''''Rdm'' followed by a number from 1 to 6:''' is used to indicate that the dialogue portion will float over the character's head.
* '''''OBJ'':''' indicates that the dialogue portion is a quest label, or related to a quest.
* '''''Pers'' followed by a number from 1 to 6:''' refers to a character whose code name is identical in the level editor.
* '''''Int and Cha'':''' indicate a portion of dialogue that is triggered when the player has a low Intelligence or Charisma score.
* '''''<Ck>-'':'' is placed in any dialog to change the color of the text to black and precede it with a dash.
* A few short sentences can be added to the dialog code name to differentiate it (ex: Mad){{Warning|The characters "/" and ":" cannot be used as is in dialogs. Replace them with "^" and "#" to display them properly in the game}}

=== Writing steps ===
# Access the appropriate ''.txt'' files (those with the code name of the location where the dialogue will be added)
# Choose the code name of the character speaking (if possible identical to the code name of a character already in the location, like ''Pers1'')
# Write an introduction line:<syntaxhighlight>
ADD_Di_Pers1_Acc = {<Ck>- Hello!}
</syntaxhighlight>
# Add or don't add a player reply:<syntaxhighlight>
ADD_Di_Pers1_AccR = {<Ck>- Hi!}
</syntaxhighlight>{{Idea|This response may require certain conditions, indicated after the dialog portion as a comment (preceded by ''//''). Ex: ''//Intelligence < 5''}}
# Add the dialogs that logically follow:<syntaxhighlight>
ADD_Di_Pers1_1 = {<Ck>- Would you have a minute to help me?}
ADD_Di_Pers1_1R = {<Ck>- I'd love to!}
ADD_Di_Pers1_1R_Refuse_to_help = {<Ck>- Forget it!} //Insensible
ADD_Di_Pers1_2 = {<Ck>- Wonderful. I was about to pass out, this is too heavy!}
ADD_Di_Pers1_2_Refuse_help = {<Ck>- This is so insensitive of you!}
</syntaxhighlight>
# Add some portions of dialogue appearing above the character's head:<syntaxhighlight>
ADD_Di_Pers1_Rdm1 = {Beautiful day still<C->}
ADD_Di_Pers1_Rdm2 = {<Cr>This is heavy!<C->}
ADD_Di_Pers1_Rdm3 = {What's that?<C->}
ADD_Di_Pers1_Rdm4 = {I could use some help...<C->}
ADD_Di_Pers1_Rdm5 = {<Co>How are the others doing?<C->}
ADD_Di_Pers1_Rdm6 = {I try as hard as I can, it's useless.<C->}
</syntaxhighlight>

=== Writing codes ===
The following codes are used to color the text and add special characters, for example.
* '''''\n'':''' Skip a line.
* '''''<C*>'' and ''<C->'':'' Add/remove a Color. Replace '''*''' with ''b'' (blue), ''c'' (cyan), ''k'' (black), ''m'' (magenta), ''o'' (orange), ''r'' (red), ''w'' (white) or ''y'' (yellow).
* '''''<rgb:***,***,***>'':''' Add a specific RGB color. Replace '''***''' with a number from 1 to 255. 
* '''''<b+>'' and ''<b->'':'' Add/Remove Bold.
* '''''<Jl>'', ''<Jc>'', ''<Jr>'' and ''<Jj>'':'' Left-aligned, center-aligned, right-aligned or justified text.
 → [http://10projets.org/nousaurons/editor_readme.html#TextCodes More information (English)]

== Add dialog to Level editor ==
=== Open the location file (level editor) ===
# Open the folder ''Game''/ then '''FT Improver.EXE'''.{{Warning|Use '''FT Tools.exe''' instead will result in an error.}}
# Pass the videos by clicking on them.
# Click on {{False button|MORE|color=black|button=yes}}.
# Click {{False button|LEVEL EDITOR|color=black|button=yes}}.
# Navigate to the {{False button|File|color=gray|border=black}} menu then {{False button|Open|color=gray}}.
# Open the file of the location previously created which must end with ''.mis''.

=== Add the dialog ===
# Click on the {{False button|Level|color=black2}} tab.
# Click on the {{False button|Speech...|color=gray|border=black}} button at the bottom.
# Click on the {{False button|Add|color=gray|edge=black}} button at the top.
# Scroll left to the bottom of the list.
# Click on {{False button|New Node|color=black}} and replace the "New Node" with the code name of your first portion of the dialog under the {{False button|Remove|color=gray|edge=black}} button.
#* {{False button|✔&nbsp;&nbsp;&nbsp;&nbsp;Floating&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|color=black2}}''(checked by default):'' floats the dialog over the character's head.
#* {{False button|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Windowed&nbsp;&nbsp;&nbsp;&nbsp;|color=black2}}'':'' adds the dialog in a box at the bottom of the screen with the character's portrait and a {{False button|OK|color=white|button=yes}} button.
# Add the code name of the dialog under {{False button|Default Event|color=gray}} (for scripts).
# Select the dialog code to the right of {{Fake button|Random 1|color=gray}}.{{Idea|When you add the floating dialogs ''Rdm1'' to ''6'', you can add all 6 of them one after the other. The game will display them randomly}}

=== Scripting dialogue (advanced) ===
Coding a dialog inside the [[Mod:Editors#Level_editor]] requires a lot of scripting. Refer to the [[Mod:Scripts]] section for the basics of coding in the Level editor.

==== Prepare the code to be added ====
The [https://docs.google.com/spreadsheets/d/18ThIXbzwQTrOZfpMNC0ySB2-eH5YKY_HKtT3xwHx6OM/edit#gid=0 table here] allows you to know in advance the most complex codes to use to program your dialog, according to a number of special pre-determined conditions (e.g. the player refuses to help, tries to seduce the other character, is threatening, etc.)

==== Code the first portion of the dialog ====
{{Warning|The section {{False button|Triggers...|color=gray|bord=black}} of the level editor contains a very large number of triggers, added over the years. '''Avoid editing them unless you know exactly what you are doing.''' Don't be intimidated by this list, you don't have to interact with it; just add your code to the end of it using the scroll bar to get to the end quickly}}
# Click on the {{False button|Level|color=black2}} tab.
# Click on the {{False button|Triggers...|color=gray|border=black}} tab at the bottom left.
# Click on {{False button|New...|color=gray|edge=black}}.
# Add a description (example: ''PERS1 - Acc'')
# The tab {{False button|✔&nbsp;Conditions|color=black2}} is already open. Click on {{False button|New...|color=gray|border=black}}.
# The {{False button|Always|color=black2}} condition is already selected. Click on {{False button|Ok|color=gray|edge=black}} at the bottom right.
# Click on the {{False button|&nbsp;Actions|color=black2}} tab. It changes to {{False button|✔&nbsp;Actions|color=black2}}.
# Click on {{False button|New...|color=gray|border=black}}.
# Click on the {{False button|Center View|color=black2}} tab and select {{False button|Set Click Speech|color=black2}}.
# Under {{Faux Button|Set Click Speech for Unit|color=gray}}, click {{False button|list...|color=gray|bord=black}} and select the code name of the character you want to speak. If you have not added a character already, [[Mod:Create_a_location#Add_a_character|follow these steps]].
# Under {{False button|to|color=gray}}, select the dialog code you previously embedded.
# Click {{False button|Ok|color=gray|bord=black}}{{Idea|At any time, double-clicking on an item in the trigger list allows you to open it to edit it}}

==== Code the other portions of the dialogue ====
The following dialogue portions will no longer use the ''Always'' condition, but will all require a special condition to appear.
# Click on the {{False button|Level|color=black2}} tab.
# Click on {{False button|Triggers...|color=gray|border=black}} at the bottom left.
# Click on {{False button|New...|color=gray|edge=black}}.
# Add a description (example: ''PERS1 - 01'')
# The tab {{False button|✔&nbsp;Conditions|color=black2}} is already open. Click on {{False button|New...|color=gray|border=black}}.
# Click on the {{False button|Always|color=black2}} tab and select {{False button|Speech Occured|color=black2}}, then under {{False button|Speech Event was|color=gray}}, select the portion of the dialog that you coded before.
# Click on the {{False button|&nbsp;Actions|color=black2}} tab. It changes to {{False button|✔&nbsp;Actions|color=black2}}.
# Click on {{False button|New...|color=gray|border=black}}.
# Click on the {{False button|Center View|color=black2}} tab and select {{False button|Set Click Speech|color=black2}}.
# Under {{False button|Set Click Speech for Unit|color=gray}}, click {{False button|list...|color=gray|bord=black}} and select the code name of the character you want to re-speak.
# Under {{False button|to|color=gray}}, select the code for the next section of the dialog.
# Press {{False button|Ok|color=gray|edge=black}}{{Idea|This step completed, after the first dialog, clicking on the character again will start a new dialog.}}

==== Code a player response or a sequence of interactions ====
It is possible to code a series of interactions that appear automatically after a portion of the dialog (after the dialog button is clicked).
# Click on the {{False button|Level|color=black2}} tab.
# Click on the {{False button|Triggers...|color=gray|border=black}} tab at the bottom left.
# Click on {{False button|New...|color=gray|edge=black}}.
# Add a description (example: ''PERS1 - 01R'')
# The {{False button|✔&nbsp;Conditions|color=black2}} tab is already open. Click on {{False Button|New...|color=gray|border=black}}.
# Click on the {{False button|Always|color=black2}} tab and select {{False Button|Speech Occured|color=black2}}, then under {{False Button|Speech Event was|color=gray}}, select the portion of the dialog that will be responded to.
# Click on the {{False button|&nbsp;Actions|color=black2}} tab. It will change to {{False button|✔&nbsp;Actions|color=black2}}.
# Click on {{False button|New...|color=gray|border=black}}.
# Click on the {{False button|Center View|color=black2}} tab and select {{False Button|Set Variable|color=black2}}.
# Under {{False button|Variable|color=gray}}, type, for example: ''Pers1_message''.
# Under {{False button|&nbsp;&nbsp;Value|color=gray}}, type, for example: ''AccR''.
# Press {{False button|Ok|color=gray|bord=black}}
# Click {{False button|New...|color=gray|edge=black}}.
# Add a description (example: ''PERS1 - 01R (message)'')
# The {{False button|✔&nbsp;Conditions|color=black2}} tab is already open. Click on {{False Button|New...|color=gray|border=black}}.
# Click on the {{False button|Always|color=black2}} tab and select {{False Button|Variable|color=black2}}, then under {{False Button|Variable|color=gray}} type in the variable you just chose, then under {{False Button|is Value|color=gray}} type in the value you just chose.
# Click on the {{False button|&nbsp;Actions|color=black2}} tab. It will change to {{False Button|✔&nbsp;Actions|color=black2}}.
# Click on {{False button|New...|color=gray|border=black}}.
# Click on the {{False button|Center View|color=black2}} tab and select {{False Button|Force Speech|color=black2}}.
# Under {{Faux button|Unit|color=gray}}, click {{Faux Button|list...|color=gray|bord=black}} and select the code name of the character who will be responding. If it is the player, type "ThePlayer" instead.
# Under {{False button|will use speech node|color=gray}}, select the code for the section of the dialog that corresponds to the response.
# Check the {{False button|Blocking|color=black2}} box in the upper right corner.
# Repeat the steps from '''18''' to add all the portions of dialogs that you want. They will all follow each other.
# Press {{False button|Ok|color=gray|border=black}}

==== Code a portion of the dialog that depends on a condition ====
When you add a condition, you can always add a number of additional conditions that must all be true for the script to activate the intended dialog portion.
This allows you, for example, to create a specific dialog portion if the player has an intelligence score < 5 and another if their score is >= 5. If you don't consider all the possibilities, nothing may happen if the player doesn't have the necessary characteristics.
To code a response that appears only if the player-character has at least 5 intelligence, follow all the steps in [[Mod:Create_a_dialogue#Code a player response or a sequence of interactions|the previous portion]], but add these after step ''6'':
# Click on {{False button|New...|color=gray|border=black}}.
# Click on the {{False button|Always|color=black2}} tab and select {{False button|Quantity - Unit|color=black2}}, then under {{False button|Unit|color=gray}}, type "TheGamer", then under {{False button|has|color=gray}}, click on {{False button|Change|color=gray|edge=black}} Click on {{False button|More than|color=black2}} and enter the value "4" to the right of the {{False Button|Num|color=gray}}. Press {{False button|Ok|color=gray|bord=black}}
# Under {{False button|type|color=gray}} click {{False button|change|color=gray|edge=black}} then select {{False button|Status|color=black2}}. Click on {{False button|strength|color=black2}} to the right and change it to {{False button|intelligence|color=black2}}. Press {{False button|Ok|color=gray|border=black}}.