All language content in Cold Waters is available in txt files.

Full Localisation of Cold Waters:
With your help, we can make Cold Waters available for other languages. Please contact us if you intend to make a full localisation so that we can add in-game support that language if needed as well as add any new fonts required and let you know if others are working on that same language.

WARNING: Be sure to make your language edits in the override folder and back then up to another location so as not to have them overwritten by a Steam update.

Special Characters
Be sure that text files are saved with UTF-8 encoding with no Unicode Signature BOM. This will ensure that special characters will be read and displayed by the game correctly. For example: á, é, í, ó, ú, ñ, Ñ

Right Of Equals Only
When editing content, only ever change values to the RIGHT of an equals sign "=". Values to the left used by the game to identify the content.

Special Tags <UPPERCASE> and [SomeText]
Many texts use tags which the game will replace with dynamic content. These tags should NOT be translated and need to remain in place. In addition tags <n> and /n are new line breaks.

Line Breaks
Be careful when using enter to add line breaks. In some cases it will add a blank line that could introduce a bug. If you want a line break within the text, use <n> or \n.

Language Folders
There is one language folder in the parent folder which contains all language for the game interface and generic content: default/language_en

In addition, each campaign has its own language folder containing all language specific to each campaign: default/campaign/campaign00X/language_en

No files outside of these folders should need to be edited. Please contact us if you feel you need to translate any text outside these folders and we'll move that content into the appropriate language folder instead.

This folder contains the following subfolders:
aircraft
campaign
dictionary
help
message
mission
sensor
subsystem
training
vessel
weapon

Remember that special tags <UPPERCASE> [SomeText] should not be edited.

aircraft Individual files, one per aircraft with descriptions used in the Unit Reference.

campaign
/campaigns.txt Single file containing a list of names for each campaign. The order of this list must correspond to the ordering of the campaign00X folders.

dictionary
/dictionary_interface All menu and HUD text.
/dictionary_message_log Crew message log text as well as audio references.

help
Contains the text content for all help chapters.
/HelpBookmarks.txt lists the scroll values for opening the help at particular sections, does not need translating.

message
Contains several files with text for mission briefings, their header content and action reports.

mission
/missions_single.txt is a list of mission names as displayed in the menu of single missions. Order of missions listed must be maintained and correspond to the mission number.
/single00X Is the descriptive text for that mission as shown in the Single Mission menu.

sensor
/sensor_display_names.txt single file containing the display names of the various sonar and radar sensors. Order of listed sensors must be maintained and correspond to the order that sensors are defined in default/sensors.txt

subsystem
/subsystem_display_names.txt single file containing the display names of the various subsystems as shown in damage control. Order of listed subsystems must be maintained and correspond to the order that subsystems are defined in default/subsystems.txt

training
/missions_training.txt is a list of training mission names as displayed in the menu of training missions. Order of missions listed must be maintained and correspond to the training mission number.
/training_accident.txt text displayed if you manage to lose your sub during a training mission.
/training00X.txt Is the descriptive text for that mission as shown in the Training Mission menu.
/training_menu_X.txt Is the tutorial text during the menu screens prior to mission start. Be wary of special tags including those in <> and [].
/training_combat_X.txt Is the tutorial text during the mission itself. Be wary of special tags including those in <> and [].

vessel Individual files, one per vessel with descriptions used in the Unit Reference as well as player vessel class names and hull numbers for that class.

weapon Individual files, one per weapon with descriptions used in the Unit Reference.

This folder contains all the language components specific to an individual campaign.

It contains the following folders and text files:
events
missions
campaign_map_data.txt
description.txt
waypoints_region_names.txt
waypoints_sea_names.txt

Remember that special tags <UPPERCASE> [SomeText] should not be edited.

campaign_map_data.txt
Contains a list of locations and labels for the strategic map.
LocationName=Holy Loch=Scotland Only translate the values in italics and the order of the location names must be maintained and correspond to the order the locations are defined in default/campaign/campaign00X/campaign_data.txt.
The regions specified must correspond to the regions in waypoints_region_names.txt listed after "Regions=".
LabelName=Holy Loch these are the labels placed on the map for locations, countries and oceans/seas.

description.txt
The text description of the campaign that appears in the campaign selection menu.

waypoints_region_names.txt
Defines a list of all regions for the land war, then each zone name and the region it belongs to is defined. The order that zones are defined in must correspond to the order they are defined in default/campaign/campaign00X/waypoints_region.txt
Each region defined for each zone must appear in the "Regions=" list at the top of the file.

waypoints_sea_names.txt
Simple list of display names for all waypoints/areas of the sea. The order these are in must be maintained and corresponds to their order in default/campaign/campaign00X/waypoints_sea.txt

