Permalink
Browse files

DEVTOOLS: Documentation of lang descr switch

Also a small fix for the help mode of quoteSpreadsheetCreator tool
  • Loading branch information...
antoniou79 authored and sev- committed Jan 1, 2019
1 parent 234cdf1 commit c9ddbeda535d490799f75897c43779b0efc5bcc4
@@ -31,14 +31,17 @@ Syntax Notes:
1. The "-op" switch should be followed by the path to the folder where the WAV files should be exported; This folder path will also be used as input when the output Excel will be created (for the "INGQUO_E.TRE" sheet with the in-game quotes).
2. The "-ip" switch should be followed by the path to the game's folder, where the TLK and MIX files reside.
3. The "-ian" optional switch is followed by the path to the actornames.txt file -- if this is omitted then the file is assumed to reside in the current working directory.
4. Using the "-xwav" optional switch, this tool will export __ALL__ game's audio files (AUD) (that are either speech or speech-related) in a WAV format. This is expected to run for a few minutes and take up quite a lot of your HDD space (about 650MB).
5. Using the "-xtre" optional switch, the tool will add a sheet to the output Excel with the contents of each of the game's Text Resource files (TRE).
6. You may use both, either or neither of the "-xwav" and "-xtre" switches, depending on what you need to do.
7. The "--trace" optional switch enables extra debug messages to be printed.
4. The "-ld" optional switch is followed by a language description for the language of the game you are exporting Text Resources from. This switch is meaningful when you also use the "-xtre" switch to export Text Resource files.
* Valid language values are: EN_ANY, DE_DEU, FR_FRA, IT_ITA, RU_RUS, ES_ESP
* Default language value is: EN_ANY (English)
5. Using the "-xwav" optional switch, this tool will export __ALL__ game's audio files (AUD) (that are either speech or speech-related) in a WAV format. This is expected to run for a few minutes and take up quite a lot of your HDD space (about 650MB).
6. Using the "-xtre" optional switch, the tool will add a sheet to the output Excel with the contents of each of the game's Text Resource files (TRE).
7. You may use both, either or neither of the "-xwav" and "-xtre" switches, depending on what you need to do.
8. The "--trace" optional switch enables extra debug messages to be printed.

Usage:
```
python2.7 quoteSpreadsheetCreator.py -op folderpath_for_extracted_wav_Files [-ip folderpath_for_TLK_Files] [-ian pathToActorNamesTxt] [-m stringPathToReplaceFolderpathInExcelLinks] [-xwav] [-xtre] [--trace]
python2.7 quoteSpreadsheetCreator.py -op folderpath_for_extracted_wav_Files [-ip folderpath_for_TLK_Files] [-ian pathToActorNamesTxt] [-m stringPathToReplaceFolderpathInExcelLinks] [-ld languageDescription] [-xwav] [-xtre] [--trace]
```
The tool __requires__ a valid path to the actornames.txt file; this file is included in the samples folder.

@@ -717,7 +717,7 @@ def main(argsCL):
print "The -ian switch is followed by the path to actornames.txt, if it's not in the current working directory."
print "The -m switch has an argument that is a replacement string for the path to the folder of extracted WAV files which will be used as a prefix for the links in the output XLS file."
print "The -ld switch has an argument that is the language description of the original game files that you use as input."
printInfoMessageForLanguageSelection()
printInfoMessageForLanguageSelectionSyntax()
print "The -xwav switch enables the WAV audio extract mode from the TLK files. It requires an INPUT path to be set with the -ip switch."
print "The -xtre switch enables the TR%s parsing mode from the original MIX files. It requires an INPUT path to be set with the -ip switch." % (gActiveLanguageDescriptionCodeTuple[1])
print "The --trace switch enables more debug messages being printed during execution."

0 comments on commit c9ddbed

Please sign in to comment.