Sentences.txt Last edited 1 week ago2024-05-17 19:28:29 UTC

In a GoldSrc game, the sentences.txt file sets the sound files used by monsters, doors, buttons, the speaker entity, and scripted_sentence entities.

The file is located in the sound/ folder of a game or mod. Each line of the file sets a sentence name, and a series of sound files to be emitted by the calling entities. The sound files are referenced by their names, without the .wav suffix.

Syntax

Here's a little snippet from the file:
// HUMAN GRUNTS
HG_GREN0 hgrunt/clik(p120) grenade! clik
Where: More on this in the following sections.

Identifiers

Each entry starts with the sentence identifier. It must be unique, and there is a max limit in vanilla GoldSrc of 1536 or 2048 sentences since the Half-Life 25th anniversary update.
In general, the identifiers are constructed as follows: The max length of the sentence identifiers is 16 characters.

Sounds

The sound files to play in order, separated by spaces.

By default, to make the iconic announcer voice, the sound files are picked from vox/ and typed into sentences.txt generally like an English sentence. In order to change the folder, specify the folder name followed by a slash and then the file name. The folder name must be relative to "sound/", so "sound/" must not itself be included. You can only specify the folder once, at the beginning of the sentence.

To further support the English sentence paradigm, commas and periods are translated to "_comma" and "_period" files, containing the appropriate amount of silence. Example usage:
SC_HEAL4 scientist/youwounded, letstrythis
The max length of the sentence line is 511 characters, and the max number of words (sound files to play in each sentence) is 32.

Modifiers

Modifiers apply dynamic processing to the sounds, allowing you to do actions such as changing the pitch or truncating a sound from the file without editing the files themselves. Modifiers are in the form of (a# b# c#), where the "abc" are the modifier codes and the "#" are the modifier amounts in percent.

Modifiers take effect in two modes: For example, in the following:
C1A0_10 doop (e95 p103) doctor freeman, (e95) to(e70) anomalous materials test lab immediately(e100)
The following lists the modifiers:
Code Description range to reset
e Changes the ending position. Allows you to truncate the end of the file. 0-100 e100
p Changes the pitch. It also speeds up the sound by the same amount. 1-255 p0
s Changes the starting position. Allows you to truncate the beginning of the file. 0-100 s0
v Changes the volume. 0-100 v100
t Time compression. It can only speed up and starts from 0 (normal speed). Doesn't affect pitch. See below. 0-100 t0
Visualization of time compression. Top: Original sample, Bottom: recording of sample spoken with (t25) applied, chopped and aligned to the original sampleVisualization of time compression. Top: Original sample, Bottom: recording of sample spoken with (t25) applied, chopped and aligned to the original sample
Time compression works by chopping the sound file sample, after applying the start and end crops, into 8 chunks, then cropping N% off of the start of the second to eighth chunks. The first chunk is always preserved, probably due to a quirk in the engine code.

Therefore, time compression should be used only on word files e.g. from vox/ and hgrunt/, and not be used on longer sound files e.g. whole sentence files of the scientists and barneys as that'd cause random parts of their sentence to be dropped.

Note that if a single modifier in a modifier group is invalidated, the entire group is discarded.

Usage

Talking monsters each have their groups of sentences in the file. The group names are hard-coded in each game, but you can edit sentences.txt to change/add sentences in the existing groups.

scripted_sentence and ambient_generic

To use a sentence from the sentences file, add a ! followed by the sentence name in the "Sentence name" key in scripted_sentence.
See scripted_sentence for more information.

The ambient_generic entity also accepts a sentence name in the place of a WAV file. This allows you to play a sentence without an NPC to speak it.
See ambient_generic for more information.

speaker

Choose from a preset, or specify a "Sentence Group Name" in the speaker entity. Unlike in scripted_sentence, ! is not prefixed when specifying a group, but prefixed when specifying a single sentence.
See speaker for more information.

doors and buttons

Doors and buttons have "locked" and "unlocked" sounds, which lets you select from the predefined sentence groups. You cannot specify a sentence name/group directly.

speak command

In the console, you can test your sentences by typing speak "sentence" where "sentence" is the whole sentence. Modifiers are supported. You can also use the !SENTENCENAME syntax to speak a specific sentence of that name.

NOTE: The implementation of this command is game-specific and may not work on mods. For example, it works on Half-Life but not on Sven-Coop or XASH. (in fact implementation of sentences.txt modifiers is incomplete in XASH)

Limitations

The following limitations apply in the base engine and/or SDK: The vanilla sentence system doesn't play well with the SteamPipe folder structures (i.e. the _addon and _downloads suffixed folders, among others). It means that you should only ever have sentences.txt in the base game/mod folder.

Alternatives in other games

Counter-Strike: Condition Zero Deleted Scenes implements sequence files (.seq), which allow sentences and sequences to be loaded on a per map basis. It has its own associated entities and syntax but increases the portability of custom sentences in custom maps. These additions were not backported to the Half-Life SDK, however.

Sven Co-op has its own way to load a custom sentences.txt-syntaxed file per map/entity.

Resources

2 Comments

Commented 2 years ago2021-08-12 08:56:24 UTC Comment #103666
By yours truly.

Let this be the definitive guide for sentences.txt, especially for the scant information on the modifiers.
Commented 11 months ago2023-06-01 08:06:29 UTC Comment #105320
Thanks for this, I was wondering what the things in the parentheses were.

You must log in to post a comment. You can login or register a new account.