Editing Speech file

{{av}}
{{Modding}}
'''Speech files''', also known as '''text sets''', are text files that define sentences which can be spoken by people in [[adventure mode]] and phrases used to name [[books]]. Most of them are found in the <code>data/vanilla/vanilla_text/objects</code> folder, though the creature specific files can be found in <code>data/vanilla/vanilla_creatures/objects</code>. Like other raw files, mods can replace or introduce new sentences.

== List of files ==

{| class="wikitable"
! File !! Uses !! Example
|-
| {{text anchor|text_ab_specific_hf_seeker}}
|
| seek out [CONTEXT:HIST_FIG:TRANS_NAME] at [CONTEXT:ABSTRACT_BUILDING:TRANS_NAME] over in [CONTEXT:SITE:TRANS_NAME]

|-
| {{text anchor|text_animal_slayer}}
|
| I have taken down [CONTEXT:NUMBER] [CONTEXT:RACE:NUMBERED_NAME] while stalking [CONTEXT:PLACE:TRANS_NAME].

|-
| {{text anchor|text_arch_info_justification}}
|
| It is said that the [CONTEXT:ARCH_ELEMENT] of [CONTEXT:ABSTRACT_BUILDING:TRANS_NAME] [CONTEXT:JUSTIFICATION] [CONTEXT:DEF_SPHERE] for the glory of [CONTEXT:HIST_FIG:TRANS_NAME].

|-
| {{text anchor|text_book_art}}
| Used when naming books.
| And [ANY_PRONOUN] Sang '[NAME]!'

|-
| {{text anchor|text_book_instruction}}
| Used when naming books.
| A Course on [NAME]

|-
| {{text anchor|text_child_age_proclamation}}
|
| I'm [CONTEXT:NUMBER]!

|-
| {{text anchor|text_current_profession_no_year}}
|
| I am a [CONTEXT:UNIT_NAME].

|-
| {{text anchor|text_current_profession_year}}
|
| This is my [CONTEXT:ORDINAL] year as a [CONTEXT:UNIT_NAME].

|-
| {{text anchor|text_curse}}
|
| Who dares to enter my house?  I curse you!

|-
| {{text anchor|text_dwarf}}
| Used when boasting about killing a [[dwarf]]. See also [[Creature token#SPEECH]].
| whose hammer shattered on the anvil of my power

|-
| {{text anchor|text_elf}}
| Used when boasting about killing an [[elf]]. See also [[Creature token#SPEECH]].
| whose fragile bones shattered before the power of my contempt

|-
| {{text anchor|text_family_relationship_additional}}
|
| [CONTEXT:HIST_FIG:PRO_SUB] is also my [CONTEXT:FAMILY_RELATIONSHIP]

|-
| {{text anchor|text_family_relationship_additional_dead}}
|
| [CONTEXT:HIST_FIG:PRO_SUB] was also my [CONTEXT:FAMILY_RELATIONSHIP]

|-
| {{text anchor|text_family_relationship_no_spec}}
|
| I have [CONTEXT:INDEF_FAMILY_RELATIONSHIP] named [CONTEXT:HIST_FIG:TRANS_NAME]

|-
| {{text anchor|text_family_relationship_no_spec_dead}}
|
| I had [CONTEXT:INDEF_FAMILY_RELATIONSHIP] named [CONTEXT:HIST_FIG:TRANS_NAME]

|-
| {{text anchor|text_family_relationship_spec}}
|
| my [CONTEXT:FAMILY_RELATIONSHIP] is named [CONTEXT:HIST_FIG:TRANS_NAME]

|-
| {{text anchor|text_family_relationship_spec_dead}}
|
| my [CONTEXT:FAMILY_RELATIONSHIP] was named [CONTEXT:HIST_FIG:TRANS_NAME]

|-
| {{text anchor|text_general}}
|
| who lies dead, now only an embarrassing memory

|-
| {{text anchor|text_goodbye_worship_1}}
|
| upon arising in the mornings,

|-
| {{text anchor|text_goodbye_worship_2}}
|
| always remember to

|-
| {{text anchor|text_goodbye_worship_3}}
|
| speak the praises of [SPEAKER:HF_LINK:DEITY:RANDOM_DEF_SPHERE]

|-
| {{text anchor|text_greet}}
| Used when greeting another person.
| Greetings. My name is [SPEAKER:TRANS_NAME].

|-
| {{text anchor|text_greet_baby}}
| Used when greeting a [[baby]].
| A baby! How adorable!

|-
| {{text anchor|text_greet_reply}}
| Used when replying to another person's greeting.
| Ah, hello. I'm [SPEAKER:TRANS_NAME].

|-
| {{text anchor|text_greet_reply_after_hero}}
| Used by NPCs when replying to the player character's greeting after becoming a [[hero]].
| I am [SPEAKER:TRANS_NAME]. How can I be of service?

|-
| {{text anchor|text_greet_reply_diff_language}}
| Used when replying to the greeting of a person who is of another race.
| Hello, [AUDIENCE:RACE]. I am [SPEAKER:TRANS_NAME].

|-
| {{text anchor|text_greet_reply_unusual_first}}
| Used when replying to the greeting of a person whose first name is unusual.{{verify|June 2015}}
| You know, you don't meet many people with the name [AUDIENCE:FIRST_NAME]

|-
| {{text anchor|text_greet_worship}}
| Used for greetings by [[priest]]s and faithful people.{{verify|June 2015}}
| This servant of [SPEAKER:HF_LINK:DEITY:TRANS_NAME] greets you.

|-
| {{text anchor|text_guard_profession}}
| Used by guards when you ask them about their profession. See also [[#soldier_profession|soldier_profession]].
| I am a guard.

|-
| {{text anchor|text_guard_warning}}
|
| Don't start any trouble.

|-
| {{text anchor|text_hist_fig_slayer}}
|
| It is I that felled [CONTEXT:HIST_FIG:TRANS_NAME] the [CONTEXT:HIST_FIG:RACE].

|-
| {{text anchor|text_hunting_profession}}
|
| I hunt great beasts in [CONTEXT:PLACE:TRANS_NAME].

|-
| {{text anchor|text_hunting_profession_year}}
|
| I have hunted great beasts in [CONTEXT:PLACE:TRANS_NAME] for [CONTEXT:NUMBER] of my years.

|-
| {{text anchor|text_justification_antithetical}}
|
| can be thought of as the antithesis of

|-
| {{text anchor|text_justification_experience}}
|
| can allow one to experience

|-
| {{text anchor|text_justification_proximity}}
|
| can bring one near to

|-
| {{text anchor|text_justification_reminder}}
|
| can remind one of

|-
| {{text anchor|text_justification_representation}}
|
| can be thought of as a representation of

|-
| {{text anchor|text_lair_hunter_minotaur}}
| Used by [[minotaur]]s while hunting adventures in their lairs. See also [[Creature token#LAIR_HUNTER_SPEECH]].
| I'll eat you whole!

|-
| {{text anchor|text_mercenary_profession}}
|
| I seek fortune and glory by offering my skill at arms in [CONTEXT:PLACE:TRANS_NAME].

|-
| {{text anchor|text_mercenary_profession_year}}
|
| I have sought fortune and glory by offering my skill at arms in [CONTEXT:PLACE:TRANS_NAME] for [CONTEXT:NUMBER] of my years.

|-
| {{text anchor|text_no_family}}
| Used by NPCs when you ask them about their [[family]], but they don't have any.
| I have no family to speak of.

|-
| {{text anchor|text_past_hunting_profession}}
|
| In the past, I hunted great beasts.

|-
| {{text anchor|text_past_mercenary_profession}}
|
| In the past, I sought fortune and glory by offering my skill at arms.

|-
| {{text anchor|text_past_profession_no_year}}
|
| I was once a [CONTEXT:UNIT_NAME].

|-
| {{text anchor|text_past_profession_year}}
|
| I was a [CONTEXT:UNIT_NAME] for [CONTEXT:NUMBER] of the years of my life.

|-
| {{text anchor|text_past_snatcher_profession}}
|
| Once it was my calling to rescue lost children.

|-
| {{text anchor|text_past_thief_profession}}
|
| I once sought great treasures.

|-
| {{text anchor|text_past_wandering_profession}}
|
| I once wandered the wilds.

|-
| {{text anchor|text_positive}}
| Used to express positive [[feeling]]s.
| wonderful!<br/>fantastic!<br/>very good

|-
| {{text anchor|text_same_site_ab_specific_hf_seeker}}
|
| seek out [CONTEXT:HIST_FIG:TRANS_NAME] here in [CONTEXT:SITE:TRANS_NAME] at [CONTEXT:ABSTRACT_BUILDING:TRANS_NAME]

|-
| {{text anchor|text_same_site_specific_hf_seeker}}
|
| seek out [CONTEXT:HIST_FIG:TRANS_NAME] here in [CONTEXT:SITE:TRANS_NAME]

|-
| {{text anchor|text_site_specific_hf_seeker}}
|
| seek out [CONTEXT:HIST_FIG:TRANS_NAME] over in [CONTEXT:SITE:TRANS_NAME]

|-
| {{text anchor|text_slayer}}
|
| bane<br/>death<br/>nemesis<br/>vanquisher

|-
| {{text anchor|text_snatcher_profession}}
|
| I rescue lost children and bring them back to [CONTEXT:PLACE:TRANS_NAME].

|-
| {{text anchor|text_snatcher_profession_year}}
|
| For [CONTEXT:NUMBER] of my years, I have been rescuing lost children and bringing them back to [CONTEXT:PLACE:TRANS_NAME].

|-
| {{text anchor|text_soldier_profession}}
| Used by [[soldier]]s when you ask them about their profession. See also [[#guard_profession|guard_profession]].
| I am a soldier.

|-
| {{text anchor|text_task_recommendation}}
|
| [CONTEXT:ANY:TRANS_NAME] might have a task for you

|-
| {{text anchor|text_temple_already_member}}
|
| your task is simple;<br/>all you need is to

|-
| {{text anchor|text_temple_become_member}}
|
| Welcome to [CONTEXT:ENTITY:TRANS_NAME].  Praise be to [CONTEXT:ENTITY:WORSHIP_HF:TRANS_NAME]!<br/>As a member of [CONTEXT:ENTITY:TRANS_NAME], you can now seek the higher mysteries of [CONTEXT:ENTITY:WORSHIP_HF:TRANS_NAME].

|-
| {{text anchor|text_thief_profession}}
|
| I seek treasures and bring them back to [CONTEXT:PLACE:TRANS_NAME].

|-
| {{text anchor|text_thief_profession_year}}
|
| I seek treasures and bring them back to [CONTEXT:PLACE:TRANS_NAME] and have done so for [CONTEXT:NUMBER] of the years of my life.

|-
| {{text anchor|text_threat}}
| Used by NPC [[bandit]]s{{verify|June 2015}} before attacking you.
| Prepare to die!

|-
| {{text anchor|text_unknown_hf_seeker}}
|
| seek out [CONTEXT:HIST_FIG:TRANS_NAME], wherever [CONTEXT:HIST_FIG:PRO_SUB] might be

|-
| {{text anchor|text_wandering_profession}}
|
| I wander [CONTEXT:PLACE:TRANS_NAME].

|-
| {{text anchor|text_wandering_profession_year}}
|
| I have wandered [CONTEXT:PLACE:TRANS_NAME] for [CONTEXT:NUMBER] of my years.
|}

== Adding custom files ==

New speech tokens can be added with mods. It is also possible to add new files and associate them with custom creatures.

{| class="wikitable"
|+ [[Creature token]]s
! Token !! Example uses

|-
| [[Creature token#SLAIN_CASTE_SPEECH|SLAIN_CASTE_SPEECH]]
| Replaces [[DF2014:Creature token#CASTE_SPEECH|CASTE_SPEECH]], [[DF2014:Creature token#SPEECH_FEMALE|SPEECH_FEMALE]], and [[DF2014:Creature token#SPEECH_MALE|SPEECH_MALE]] from older versions.

|-
| [[Creature token#LAIR_HUNTER_SPEECH|LAIR_HUNTER_SPEECH]]
| [[Minotaur]] ([[#lair_hunter_minotaur|lair_hunter_minotaur.txt]])

|-
| [[Creature token#SPEECH|SPEECH]]
| [[Dwarf]] ([[text_dwarf.txt]]), [[Elf]] (text_elf.txt)
|}

== List of Tokens ==

Speech files can contain tokens in square brackets (<code>[]</code>), which are replaced with context-specific strings before the speech is displayed.

=== Book title tokens ===

These tokens are used for [[Book#Titles|book titles]] and specific examples of [[Performer|performances]] such as songs, poems, or dances. It is unknown if the generating tokens can be used in other text sets to generate random words.

{| class="wikitable"
! Token !! Meaning !! Example

|-
| {{text anchor|NAME}}
| Inserts a name relevant to the book's [[topic]], or a random noun for art and star charts. Notably, these may or may not be plural and/or have an article.
| The [[Tower_(necromancy)|Tower]], The [[Forest retreat|Tree]], [[v0.31:Stories/Bronzemurder|Bronzemurder]], [[Book#History|Likot Ubendeb]], [[Book#Nature|Animal Behaviours]]
|-
| {{text anchor|NO_ART_NAME}}
| "No article name." As [[Speech_file#NAME|NAME]], but never has an article.
| Tower, Tree, Bronzemurder, Likot Ubendeb, Animal Behaviours
|-
| {{text anchor|NOUN}}
| A random noun pulled from [[language_words.txt]] or a hardcoded list. May or may not be plural.
| Despair, Roots, Scrolls, Wheel-and-axles
|-
| {{text anchor|ADJ}}
| A random adjective from [[language_words.txt]].
| Boyish, Inky, Angry, Bronzed
|-
| {{text anchor|ANY_AGE}}
| References an [[Calendar#Ages|age]] that has occurred in the world's [[Legends|history]].
| The Age Of Legends, The Age Of Hill Titan and Dragon
|-
| {{text anchor|ANY_PRONOUN}}
| Chosen from among singular and plural subject pronouns (not "Us" or "Them").
| He, She, We, They
|-
| {{text anchor|PHRASE}}
| A random phrase of a noun/pronoun, a verb, and some other words.
| The Fool Laughs, The Day Can Say It In The End, It Foretells Afterwards, The Day Mourns
|}

=== Dialogue tokens ===

Character dialogue uses its own set of tokens to reference data.
Scopes identify participants in a conversation and various forms of background information. They can be nested within each other in various cases. If the scopes refer to a historical object, it is expected [verify] that not using the TRANS_NAME argument will display the untranslated name.
Strings are the arguments for scopes, outputting a specific word based on the conversation data. In certain files, they are used by themselves with an implied scope.

{| class="wikitable"
! Token !! Type !! Meaning

|-
| {{text anchor|SPEAKER}}
| base scope
| The person speaking the dialogue.
|-
| {{text anchor|AUDIENCE}}
| base scope
| The person receiving the dialogue. Has buggy behavior without a defined audience, such as when shouting out to everyone.
|-
| {{text anchor|CONTEXT}}
| base scope
| Holds additional information depending on the subject of conversation. Must use HIST_FIG as its argument to retrieve personal info from a creature that isn't present.
|-
| {{text anchor|HIST_FIG}}
| scope
| Usually written as [CONTEXT:HIST_FIG], this refers to a historical figure referenced by the speaker.
|-
| {{text anchor|PLACE}}
| scope
| A location, such as a biome.
|-
| {{text anchor|SITE}}
| scope
| A site given by the context.
|-
| {{text anchor|HF_LINK}}
| scope
| Looks for historical figures [[Relationship|associated]] with the scope.
|-
| {{text anchor|DEITY}}
| scope
| An argument for [HF_LINK], in this case referring to a (presumably, devoutly worshipped) [[deity]].
|-
| {{text anchor|TRANS_NAME}}
| string
| The full translated name of the referenced object.
|-
| {{text anchor|FIRST_NAME}}
| string
| The first name of the referenced creature.
|-
| {{text anchor|PRO_SUB}}
| string
| The referenced creature's subject pronoun (she, he, it).
|-
| {{text anchor|PRO_OBJ}}
| string
| The referenced creature's object pronoun (her, him, it).
|-
| {{text anchor|PRO_POS}}
| string
| The referenced creature's possessive pronoun (her, his, its).
|-
| {{text anchor|ABSTRACT_BUILDING}}
| string
| The first name of the referenced creature.
|-
| {{text anchor|RACE}}
| string
| The [[Creature token#NAME|name]] of the context's species.
|-
| {{text anchor|NUMBER}}
| string
| A number (expressed as plain text rather than numerals?).
|-
| {{text anchor|ORDINAL}}
| string
| An ordinal number, such as first or second.
|-
| {{text anchor|UNIT_NAME}}
| string
| The [[Unit type token|unit type]] of the referenced creature.
|-
| {{text anchor|ARCH_ELEMENT}}
| string
| An architectural element given by the context.
|-
| {{text anchor|ABSTRACT_BUILDING}}
| string
| A named building given by the context.
|-
| {{text anchor|JUSTIFICATION}}
| string
| A [[Speech file#JUSTIFICATION_ANTITHETICAL|justification]] chosen by the context.
|-
| {{text anchor|DEF_SPHERE}}
| string
| A divine [[sphere]] chosen by the context.
|-
| {{text anchor|RANDOM_DEF_SPHERE}}
| string
| A random [[sphere]] associated with the scope.
|-
| {{text anchor|FAMILY_RELATIONSHIP}}
| string
| The [[relationship]] given by the context.
|}

=== Context tokens ===

These give special information about the background of the conversation.

{| class="wikitable"
! Token !! Meaning !! Example

|-
| [CONTEXT:ABSTRACT_BUILDING]
| building
|
* [[#ab_specific_hf_seeker|ab_specific_hf_seeker]]: the building in which the historical figure that the speaker wants you to seek is

|-
| [CONTEXT:HIST_FIG]
| creature
|
* [[#ab_specific_hf_seeker|ab_specific_hf_seeker]]: the historical figure the speaker wants you to seek

|-
| [CONTEXT:NUMBER]
| number
|
* [[#animal_slayer|animal_slayer]]: number of animals slain
* [[#child_age_proclamation|child_age_proclamation]]: age in years of the child

|-
| [CONTEXT:ORDINAL]
| number
|
* [[#current_profession_year|current_profession_year]]: the number of years the speaker has had their profession

|-
| [CONTEXT:PLACE]
| site
|
* [[#animal_slayer|animal_slayer]]: the place where the speaker slew the animals

|-
| [CONTEXT:RACE]
| race
|
* [[#animal_slayer|animal_slayer]]: the race of the animals the speaker has slain

|-
| [CONTEXT:SITE]
| site
|
* [[#ab_specific_hf_seeker|ab_specific_hf_seeker]]: the site where the historical figure the speaker wants you to seek is

|-
| [CONTEXT:UNIT_NAME]
| text
|
* [[#current_profession_no_year|current_profession_no_year]]: the name of the speaker's profession
|}

== See also ==
* [[Speech mods]]

[[Category:Files]]
[[Category:Modding]]