v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Editing Announcements.txt

Jump to navigation Jump to search

Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.

If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 
{{Quality|Tattered}}
 
{{Quality|Tattered}}
 
{{av}}
 
{{av}}
−
{{buggy}}
 
−
 
−
== Purpose ==
 
−
Both the [[Announcement]]s section of the in game [[Settings#Announcements|Settings]] and the '''announcements.txt''' file can be used to control the types of announcements are brought to the user's attention in Dwarf Fortress and how they will be displayed in various modes. This can be useful to add alerts for critical combat events, stopping the recentering upon birth events, or reducing the constant chatter of announcements like 'quota filled' or 'someone is visiting'.
 
−
 
−
The ''announcements.txt'' file reflects the in game Settings, Announcements tab. The table below has been updated with the [[Settings#Announcements|Settings]] Announcement 'Name' which corresponds to its ''announcements.txt EVENT_LABEL'' (slightly less obvious than you may assume in some cases).
 
−
 
−
=== Community Awareness - Dwarf Fortress filesystem (/prefs/ vs /data/init/) ===
 
 
{{File|DF/data/init/announcements.txt}}
 
{{File|DF/data/init/announcements.txt}}
−
{{File|DF/prefs/announcements.txt}}
+
{{Outdatedsection}}
−
Dwarf Fortress supports editing DF/'''data/init'''/file to adjust the '''Default''' [[Announcement]]s settings.<br>
+
'''Version 50.10: editing this file does not stop the spam of useless announcements like 'quota filled' or 'someone is visiting'.'''
−
Editing the same file in DF/'''prefs'''/ will make changes to the '''Current''' settings.<br>
 
−
This is the standard Dwarf Fortress file system organization.
 
  
−
In later versions (added in [[Release_information/50.10|v50.10]]) a new in game [[Settings#Announcements|Settings]] section, [[Announcement]]s, was added which makes this process easier. Though the purpose of each announcement for each can still be a bit obtuse.<br>
+
The '''announcements.txt''' file can be used to control the types of [[announcement]]s displayed in ''Dwarf Fortress'', and how they are displayed in various modes, which can often be useful to stop recentering on birth announcements, for example.
−
'''SEE''' [[#Bugs]] section below!<br>
 
−
The '''announcements.txt''' file exists in both locations, be sure to modify the DF/'''prefs'''/ version to experience the change to the '''current''' settings if you're changing a formerly played install or current game.<br>
 
−
This means that to confirm which ''announcement.txt'' EVENT_LABEL corresponds to an [[Announcement]] 'name' that you can,
 
−
# Open ''announcement.txt'' and identify the EVENT_LABEL you believe to be the right one
 
−
# Note it's '':options''
 
−
# Open [[Settings]] while in a game, and make a change to the Announcement 'name' you believe corresponds
 
−
# Clicking 'Done' and 'Return to game' will update DF/'''prefs'''/announcements.txt without exiting the game
 
−
# Reload ''announcement.txt'' and confirm the expected change to the '':options'' of the ''EVENT_LABEL'' previously identified
 
  
 
== Syntax ==
 
== Syntax ==
−
  ['''''EVENT_LABEL''''''':option:option''...]
+
  ['''ANNOUNCEMENT NAME''''':option:option''...]
 
=== Available options ===
 
=== Available options ===
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! [[Settings]]<br>Options
+
! Option
−
! announcements.txt<br>'':options''
 
 
! Description
 
! Description
 
! Notes
 
! Notes
 
|-
 
|-
−
| {{text anchor|Popup}}
+
| {{text anchor|D_D}} or {{text anchor|D_DISPLAY}}
−
| {{text anchor|BOX}} or {{text anchor|DO_MEGA}}
+
| Causes the announcement to appear under one of the categories at the left side of the screen in [[fortress mode]].
−
| Causes a box to appear in the middle of the screen, requiring a click on the Okay button to close it. If multiple boxes are displayed at the same time, the button says More and displays the next box.
+
| The default for [[Announcement#Minor announcements|minor announcements]] including profession changes, [[weather]], job cancellations, and striking new minerals while [[mining]].
−
| This is often used with [[Announcement#Game-changing announcements|game-changing announcements]].
+
|-
−
|  
+
| {{text anchor|A_D}} or {{text anchor|A_DISPLAY}}
 +
| Causes the announcement to be displayed at the bottom of the screen in [[adventure mode]] (and be viewable in the {{k|a}}nnouncements list).
 +
|
 
|-
 
|-
−
| {{text anchor|Pause}}
 
 
| {{text anchor|P}} or {{text anchor|PAUSE}}
 
| {{text anchor|P}} or {{text anchor|PAUSE}}
 
| Pauses the game when the announcement occurs.
 
| Pauses the game when the announcement occurs.
 
|
 
|
 
|-
 
|-
−
| {{text anchor|Recenter}}
 
 
| {{text anchor|R}} or {{text anchor|RECENTER}}
 
| {{text anchor|R}} or {{text anchor|RECENTER}}
 
| Recenters the game to the location of the announcement when the announcement occurs.
 
| Recenters the game to the location of the announcement when the announcement occurs.
 
| Commonly used for [[baby|births]], [[caravan]] arrivals, and [[ambush]]es. Use of this without the [[#PAUSE|pause]] option is not recommended, since your screen will recenter without warning.
 
| Commonly used for [[baby|births]], [[caravan]] arrivals, and [[ambush]]es. Use of this without the [[#PAUSE|pause]] option is not recommended, since your screen will recenter without warning.
 
|-
 
|-
−
| {{text anchor|Adv}}
+
| {{text anchor|BOX}} or {{text anchor|DO_MEGA}}
−
| {{text anchor|A_D}} or {{text anchor|A_DISPLAY}}
+
| Causes a box to appear in the middle of the screen, requiring a click on the Okay button to close it. If multiple boxes are displayed at the same time, the button says More and displays the next box.
−
| Causes the announcement to be displayed at the bottom of the screen in [[adventure mode]] (and be viewable in the {{k|a}}nnouncements list).
+
| This is often used with [[Announcement#Game-changing announcements|game-changing announcements]].
−
|
 
−
|-
 
−
| {{text anchor|Fort}}
 
−
| {{text anchor|D_D}} or {{text anchor|D_DISPLAY}}
 
−
| Causes the announcement to appear under one of the categories at the left side of the screen in [[fortress mode]].
 
−
| The default for [[Announcement#Minor announcements|minor announcements]] including profession changes, [[weather]], job cancellations, and striking new minerals while [[mining]].<br>While playing in Fortress mode, enabling/disabling Adv has no impact on your announcement experience.
 
 
|-
 
|-
−
| {{text anchor|Report}}
 
 
| {{text anchor|UCR}} or {{text anchor|UNIT_COMBAT_REPORT}}
 
| {{text anchor|UCR}} or {{text anchor|UNIT_COMBAT_REPORT}}
 
| Causes the announcement to appear in all [[reports]]. A new report will be created if none are active.
 
| Causes the announcement to appear in all [[reports]]. A new report will be created if none are active.
−
| Commonly used for logging combat details.  
+
| Commonly used for adventure mode combat moves.
 
|-
 
|-
−
| {{text anchor|Report (Active)}}
 
 
| {{text anchor|UCR_A}} or {{text anchor|UNIT_COMBAT_REPORT_ALL_ACTIVE}}
 
| {{text anchor|UCR_A}} or {{text anchor|UNIT_COMBAT_REPORT_ALL_ACTIVE}}
 
| Nearly identical to [[#UCR|UNIT_COMBAT_REPORT]], but does not create a new report if none are active.
 
| Nearly identical to [[#UCR|UNIT_COMBAT_REPORT]], but does not create a new report if none are active.
−
| There is no difference between having 'Report (Active)/UCR_A' and 'Report/UCR' enabled verse having only 'Report/UCR' enabled. Use Report (Active)/UCR_A for things you want in the combat reports that would be too chatty to always generate a combat report for (Urist Falls down) but don't forget to disable 'Report/UCR' or you won't get the benefit.
+
|
 
|-
 
|-
−
| {{text anchor|Alert}}
 
 
| {{text anchor|ALERT}}
 
| {{text anchor|ALERT}}
 
| Causes the announcement to appear under the alert button at the left side of the screen in [[fortress mode]].
 
| Causes the announcement to appear under the alert button at the left side of the screen in [[fortress mode]].
Line 77: Line 49:
 
|}
 
|}
  
−
== {{text anchor|List of announcements}} ==
+
== List of announcements ==
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! [[Settings]]<br>Name
+
! Settings>Announcements
−
! announcements.txt<br>EVENT_LABEL
+
! announcement.txt
 
! Example
 
! Example
 
! Description/Notes
 
! Description/Notes
Line 247: Line 219:
 
|
 
|
 
|-
 
|-
−
| {{text anchor|(Wrestle) Adjust grip}}
+
| {{text anchor|Adjust grip}}
 
| {{text anchor|COMBAT_WRESTLE_ADJUST_GRIP}}
 
| {{text anchor|COMBAT_WRESTLE_ADJUST_GRIP}}
 
|
 
|
 
|-
 
|-
−
| {{text anchor|(Wrestle) Part ripped away}}
+
| {{text anchor|Part ripped away}}
 
| {{text anchor|COMBAT_GRAB_TEAR}}
 
| {{text anchor|COMBAT_GRAB_TEAR}}
 
|
 
|
 
|-
 
|-
−
| {{text anchor|(Combat) Strike}}
+
| {{text anchor|Strike}}
 
| {{text anchor|COMBAT_STRIKE_DETAILS}}
 
| {{text anchor|COMBAT_STRIKE_DETAILS}}
 
|
 
|
 
|-
 
|-
−
| {{text anchor|(Combat) Wounds}}
+
| {{text anchor|Wounds}}
 
| {{text anchor|COMBAT_STRIKE_DETAILS_2}}
 
| {{text anchor|COMBAT_STRIKE_DETAILS_2}}
 
|
 
|
 
|-
 
|-
−
| {{text anchor|(Combat) Enraged}}
+
| {{text anchor|Enraged}}
 
| {{text anchor|COMBAT_EVENT_ENRAGED}}
 
| {{text anchor|COMBAT_EVENT_ENRAGED}}
 
| {{DFtext|The Wolf has become enraged!|4:1}}
 
| {{DFtext|The Wolf has become enraged!|4:1}}
 
|-
 
|-
−
| {{text anchor|(Combat) Attack stuck in}}
+
| {{text anchor|Attack stuck in}}
 
| {{text anchor|COMBAT_EVENT_STUCKIN}}
 
| {{text anchor|COMBAT_EVENT_STUCKIN}}
 
| {{DFtext|The *bronze spear* has lodged firmly in the wound!|5:1}}
 
| {{DFtext|The *bronze spear* has lodged firmly in the wound!|5:1}}
 
|-
 
|-
−
| {{text anchor|(Combat) Natural attack latched}}
+
| {{text anchor|Natural attack latched}}
 
| {{text anchor|COMBAT_EVENT_LATCH_BP}}
 
| {{text anchor|COMBAT_EVENT_LATCH_BP}}
 
|
 
|
 
|-
 
|-
−
| {{text anchor|(Combat) Attack latched}}
+
| {{text anchor|Attack latched}}
 
| {{text anchor|COMBAT_EVENT_LATCH_GENERAL}}
 
| {{text anchor|COMBAT_EVENT_LATCH_GENERAL}}
 
| {{DFtext|The Wolf latches on firmly!|5:1}}
 
| {{DFtext|The Wolf latches on firmly!|5:1}}
 
|-
 
|-
−
| {{text anchor|(Combat) Propelling blow}}
+
| {{text anchor|Propelling blow}}
 
| {{text anchor|COMBAT_EVENT_PROPELLED_AWAY}}
 
| {{text anchor|COMBAT_EVENT_PROPELLED_AWAY}}
 
| {{DFtext|The Wolf is propelled away by the force of the blow!|6:1}}
 
| {{DFtext|The Wolf is propelled away by the force of the blow!|6:1}}
 
|-
 
|-
−
| {{text anchor|(Combat) Knocked out}}
+
| {{text anchor|Knocked out}}
 
| {{text anchor|COMBAT_EVENT_KNOCKED_OUT}}
 
| {{text anchor|COMBAT_EVENT_KNOCKED_OUT}}
 
| {{DFtext|The Wolf has been knocked unconscious!|7:1}}
 
| {{DFtext|The Wolf has been knocked unconscious!|7:1}}
 
|-
 
|-
−
| {{text anchor|(Combat) Stunned}}
+
| {{text anchor|Stunned}}
 
| {{text anchor|COMBAT_EVENT_STUNNED}}
 
| {{text anchor|COMBAT_EVENT_STUNNED}}
 
| {{DFtext|The Wolf has been stunned!|3:1}}
 
| {{DFtext|The Wolf has been stunned!|3:1}}
 
|-
 
|-
−
| {{text anchor|(Combat) Winded}}
+
| {{text anchor|Winded}}
 
| {{text anchor|COMBAT_EVENT_WINDED}}
 
| {{text anchor|COMBAT_EVENT_WINDED}}
 
| {{DFtext|The Wolf is having trouble breathing!|7:0}}
 
| {{DFtext|The Wolf is having trouble breathing!|7:0}}
 
|-
 
|-
−
| {{text anchor|(Combat) Nauseated}}
+
| {{text anchor|Nauseated}}
 
| {{text anchor|COMBAT_EVENT_NAUSEATED}}
 
| {{text anchor|COMBAT_EVENT_NAUSEATED}}
 
| {{DFtext|The Wolf looks sick!|2:1}}
 
| {{DFtext|The Wolf looks sick!|2:1}}
Line 1,751: Line 1,723:
 
|
 
|
 
|}
 
|}
−
== Bugs ==
 
−
* Removing an '':option'' from <code>DF'''/prefs/'''announcements.txt</code> will not disable that option if it is enabled by <code>DF'''/data/init/'''announcements.txt</code>
 
−
** Workaround - remove the option from both <code>DF'''/prefs/'''announcements.txt</code> and <code>DF'''/data/init/'''announcements.txt</code>
 
−
 
  
 
{{gamedata}}
 
{{gamedata}}
 
{{files}}
 
{{files}}
 
[[ru:Announcements.txt]]
 
[[ru:Announcements.txt]]

Please note that all contributions to Dwarf Fortress Wiki are considered to be released under the GFDL & MIT (see Dwarf Fortress Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following CAPTCHA:

Cancel Editing help (opens in new window)

Templates used on this page:

This page is a member of 1 hidden category:

Retrieved from "https://dwarffortresswiki.org/index.php/Announcements.txt"