Difference between revisions of "Subtitles (Portal 2)"

From Valve Developer Community
Jump to: navigation, search
(Compiling the .txt file into a .dat file: Replaced mess with Subtitles Compiling section, lazy placeholder)
Line 36: Line 36:
  
 
== Compiling the .txt file into a .dat file ==
 
== Compiling the .txt file into a .dat file ==
In order for the captions to be able to be seen in game, the captions must be compiled into a .dat file. This can be done using the ''captioncompiler'' executable located inside the ''Portal 2/bin'' file.
+
The captions must be compiled with <code>captioncompiler.exe</code>. Make sure the SDK launcher is set to the mod you're working on, then simply drag your caption file onto it. The caption file must be dragged from the mod resource directory in order to produce the .dat file. e.g. <code>C:\Program Files\Steam\steamapps\SourceMods\[mod name]\resource\</code>.
  
Go to '''Start''' -> '''Run''' and type in ''cmd'' to bring up the command prompt. Navigate to the captioncompiler.exe file and drag it into the command prompt.
+
This process will become slightly easier if you create a batch command file in the resource folder. Copy the following code into a text file and save it as a .bat file in the resources folder:
Then use the input -v "closecaption_''NameOfFile.txt''" after it. Like so:
 
  
 +
<syntaxhighlight lang=winbatch>
 +
"[game/SDK root]\bin\captioncompiler.exe" %1
 +
pause
 +
</syntaxhighlight>
  
<source>
+
{{tip|With a batch file, you can use the <code>-game "path to gameinfo.txt"</code> parameter to override the global [[Game Directory|vproject]] value.  Place it after <code>%1</code>, leaving a space. This saves you from having to launch the SDK and change it there.}}
"C:/Program Files (x86)/Steam/steamapps/common/Portal 2/bin/captioncompiler.exe" -v "closecaption_NameOfFile.txt"
 
</source>
 
  
 
+
Drag your caption .txt files onto the Batch file to use it as you would the .exe itself.
This will compile the captions into the file which can run in game. Keep the compiled file inside the resource folder.
 
 
 
 
 
{{note|If the file refuses to compile because the [[What is meant by Game Directory?|Game Directory]] is different from the portal 2 folder, change it by making a duplicate entry in the gameConfig.txt in your SouceSDK/bin/ep1(orangebox)/bin folder with the paths of the "GameDir" value leading to your ''Portal 2/portal2'' directory. Then run SourceSDK with the custom parameters to make Portal 2 the active mod.}}
 
 
 
{{note|Workaround: Navigate to \Steam\SteamApps\common\portal 2\bin, create a new folder and name it "resource". Save our closecaption_NameOfFile.txt in this new folder. Navigate to \Steam\SteamApps\common\portal 2\portal2 and copy the file gameinfo.txt you find here into \Steam\SteamApps\common\portal 2\bin. When running captioncompiler.exe, it will save the compiled .dat-file into \Steam\SteamApps\common\portal 2\bin\resource. Grab the .txt and the .dat file from there and move them into \Steam\SteamApps\common\portal 2\portal2\resource.}}
 
  
 
== Making the captions appear in game ==
 
== Making the captions appear in game ==

Revision as of 02:55, 18 April 2018

Русский

Closed Captions (or subtitles) are mainly used for displaying Actor's dialogue for players that are hearing-impaired or have no sound. Simple world sounds may be listed in the captions to simulate different noises or effects, such as doors closing or explosions. Subtitles are deemed to be important when it comes to medium to large sized mods as the mod would be distributed to a much wider audience than what a single map would.

Captions can also be used to indicate where dialogue will be, but has not been recorded yet, as recording masses amounts of sounds can be time consuming when in production of the level.


In Portal 2 the captions automatically appear when an actor speaks (if defined) inside the specific scene file; however, creating custom scene files are impossible without having to completely re-compile the scenes.image file. Therefore a workaround is needed.


