diff options
Diffstat (limited to 'devtools/create_bladerunner/subtitles/README.md')
| -rw-r--r-- | devtools/create_bladerunner/subtitles/README.md | 90 |
1 files changed, 45 insertions, 45 deletions
diff --git a/devtools/create_bladerunner/subtitles/README.md b/devtools/create_bladerunner/subtitles/README.md index 6df5849c1f..ed0ebd0419 100644 --- a/devtools/create_bladerunner/subtitles/README.md +++ b/devtools/create_bladerunner/subtitles/README.md @@ -21,28 +21,28 @@ C:\Westwood\Blade Runner\AUDIO_FRA\ ``` 6. Export all speech audio from the game and create an Excel file (xls) with links to the audio files. - * You will need to have some free HDD space for this step (around 650MB). + * You will need to have some free HDD space for this step (around 650MB). - * Using a command line interface (eg MSYS2) navigate to the ScummVM repository folder and issue a command like the one below, making sure you specify the correct target language code for your requirements; supported language codes are "EN\_ANY" for English, "FR\_FRA" for French, "DE\_DEU" for German, "IT\_ITA" for Italian, "ES\_ESP" for Spanish and "RU\_RUS" for Russian (version by Fargus Multimedia). + * Using a command line interface (eg MSYS2) navigate to the ScummVM repository folder and issue a command like the one below, making sure you specify the correct target language code for your requirements; supported language codes are "EN\_ANY" for English, "FR\_FRA" for French, "DE\_DEU" for German, "IT\_ITA" for Italian, "ES\_ESP" for Spanish and "RU\_RUS" for Russian (version by Fargus Multimedia). - * In the following example we assume we need to export the audio from the French version of the game. This could take a few minutes to complete. Please refer to the [quotesSpreadsheetCreator](#quotesspreadsheetcreator-quotespreadsheetcreatorpy) section of this document for more command-line options for this tool. + * In the following example we assume we need to export the audio from the French version of the game. This could take a few minutes to complete. Please refer to the [quotesSpreadsheetCreator](#quotesspreadsheetcreator-quotespreadsheetcreatorpy) section of this document for more command-line options for this tool. ``` python2.7 devtools/create_bladerunner/subtitles/quotesSpreadsheetCreator/quoteSpreadsheetCreator.py -op "/c/Westwood/Blade Runner/AUDIO_FRA" -ip "/c/Westwood/Blade Runner" -ian "devtools/create_bladerunner/subtitles/common/actornames.txt" -xwav -ld FR_FRA ``` 7. When you've completed the above step, an Excel file should be created in your current folder, named "out-French.xls". Open this file with a spreadsheet editor app (tested with Microsoft Excel 2007 and LibreOffice Calc 6.2.4) and select the "INGQUO_#.TR#" sheet. - * Please keep the column A ("Filename") as is. Do not modify the contents of this column. + * Please keep the column A ("Filename") as is. Do not modify the contents of this column. - * Edit column B ("Quote") to put in the text for your transcript of the corresponding audio file + * Edit column B ("Quote") to put in the text for your transcript of the corresponding audio file - * Use column G ("ShortHandFileName") to play the audio file for the quote to be transcribed in the same line. You should be able to double click in MS Excel or Ctrl+Click on the specific cell; an audio player will be launched automatically to play the audio file. + * Use column G ("ShortHandFileName") to play the audio file for the quote to be transcribed in the same line. You should be able to double click in MS Excel or Ctrl+Click on the specific cell; an audio player will be launched automatically to play the audio file. - * Note that the columns used by the tool that will create the final subtitles file are only columns A and B. + * Note that the columns used by the tool that will create the final subtitles file are only columns A and B. 8. The rest of the sheets in the Excel file, excluding the "SBTLVERS.TRE" which contains versioning info) are the sheets for the video cutscenes. We don't provide links to the audio cues for those subtitles, but we do provide the timings for the English version of these scenes which you can use as a guide, along with the English transcript available online here: <https://docs.google.com/spreadsheets/d/17ew0YyhSwqcqZg6bXrIgz0GkA62dhgViHN15lOu5Hj8/edit?usp=sharing> - * Note that the important columns used by the tool that will create the final subtitles file are in this case only columns A ("Frame Start"), B ("Frame End") and C ("Subtitle"). + * Note that the important columns used by the tool that will create the final subtitles file are in this case only columns A ("Frame Start"), B ("Frame End") and C ("Subtitle"). - * Fill in column C with the subtitle text, and set the values in columns A and B to adjust when the subtitle should start and when it should stop being displayed respectively. + * Fill in column C with the subtitle text, and set the values in columns A and B to adjust when the subtitle should start and when it should stop being displayed respectively. 9. You may edit the info in the "SBTLVERS.TRE" sheet to fill in the credits and a version number for your transcript. @@ -94,9 +94,9 @@ Syntax Notes: 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. 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, ES\_ESP, RU\_RUS + * Valid language values are: EN\_ANY, DE\_DEU, FR\_FRA, IT\_ITA, ES\_ESP, RU\_RUS - * Default language value is: EN\_ANY (English) + * Default language value is: EN\_ANY (English) 5. The "-xwav" optional switch 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 (around 650MB). @@ -138,27 +138,27 @@ Syntax Notes: 3. The "-cft" optional switch is followed by the path to the text configuration file "configureFontsTranslation.txt" -- if this is omitted then the file is assumed to reside in the current working directory. 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, ES\_ESP, RU\_RUS, EFIGS + * Valid language values are: EN\_ANY, DE\_DEU, FR\_FRA, IT\_ITA, ES\_ESP, RU\_RUS, EFIGS - * Default language value is: EN\_ANY (English) + * Default language value is: EN\_ANY (English) 5. The "--trace" optional switch enables extra debug messages to be printed. The __text configuration file "configureFontsTranslation.txt"__ is a __text file that should be saved in a UTF-8 encoding (no BOM)__, that contains the following: -1. Multiple lines (practically one per imported Font type) with the key "fontNameAndOutOfOrderGlyphs" and a '#'-separated value that contains: - * the name of an in-game Font "type" that will be included in the SUBTITLES.MIX resource archive. You could also have lines for Font "types" not imported in the SUBTITLES.MIX, but are already Font types used by the game (eg. KIA6PT) especially when you intend to add translated/ updated TRx files in the SUBTITLES.MIX (however even in that case, there are default settings for those fonts that the script will use if you don't specify alternative settings in this file to override them). Valid values can be: SUBTLS\_E (for all subtitles), KIA6PT, TAHOMA (for both TAHOMA18 and TAHOMA24), SYSTEM (this is basically for the ERRORMSG.TRx). +1. Multiple lines (practically one per imported Font type) with the key "fontNameAndOutOfOrderGlyphs" and a '\#'-separated value that contains: + * the name of an in-game Font "type" that will be included in the SUBTITLES.MIX resource archive. You could also have lines for Font "types" not imported in the SUBTITLES.MIX, but are already Font types used by the game (eg. KIA6PT) especially when you intend to add translated/ updated TRx files in the SUBTITLES.MIX (however even in that case, there are default settings for those fonts that the script will use if you don't specify alternative settings in this file to override them). Valid values can be: SUBTLS\_E (for all subtitles), KIA6PT, TAHOMA (for both TAHOMA18 and TAHOMA24), SYSTEM (this is basically for the ERRORMSG.TRx). - * a '#' character after the font type + * a '\#' character after the font type - * the name of the 8-bit string encoding (codepage) (eg. cp437 or windows-1252) that should be used to store the texts that uses this particular font "type" in the game's TRx text resource files. Valid values can be the standard encodings listed in python's page: + * the name of the 8-bit string encoding (codepage) (eg. cp437 or windows-1252) that should be used to store the texts that uses this particular font "type" in the game's TRx text resource files. Valid values can be the standard encodings listed in python's page: <https://docs.python.org/2.7/library/codecs.html#standard-encodings> - * a '#' character after the target Encoding + * a '\#' character after the target Encoding - * a list of comma separated tuples that specify the mapping of special (out of order) character to placeholder characters from the selected codepage. See fontCreator section for more details on this. + * a list of comma separated tuples that specify the mapping of special (out of order) character to placeholder characters from the selected codepage. See fontCreator section for more details on this. - * For example: + * For example: ``` fontNameAndOutOfOrderGlyphs=SUBTLS_E#windows-1253#í:Ά,ñ:¥,â:¦,é:§,Ά:£ fontNameAndOutOfOrderGlyphs=KIA6PT#cp437# @@ -198,35 +198,35 @@ The override encoding file is a __text file that should be saved in a UTF-8 enco <https://docs.python.org/2.7/library/codecs.html#standard-encodings> 2. A key "asciiCharList" with value the "all-characters" string with all the printable characters that will be used in-game, from the specified codepage. Keep in mind that: - * The first such character (typically this is the '!' character) should be repeated twice! + * The first such character (typically this is the '!' character) should be repeated twice! - * All characters must belong to the specified codepage. + * All characters must belong to the specified codepage. - * The order that the characters appear in the string should match their order in the ASCII table of the codepage. + * The order that the characters appear in the string should match their order in the ASCII table of the codepage. - * You don't need to use all the characters of the specified codepage in your "all-characters" string. + * You don't need to use all the characters of the specified codepage in your "all-characters" string. - * For any special characters that don't appear in the target codepage (eg ñ, é, í, â don't appear in the Greek codepage), you'll have to decide on an ASCII value for them (one not used by another character appearing in-game). + * For any special characters that don't appear in the target codepage (eg ñ, é, í, â don't appear in the Greek codepage), you'll have to decide on an ASCII value for them (one not used by another character appearing in-game). - * In the "all-characters" string you should put as placeholders the actual characters from the specified codepage that correspond to the ASCII values you have decided above; The placeholder characters should also be in the proper order (by their ASCII value) inside the string. + * In the "all-characters" string you should put as placeholders the actual characters from the specified codepage that correspond to the ASCII values you have decided above; The placeholder characters should also be in the proper order (by their ASCII value) inside the string. 3. A key "explicitKerningList" with value a list of comma separated tuples where each tuple specifies a character and its manually set kerning (x-offset) in pixels. Kerning can have integer (positive or negative) values. This list is optional and may be skipped, if you put a '-' instead of a list. - * Example: explicitKerningList=i:-1 + * Example: explicitKerningList=i:-1 - * Don't use space(s) between the tuples! + * Don't use space(s) between the tuples! 4. A key "explicitWidthIncrement" with value a list of comma separated tuples where each tuple specifies a character and its manually set extended width in pixels. This should be a positive integer value. You can skip this list by not writing anything in the file after the previous (manual kerning) list. - * Example: explicitWidthIncrement=i:0,j:1,l:1 + * Example: explicitWidthIncrement=i:0,j:1,l:1 - * Don't use space(s) between the tuples! + * Don't use space(s) between the tuples! 5. A key "originalFontName" with the FON file's original name in the game (the one that it should replace). Use SUBLTS for the subtitles FON. - * Example: originalFontName=SUBLTS + * Example: originalFontName=SUBLTS 6. A key "specialOutOfOrderGlyphsUTF8ToAsciiTargetEncoding" with value a list of comma separated tuples that indicates which character glyphs should replace the placeholder glyphs in your all-character string above. - * Example: specialOutOfOrderGlyphsUTF8ToAsciiTargetEncoding=í:Ά,ñ:¥,â:¦,é:§,Ά:£ + * Example: specialOutOfOrderGlyphsUTF8ToAsciiTargetEncoding=í:Ά,ñ:¥,â:¦,é:§,Ά:£ - * Don't use space(s) between the tuples! + * Don't use space(s) between the tuples! There is a sample of such file in the source folder for the fontCreator tool. @@ -237,13 +237,13 @@ __For the exporting of the game fonts (to PNG) mode__, the valid syntax expects __For the creation of subtitles' font mode__, there are six (6) mandatory launch arguments for the fontCreator tool: 1. imageRowPNGFilename: is the filename of the input PNG image file which should contain a row of (preferably) tab separated glyphs. Example: "Tahoma\_18ShdwTranspThreshZero003-G5.png". Keep in mind that: - * The first glyph should be repeated here too, as in the override encoding text file. + * The first glyph should be repeated here too, as in the override encoding text file. - * Background should be transparent. + * Background should be transparent. - * All colors used in the character glyphs should not have any transparency value (eg from Gimp 2, set Layer->Transparency->Threshold alpha to 0). There's no partial transparency supported by the game. A pixel will either by fully transparent or fully opaque. + * All colors used in the character glyphs should not have any transparency value (eg from Gimp 2, set Layer->Transparency->Threshold alpha to 0). There's no partial transparency supported by the game. A pixel will either by fully transparent or fully opaque. - * If you use special glyphs that are not in the specified ASCII codepage (eg ñ, é, í, â don't appear in the Greek codepage), then in this image file you should use the actual special glyphs - put them at the position of the placeholder characters in your "all-characters" string that you've specified in the override encoding text file. + * If you use special glyphs that are not in the specified ASCII codepage (eg ñ, é, í, â don't appear in the Greek codepage), then in this image file you should use the actual special glyphs - put them at the position of the placeholder characters in your "all-characters" string that you've specified in the override encoding text file. 2. targetFONfilename: Example: "SUBTLS\_E.FON" for the subtitles. @@ -264,21 +264,21 @@ The "--trace" optional switch enables extra debug messages to be printed. A suggested method of creating decent looking PNG with the row of glyphs for your subtitles' font is the following: 1. Create the font row in __GIMP__ - * Start with a __new__ empty image, with transparent background. Choose a large enough canvas width (you can adjust it later) + * Start with a __new__ empty image, with transparent background. Choose a large enough canvas width (you can adjust it later) - * Paste as a new layer a tab separated alphanumeric sequence with all your glyphs (as specified above). Choose white as the font's color. + * Paste as a new layer a tab separated alphanumeric sequence with all your glyphs (as specified above). Choose white as the font's color. - * Adjust your canvas' width and height to make sure all the glyphs are within its borders. + * Adjust your canvas' width and height to make sure all the glyphs are within its borders. 2. Add layers for shadows if necessary (recommended) by duplicating the original layer with the (white colored) glyphs to create layers that would be used for the shadow effect. Those layers should be __colorified__ as black and placed behind the original layer, displaced by one (1) pixel from eg. the top, right, left, and bottom (it's recommended to do this for all of those four). 3. __Merge all visible__ layers (maintaining an alpha channel for the background) 4. __Select all__ and __float the selection__, which should create a floating selection with all the letter glyphs. - * __Promote that selection to a layer__ and __duplicate__ it. + * __Promote that selection to a layer__ and __duplicate__ it. 5. Choose one of the duplicated layers and __COLORIFY__ it to pitch black. - * __Set the transparency threshold__ of this black layer to 0. + * __Set the transparency threshold__ of this black layer to 0. 6. Finally, place this completely black colored layer underneath the other one and __merge the visible__ layers. @@ -289,8 +289,8 @@ There could be a better way but this should work ok. # Credits and Special Thanks -- All the developer guys from the ScummVM (https://github.com/scummvm/scummvm) team, and especially the ones involved in the implementation of the BladeRunner engine for ScummVM (madmoose, peterkohaut, sev and everyone else). +* All the developer guys from the ScummVM (https://github.com/scummvm/scummvm) team, and especially the ones involved in the implementation of the BladeRunner engine for ScummVM (madmoose, peterkohaut, sev and everyone else). -- The information provided in this blog (http://westwoodbladerunner.blogspot.ca) by Michael Liebscher. +* The information provided in this blog (http://westwoodbladerunner.blogspot.ca) by Michael Liebscher. -- The creator of br-mixer (https://github.com/bdamer/br-mixer), Ben Damer, who also has a blog entry about the game resource file formats (http://afqa123.com/2015/03/07/deciphering-blade-runner/) +* The creator of br-mixer (https://github.com/bdamer/br-mixer), Ben Damer, who also has a blog entry about the game resource file formats (http://afqa123.com/2015/03/07/deciphering-blade-runner/) |