Editing Mod:Modify the worldmap

[[file:Ecran Campaign Editor.jpg|thumb|This tutorial uses mainly the Campaign editor.]]
This tutorial will explain how to modify the [[The Sum:Worldmap|Worldmap]] of ''The Sum'': Add, place, hide/unhide a location.

== Required Tools ==
* [[Mod:Editors#Campaign_editor|Campaign editor]]
* [[Mod:Editors#Notepad.2B.2B|Notepad++]]

== Before You Begin ==
Take some time to learn how the game editor works by checking out the [http://10projets.org/nousaurons/editor_readme.html#Section1 readme file of the Fallout Tactics editor]. {{Warning|The game is referred to as "Campaign" and the locations as "Missions" in the document}}

== Add a new location ==
Before adding a new location to the [[Worldmap]], it is best to [[Mod:Create a location|create one (follow the instructions here)]].
=== Add the location to the '''campaign.txt''' list === 
# Open the folder ''Game/core/campaigns/'' then '''campaign.txt'''.
# In '''campaign.txt''', press {{False button|ctrl|color=white}}+{{False button|f|color=white}} and search for "cores = {"
# Follow the list to the end: "}".{{Warning|Do not add a location anywhere other than the end of the list, or this will destroy the placement of all subsequent locations in the list.}}
# Just before the "}" symbol, copy/paste the following code: <syntaxhighlight>
"missions/location_code_name_to_add.mis;location_code_name_to_add;size;state;false", //Comments
</syntaxhighlight>
* '''size:''' Size of the green circle on the map (''10'' = Small; ''20'' = Medium; ''25'' = Medium (Occupied); ''40'' = Large (Community)).
* '''Status:''' Visibility of the location (''uncovered'' = Visible; ''covered'' = Hidden (revealed by a script); ''visited'' = Visible and added to the list of locations on the right).
* '''false:''' Option not used. Leave the option at ''false''.

=== Add the location to the list of '''generic_mission.txt''' === 
# Open the folder ''Game/NousAurons/locale/game/'' then '''generic_mission.txt'''. (French version) 
# Press {{False button|ctrl|color=white}}+{{False button|f|color=white}} and search for "// NOM DES LIEUX"
# Directly below, copy/paste the following code: <syntaxhighlight>
place_name = {Name of the location in French}
</syntaxhighlight>
# Open the folder ''Game/core/locale/game/'' then ''generic_mission.txt''. (english version)
# Press {{False button|ctrl|color=white}}+{{False button|f|color=white}} and search for "// NOM DES LIEUX"
# Directly below, copy/paste the following code: <syntaxhighlight>
place_name = {Name of the location in English}
</syntaxhighlight>

=== Add the location to the Campaign editor ===
# Open the folder ''Game/'' and then ''FT Tools.EXE''.{{Warning|Never use ''FT Improver.exe'' to edit the map. Strange bugs will occur}}
# Click on {{False button|OK|color=white|button=yes}}.
# Click {{False button|GAME EDITOR|color=black|button=yes}}.
# Go to the {{False button|File|color=gray|border=black}} menu then {{False button|Open|color=gray3}}.
# Open the file ''bos.cam'' located in ''core/campaigns/''.
# Go to the menu {{Fake button|Tools|color=gray|border=black}} then {{Fake button|Import Core|color=gray3}} (the place will be added).
# Click on the {{False button|Core|color=black2}} tab.
# Select your location from the list on the left, then click on the chosen location on the [[Worldmap]] to place it.
# Navigate to the {{False button|File|color=gray|border=black}} menu and then {{False button|Save|color=gray3}}.

== Move a location ==
=== Move the location in the Campaign editor ===
# Open the folder ''Game/'' and then ''FT Tools.EXE''.{{Warning|Never use ''FT Improver.exe'' to edit the map. Strange bugs will occur}}
# Click on {{False button|OK|color=white|button=yes}}.
# Click {{False button|GAME EDITOR|color=black|button=yes}}.
# Go to the {{False button|File|color=gray|bordure=black}} menu then {{False button|Open|color=gray3}}.
# Open the file ''bos.cam'' located in ''core/campaigns/''.
# Click on the tab {{Fake button|Core|color=black2}}.
# Select the location to be moved from the list on the left, then click on the new location you have chosen on the [[Worldmap]].
# Navigate to the {{False button|File|color=gray|border=black}} menu and then {{False button|Save|color=gray3}}.

== Add a random encounter ==
[[File:Random.jpg|thumb|Campaign Editor ''Random'' tab]]
=== Add the encounter to the list of ''encounters.txt'' === 
# Open the folder ''Game/NousAurons/locale/game/'' then '''encounters.txt''' (French version)
# Copy/paste the following code: <syntaxhighlight>
encounter_code_name = {Name of the encounter in French}
</syntaxhighlight>
# Open the folder ''Game/core/locale/game/'' then ''encounters.txt''.
# Copy/paste the following code: <syntaxhighlight>
encounter_code_name = {Name of the encounter in English}
</syntaxhighlight>

=== Add the encounter to the list of ''campaign.txt'' === 
# Open the folder ''Game/core/campaigns/'' then ''campaign.txt''.
# In ''campaign.txt'', press {{False button|ctrl|color=white}}+{{False button|f|color=white}} and search for "forces = {"
# Follow the list to the end: "}".{{Warning|Do not add an encounter anywhere else but at the end of the list, as this will destroy all existing encounters on the map.}}
# Just before the "}" symbol, copy/paste the following code: <syntaxhighlight>
	{ "encounter_code_name;alignment;min;max;active;A",	
	  "entities/Actors/___RANDOM/entity_name.ent;number;chance",
	  "entities/Actors/___RANDOM/entity_name.ent;number;chance",
	},
</syntaxhighlight>
* '''encounter_code_name:''' Code name of the encounter (avoid spaces).
* '''alignment:''' Behavior of characters encountered ("good" = friendly; "bad" = hostile; "critter" = hostile, but less organized).
* '''min:''' Minimum number of character placement attempts (luck).
* '''max:''' Maximum number of character placement attempts (luck).
* '''active :''' Encounter active or not (true = active; false = requires a script to work)
* '''A :''' Unused. Leave at "A".
* '''entity_name:''' File name of the character to be added, stored in ''Game/core/entities/Actors/___RANDOM/'' in '''.ent''' format.
* '''number:''' Number of characters appearing if the ''luck'' check succeeds.
* '''chance:''' Chance in 100 that a number of characters determined by ''number'' will appear. The number of attempts is randomly determined between "min" and "max".

=== Add the encounter to the Campaign editor ===
# Open the folder ''Game/'' and then ''FT Tools.EXE''.{{Warning|Never use ''FT Improver.exe'' to edit the map. Strange bugs will occur}}
# Click on {{False button|OK|color=white|button=yes}}.
# Click {{False button|GAME EDITOR|color=black|button=yes}}.
# Go to the {{False button|File|color=gray|bordure=black}} menu then {{False button|Open|color=gray3}}.
# Open the file ''bos.cam'' located in ''core/campaigns/''.
# Go to the menu {{Fake button|Tools|color=gray|border=black}} then {{Fake button|Import Random|color=gray3}} (the meeting will be added).
# To the right of the tabs, change the {{False button|5&nbsp;|color=black2}}{{False button|5&nbsp;|color=black2}}{{False button|5&nbsp;|color=black2}} boxes to choose your placement "brush" ({{1st}} number = length boxes; 2{{nd}} number = height boxes; 3{{rd}} number = chance to trigger the encounter) {{Warning|Keep the 3{{rd}} digit low (less than 5) to prevent the game from being interrupted too often by random encounters.}}
# Click on the {{False button|Random|color=black2}} tab.
# Select your encounter from the list on the left, then click on the chosen location on the map to place it. Each time you click, an encounter chance is added according to the "brush" chosen above.{{Idea|You can display the total encounter chance for each box by checking the "Show Totals" option in the "View" menu}}
# Go to the {{False button|File|color=gray|border=black}} menu and then {{False button|Save|color=gray3}}.

== Add a special encounter ==
A special encounter (or event) is a hidden location that can be opened by moving around the [[Worldmap]]. Before adding this place to the [[Worldmap]], it is best to [[Mod:Create a location|create it (follow the instructions here)]].

=== Add the encounter to the list of ''campaign.txt'' === 
# Open the folder ''Game/core/campaigns/'' then '''campaign.txt'''.
# In '''campaign.txt''', press {{False button|ctrl|color=white}}+{{False button|f|color=white}} and search for "specials = {"
# Follow the list to the end: "}".{{Warning|Do not add a location anywhere other than the end of the list, as this will destroy the placement of all locations in the list.}}
# Just before the "}" symbol, copy/paste the following code: <syntaxhighlight>
       "missions/special/special_encounter_code_name.mis;special_encounter_code_name;size;true;true",
</syntaxhighlight>
* '''special_encounter_code_name:''' Code name of the special meeting (avoid spaces).
* '''size:''' Size of the green circle on the map once the encounter has passed (''10'' = Small; ''20'' = Medium; ''25'' = Medium (Busy); ''40'' = Large(Community)).
* '''true:''' These two options cause different bugs. It is better to leave them at ''true''.

=== Add the special encounter to the Campaign editor ===
# Open the folder ''Game/'' and then ''FT Tools.EXE''.{{Warning|Never use ''FT Improver.exe'' to edit the map. Strange bugs will occur}}
[File:Special.jpg|thumb|Campaign Editor ''Special'' tab]]
# Click on {{False button|OK|color=white|button=yes}}.
# Click {{False button|GAME EDITOR|color=black|button=yes}}.
# Go to the {{False button|File|color=gray|bordure=black}} menu then {{False button|Open|color=gray3}}.
# Open the file ''bos.cam'' located in ''core/campaigns/''.
# Go to the menu {{Fake button|Tools|color=gray|border=black}} then {{Fake button|Import Special|color=gray3}} (the special meeting will be added).
# To the right of the tabs, change the {{False button|5&nbsp;|color=black2}}{{False button|5&nbsp;|color=black2}}{{False button|5&nbsp;|color=black2}} boxes to choose your placement "brush" ({{1st}} number = length boxes; 2{{th}} number = height boxes; 3{{th}} number = chance to trigger the encounter) {{Idea|Place the 3{{rd}} digit at "25" or less.}}
# Click on the {{False button|Special|color=black2}} tab.
# Select your special encounter from the list on the left, then click on the chosen location on the card to place it. Each time you click, an encounter chance is added according to the "brush" chosen above.{{Idea|You can display the total encounter chance for each box by checking the "Show Totals" option in the "View" menu}}
# Go to the {{False button|File|color=gray|border=black}} menu and then {{False button|Save|color=gray3}}.