Subtitles - Revision history

Geep: /* internationalization */ section added

2026-01-17T18:20:01Z

internationalization: section added

← Older revision		Revision as of 18:20, 17 January 2026
Line 129:		Line 129:
	* Avoid ending the last message much beyond the clip length (analogous to -dx considerations)		* Avoid ending the last message much beyond the clip length (analogous to -dx considerations)
	* While such a duration extension directly benefits the final message, it is sometimes possible to "distribute the benefit" to an earlier message by small shifts in message breaks.		* While such a duration extension directly benefits the final message, it is sometimes possible to "distribute the benefit" to an earlier message by small shifts in message breaks.

			==== internationalization ====

			As mentioned above, a mechanism for support of translations, e.g., use of #str IDs, has not been developed. As of TDM 2.14 [alpha], one pre-requisite for European languages exists: build-out of the font used for subtitles, "english" Stone 24pt, to include complete coverage of all 256 characters in the TDM character map.

	==== sound sample ====		==== sound sample ====

Datiswous: /* Output */ added link to forum topic

2024-12-06T11:07:53Z

Output: added link to forum topic

← Older revision		Revision as of 11:07, 6 December 2024
Line 201:		Line 201:

	Note: it is not clear yet which kind of customization is necessary for the subtitles GUI.		Note: it is not clear yet which kind of customization is necessary for the subtitles GUI.
	If you have any ideas, please share them on forums.		If you have any ideas, please share them on [https://forums.thedarkmod.com/index.php?/topic/21741-subtitles-possibilities-beyond-211/ forums].

	{{GUI}}		{{GUI}}

Datiswous: Removed todo stuff that is already done

2024-12-06T11:05:30Z

Removed todo stuff that is already done

← Older revision		Revision as of 11:05, 6 December 2024
Line 202:		Line 202:
	Note: it is not clear yet which kind of customization is necessary for the subtitles GUI.		Note: it is not clear yet which kind of customization is necessary for the subtitles GUI.
	If you have any ideas, please share them on forums.		If you have any ideas, please share them on forums.

	~~=== See also ===~~

	~~'''TODO:''' "Tears of Saint Lucia" mission as an example?...~~

	{{GUI}}		{{GUI}}

Geep: /* displaying text with extended duration (new for 2.12) */

2023-07-02T16:37:49Z

displaying text with extended duration (new for 2.12)

← Older revision		Revision as of 16:37, 2 July 2023
Line 128:		Line 128:
	* Usually, messages are abutted; sometimes, significant time gaps are appropriate		* Usually, messages are abutted; sometimes, significant time gaps are appropriate
	* Avoid ending the last message much beyond the clip length (analogous to -dx considerations)		* Avoid ending the last message much beyond the clip length (analogous to -dx considerations)
	* While such a duration extension directly benefits the final message, it is sometimes possible to "distribute the benefit" to earlier message by small shifts in message breaks.		* While such a duration extension directly benefits the final message, it is sometimes possible to "distribute the benefit" to an earlier message by small shifts in message breaks.

	==== sound sample ====		==== sound sample ====

Geep: /* displaying text with extended duration (new for 2.12) */ section added

2023-07-02T16:03:27Z

displaying text with extended duration (new for 2.12): section added

@@ Line 29: / Line 29: @@
 Non-story speech (as of 2.10) is limited to a dozen phrases of the "Cynic" voice, used by some attacking guards. Since this is part of the core distribution, these English subtitles become available to existing games automatically. [https://forums.thedarkmod.com/index.php?/topic/21740-english-subtitles-for-ai-barks/ A project to expand this coverage for 2.12] has been started.
 === How it works ===
@@ Line 92: / Line 94: @@
   Ah! Here we go.
 Creating .srt files is best done with third-party AV software, not writing them manually. For TDM, files must be in engine-native encoding (internationalization is not supported yet anyway) and have no BOM mark. While implementations of the [https://en.wikipedia.org/wiki/Subrip#SubRip_file_format "SubRip" file format] often include HTML-style markups for font attributes like bold or italics, these are not possible for TDM. What TDM ''does'' have is limited primary-color font markup, applicable to inline and srt subtitles; see [[Text_Decals_for_Signs_etc.#Signs_with_Illuminated_Colored_Letters | Signs_with_Illuminated_Colored_Letters]] for details.
 ==== sound sample ====

Stgatilov: Fixed "fromVideo" explanation and example: it should be material name, not video file name.

2023-06-27T16:30:04Z

Fixed "fromVideo" explanation and example: it should be material name, not video file name.

← Older revision		Revision as of 16:30, 27 June 2023
Line 71:		Line 71:
	subtitles fm_briefing {		subtitles fm_briefing {
	verbosity story		verbosity story
	srt "fromVideo video/~~briefing/briefing.mp4~~" "video/briefing/briefing.srt"		srt "fromVideo video/sts_briefing_intro" "video/briefing/briefing.srt"
	}		}

Line 98:		Line 98:

	One complicated case is when you have an [[Cutscene_video_with_FFmpeg#Play_video_with_sound\|FFmpeg-based video with embedded sound]].		One complicated case is when you have an [[Cutscene_video_with_FFmpeg#Play_video_with_sound\|FFmpeg-based video with embedded sound]].
	In this case write ~~path to the video file~~, prepended with '''fromVideo''' keyword and space, just like you do in the sound shader.		In this case write material name, prepended with '''fromVideo''' keyword and space, just like you do in the sound shader.
	See <tt>fm_briefing</tt> in the example above.		See <tt>fm_briefing</tt> in the example above.

Geep: /* displayed text */ Revise srt section. Add line break info for inline

2023-02-17T19:44:20Z

displayed text: Revise srt section. Add line break info for inline

← Older revision		Revision as of 19:44, 17 February 2023
Line 80:		Line 80:
	'''inline''' command is followed by a name of sound sample and the text to be displayed while it is being played.		'''inline''' command is followed by a name of sound sample and the text to be displayed while it is being played.
	In this case, the text is written straight in the decl file, and it is displayed for the whole duration of the sound sample.		In this case, the text is written straight in the decl file, and it is displayed for the whole duration of the sound sample.
	This way is convenient for short sounds, which are the majority of sound samples, including phrases of a conversation.		This way is convenient for short sounds, which are the majority of sound samples, including phrases of a conversation. A "\n" can be embedded in the text to force a line break.

	'''srt''' command is followed by a ~~name of~~ sound sample and ~~a path to~~ .srt file.		'''srt''' command is followed by paths to a sound sample and its .srt file, typically with matching filenames. This method, while more complicated than inline, has the flexibility to support a long sound file that needs multiple sequential subtitles, such as the sound sample of a briefing video. An .srt file, in "SubRip" format, is usually placed either with its sound file or in a "subtitles" folder. It contains a sequence of text messages to show during the sound sample, each with start and end HH:MM:SS,sss timestamps within the sample's timeline. For example:
	~~The <tt>~~.srt~~</tt>~~ file format is ~~described e~~.g. ~~[https~~:~~//en~~.~~wikipedia~~.~~org/wiki/Subrip#SubRip_file_format]~~.		1
	~~The file~~ must be in engine-native encoding (internationalization is not supported yet anyway) and have no BOM mark.		00:00:03,612 --> 00:00:10,376
	~~It contains a sequence~~ of ~~text messages to show during~~ the ~~sound sample, with timestamps and durations~~.		Bugger me!
	~~It is recommended to use common software to create~~ .~~srt files~~ for ~~sound samples~~, ~~instead of writing them manually~~.		Something's wrong with this crystal ball.
	~~This way~~ is ~~more flexible but more complicated~~, and ~~it is only necessary for long sounds,~~ for ~~instance sound sample of a briefing video~~.
			2
			00:00:25,336 --> 00:00:28,167
			Ah! Here we go.
			Creating .srt files is best done with third-party AV software, not writing them manually. For TDM, files must be in engine-native encoding (internationalization is not supported yet anyway) and have no BOM mark. While implementations of the [https://en.wikipedia.org/wiki/Subrip#SubRip_file_format "SubRip" file format] often include HTML-style markups for font attributes like bold or italics, these are not possible for TDM. What TDM ''does'' have is limited primary-color font markup, applicable to inline and srt subtitles; see [[Text_Decals_for_Signs_etc.#Signs_with_Illuminated_Colored_Letters \| Signs_with_Illuminated_Colored_Letters]] for details.

	==== sound sample ====		==== sound sample ====

Geep: /* include */ correct fm_test.subs to fm_conversations.subs

2023-02-10T16:35:34Z

include: correct fm_test.subs to fm_conversations.subs

← Older revision		Revision as of 16:35, 10 February 2023
Line 120:		Line 120:
	'''include''' command has one argument: the name of the subtitles decl to be included. Note that it is the name of the decl, not the name of the file which contains it! Included decl can in turn include other decls.		'''include''' command has one argument: the name of the subtitles decl to be included. Note that it is the name of the decl, not the name of the file which contains it! Included decl can in turn include other decls.

	FM-specific subtitles are always included from the decl named '''fm_root''', which must be in the '''fm_root.subs''' file. For instance, the contents of the <tt>~~fm_test~~.subs</tt> file from the example above will have no effect until we add the file <tt>fm_root.subs</tt> with contents:		FM-specific subtitles are always included from the decl named '''fm_root''', which must be in the '''fm_root.subs''' file. For instance, the contents of the <tt>fm_conversations.subs</tt> file from the example above will have no effect until we add the file <tt>fm_root.subs</tt> with contents:

	/**		/**

Stgatilov: gamer -> player

2023-02-08T20:54:43Z

gamer -> player

← Older revision		Revision as of 20:54, 8 February 2023
Line 1:		Line 1:
	Support for subtitles (or closed captions) was added in TDM 2.10.		Support for subtitles (or closed captions) was added in TDM 2.10.

	=== What the ~~gamer~~ sees ===		=== What the player sees ===
	In 2.10+, the player can control subtitle visualization under Settings/Audio/Subtitles, which takes one of these values:		In 2.10+, the player can control subtitle visualization under Settings/Audio/Subtitles, which takes one of these values:
	* Story - display only story-related subtitles		* Story - display only story-related subtitles

Geep: /* displayed text */ fix URL to file format

2023-02-07T16:26:24Z

displayed text: fix URL to file format

← Older revision		Revision as of 16:26, 7 February 2023
Line 83:		Line 83:

	'''srt''' command is followed by a name of sound sample and a path to .srt file.		'''srt''' command is followed by a name of sound sample and a path to .srt file.
	The <tt>.srt</tt> file format is described e.g. [https://~~www~~.~~wikiwand~~.~~com~~/en/~~SubRip~~#SubRip_file_format ~~on Wikipedia~~].		The <tt>.srt</tt> file format is described e.g. [https://en.wikipedia.org/wiki/Subrip#SubRip_file_format].
	The file must be in engine-native encoding (internationalization is not supported yet anyway) and have no BOM mark.		The file must be in engine-native encoding (internationalization is not supported yet anyway) and have no BOM mark.
	It contains a sequence of text messages to show during the sound sample, with timestamps and durations.		It contains a sequence of text messages to show during the sound sample, with timestamps and durations.