How to use TLKTool
==================

TLKTool is windows only.
You need Framework 3.5 to run TLKTool.
You can download it in windows update center if you don't have it already installed.

This tool is for modding purpose.



Simple conversion : Unicode .txt file to multiple .tlk files
============================================================

This part of the tool allow you to convert an hand made .xls file into several talk table.
One talk table is create for each language column in your .xls file.

- Step 1 :
Create a .xls file following the example provided in this archive. (my_mod.xls)
The first column is the stringID, then 1 column per language.

- Step 2 :
Export your .xls file into an Unicode .txt file (Unicode is very important).
The export function is available in Excel, select "Save As" option.

- Step 3:
Drag and drop your created unicode .txt file into the TLKTool window. Over the GREEN arrow.

- Step 4:
You will get your .tlk files into the folder you specified in the .xls file.



Text research : Get strings from Core .tlk files
================================================

This part of the tool allow you to get strings from core talk table.
If you have 100 core stringID and want to know what are these string in one or several languages, this part is for you.

- Step 0 :
You need all Core .tlk files in the same folder as TLKTool
Core .tlk files are :
core_cs-cz.tlk
core_de-de.tlk
core_en-us.tlk
core_es-es.tlk
core_fr-fr.tlk
core_hu-hu.tlk
core_it-it.tlk
core_pl-pl.tlk
core_ru-ru.tlk

If don't have some of them, be sure that you remove the language column in the .xls file as well.

- Step 1 :
Create a .xls file following the example provided in this archive. (my_mod.xls)
I repeat, delete the languages columns you don't have the core .tlk file.
Contrary to the conversion part of the tool, you need to keep the .xls file empty but only the string IDs.

- Step 2 :
Export your .xls file into an Unicode .txt file (Unicode is very important).
The export function is available in Excel, select "Save As" option.

- Step 3:
Drag and drop your created unicode .txt file into the TLKTool window. Over the RED arrow.
It takes time to process the file. The window of TLKTool will probably freeze. Wait for it.

- Step 4:
You will get a new .txt file which has been fulfilled.
Open this .txt with Excel.



HOW TO
======
I am not a modder but want to translate a mod :

You have to find the stringID used by this mod. You can ask to the author or find them in his .tlk files.
How to find .tlk files in the mod archive, and how to read this file is your business :)

You also have to know the "name" of the .tlk files. If the mod already contain a file named X_en-us.tlk, the name is X.
Once you have the list of string ID, follow the first part of this tutorial.

The will have to enter all string IDs in the first column of the .xls file. And all talk table names in the first line of the .xls file.
The first cell is the output directory, don't forget the ending "/".