Note:This tutorial will assume that you already have your (custom) sound implemented in your map and will use the name of the examples for consistency.

Creating the caption file

Firstly, create the captions inside a text file located in the Steam/steamapps/common/Portal 2/portal2/resource folder. The format of the captions should look like this:


lang
{ 
	Language "English"
	Tokens 
	{ 
		character.example1	"This is an example caption."
		character.example2	"You should be able to see captions on the screen."
	}
}


  • Save the .txt file in the UCS-2 Little Endian or UTF-16 LE format. Use Notepad++ or another advanced text editor to do this.
  • The captions should be in quotation marks to indicate the caption text.
  • The name of the caption should be the name of a soundscript not the name of the sound. However, this will work without creating a soundscript.
  • Save the .txt file with the prefix closecaption_ as this will be necessary to play the captions.

Compiling the .txt file into a .dat file

The captions must be compiled with captioncompiler.exe. Make sure the SDK launcher is set to the mod you're working on, then simply drag your caption file onto it. The caption file must be dragged from the mod resource directory in order to produce the .dat file. e.g. C:\Program Files\Steam\steamapps\SourceMods\[mod name]\resource\.

This process will become slightly easier if you create a batch command file in the resource folder. Copy the following code into a text file and save it as a .bat file in the resources folder:

"[game/SDK root]\bin\captioncompiler.exe" %1
pause
Tip:With a batch file, you can use the -game "path to gameinfo.txt" parameter to override the global vproject value. Place it after %1, leaving a space. This saves you from having to launch the SDK and change it there.

Drag your caption .txt files onto the Batch file to use it as you would the .exe itself.

Making the captions appear in game

Since making scenes are out of the option for making the captions appear, it is necessary to manually make the captions appear using entities inside the hammer editor or using a script.

  1. Create or use a point_servercommand.
  2. Create a logic_auto and put the output with the name of the caption file without the prefix closecaption_:
My Output Target Target Input Parameter
OnMapSpawn @servercommand Command cc_lang NameOfFile

     3. Using whichever method to activate the sound or caption add these outputs:

My Output Target Target Input Parameter
OnAnOutput @servercommand Command cc_emit character.example1
  • Make sure to also activate the preferred sound at the same time. (This was the whole reason for the captions).


Note:Do not use the prefix closecaption_ when calling the file like this. When using the command cc_lang, the game automatically adds that prefix, so you would end up calling closecaption_closecaption_NameOfFile. Please visit the discussion section of this page for an example.


If you use original scene files in your map but only have a few custom voice lines, you shouldn't change the cc_lang OnMapSpawn, as people will not see the subtitles for the original scenes this way. Instead, activate your custom subtitles file only when needed. Like so:

My Output Target Target Input Parameter Delay
OnAnOutput @servercommand Command cc_lang NameOfFile 0.00
OnAnOutput @servercommand Command cc_emit character.example1 0.10
OnAnOutput @servercommand Command cc_lang 0.20

Using the command cc_lang without defining which one in the final Output will make the game use the language of the Game_UI again, while still playing the custom subtitles activated 0.1 seconds earlier.

Caption Codes (Portal 2)

<sfx>
Marks a line as a sound effect that will only be displayed with full closed captioning. If the user has cc_subtitles set to "1", it will not display these lines.
<clr:255,255,255>
Sets the color of the caption using RGB color; 0 is no color, 255 is full color. For example, ;<clr:255,0,0> would be red.
<b>
Bolds all text following the tag.
<i>
Italics text following the tag.
<len:#>
Indicates how long the caption should appear on the screen.
<norepeat:#>
Sets how long until the caption can appear again. Useful for frequent sounds.

An example of how to use a code tag:

lang
{ 
	Language "English"
	Tokens 
	{ 
		character.example1	"<clr:255,0,0><b> Character: This is an example caption."
		character.example2	"<clr:255,0,0><len:3> Character: You should be able to see captions on the screen."
	}
}

See also