Missions Folder
missions/MISSION_TYPE_X.txt
These files correspond to each mission in the campaign. They define the orders as well as the mission win/fail/missed messages. The ordering of the mission win/fail/missed messages must be maintained. Beware of <> and [] special tags which should not be edited.

Events Folder
events/eventname.txt
All of the txt files in the events folder correspond to individual events. The only fields needing translation are:
Title= (separating numerous titles with "|" will choose one of the titles at random.
Sentence1=
Sentence2=

Beware of tags <> and [] as well as \n for new lines and <b></b> for bold and <i></i> for italics.

events/content/aftermission_win.txt
When winning a mission, the game will select a random line from this list to display as the radio message.

events/content/aftermission_fail.txt
When failing a mission, the game will select a random line from this list to display as the radio message.

events/content/combatants.txt
Defines the special tags as listed. For example:
FRIENDLY=NATO|Allied forces|Allies|West
Defines the <FRIENDLY> special tag as containing one of the elements listed. When <FRIENDLY> is encountered in any other txt file, it will be replaced by one of the elements separated by "|". In this case NATO, Allied forces, Allies or West.

events/content/ending_captured.txt
Text displayed when campaign is over and player is captured.
Will choose a random line, therefore do not use "enter" except to add a new line. Use <n> or \n for an in-line line break.

events/content/ending_critical_fail.txt
Text displayed when campaign is over and player failed outright.
Will choose a random line, therefore do not use "enter" except to add a new line. Use <n> or \n for an in-line line break.

events/content/ending_draw.txt
Text displayed when campaign is over and outcome is a draw.
Will choose a random line, therefore do not use "enter" except to add a new line. Use <n> or \n for an in-line line break.

events/content/ending_fail.txt
Text displayed when campaign is over and player failed.
Will choose a random line, therefore do not use "enter" except to add a new line. Use <n> or \n for an in-line line break.

events/content/ending_lost_at_sea.txt
Text displayed when campaign is over and player is lost at sea.
Will choose a random line, therefore do not use "enter" except to add a new line. Use <n> or \n for an in-line line break.

events/content/ending_no_vessels
Text displayed when campaign is over and there are no more player submarines available.
Will choose a random line, therefore do not use "enter" except to add a new line. Use <n> or \n for an in-line line break.

events/content/ending_win
Text displayed when campaign is over and player has won.
Will choose a random line, therefore do not use "enter" except to add a new line. Use <n> or \n for an in-line line break.

events/content/patrol_outcomes
Message displayed at the bottom of the patrol summary page when returning to port.
There are 5 lines (enter separates them) and each line has 5 elements separated by "|".
You may add as many lines as you like, but each line must consist of:
Best Outcome|Good Outcome|Moderate Outcome|Poor Outcome|Very Poor Outcome

Text for the general land war events is a little more complex and warrants its own section.
Files for the land war are:

events/content/takeover.txt
This file is made up of blocks and various blocks are used depending on what is going on.

ENEMY or FRIENDLY determines which side is doing what just happened.
INVASION or LIBERATED determines whether the side took over a territory it does not own, or recaptured a territory it once owned.
INITIAL, PARTIAL or TOTAL determines how much of a region is effected. If only one zone of a region is invaded, it is initial, if all zones in a region are invaded, it is total. This is reversed for liberated, such that if all zones are liberated, it is initial and if only one zone is liberated, it is total. Partial is somewhere in the middle for both invasion and liberation.

LAND, SEA or AIR determines by what route the zone was effected.

TITLE: these lines define the newspaper headlines. They are separated by "|" and the game will randomly choose one.

Likewise for all other blocks, the game will determine whether it is ENEMY or FRIENDLY, INVADED or LIBERATED, what route was taken and how much of the overall region is effected. It will then choose the appropriate block and select one of the "|" separated elements. It will then populate the special tags of that element.

events/content/invasion_second.txt
Replaces the special tag <INVASION_SECOND> with a randomly chosen line from this file.

events/content/liberation_second.txt
Replaces the special tag <LIBERATION_SECOND> with a randomly chosen line from this file.

events/content/warstatus1.txt
The bottom part of the newspaper is made up of two sentences that describe the overall balance of the land war. For the first sentence, the game will randomly select one of the lines in this file with the format:
Player Winning|Draw|Player Losing

events/content/warstatus2.txt
The bottom part of the newspaper is made up of two sentences that describe the overall balance of the land war. For the second sentence, the game will randomly select one of the lines in this file with the format:
Player Winning|Draw|Player Losing

events/content/impasse - NOT USED
Intended for events where neither side gains ground, but these events are no longer displayed as deemed unnecessary.