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 Legends

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|Unrated}}
+
 
 +
{{Quality|Exceptional|06:48, 6 October 2013 (UTC)}}
 
{{av}}
 
{{av}}
[[File:Vanitas still life.jpg|thumb|250px|right|Only two things are certain in ''Dwarf Fortress'': [[Fun]], and the legends you leave behind.]]
 
  
'''Legends''' mode is one of the three main methods of interacting with an already-generated [[World generation|world]]. In Legends mode, players can view maps, histories of each civilization and any figure who has lived or died in the generated world. Any noticeable achievement made by the player in [[Dwarf fortress mode|Fortress]] or [[Adventurer mode|Adventurer]] mode is recorded and is viewable in Legends mode. You may explore Legends mode after you generate a new world.  
+
'''Legends''' mode is one of the three main methods of interacting with an already-generated [[World generation|world]]. You cannot start Legends mode (or [[Dwarf fortress mode|Fortress]] or [[Adventurer mode|Adventurer]] mode) until you create a new world.  
  
Many players choose to generate a world where the option '[[Advanced_world_generation#Reveal_All_Historical_Events|Reveal All Historical Events]]' is set to YES (the default) - however, if you set the option to NO, then the vast majority of the world history will be hidden in Legends mode until uncovered by brave adventurers. Even when set to YES, some things may not be revealed; all ''events'' will be revealed, but some [[historical figure]]s, [[site]]s, [[region]]s, and [[civilization]]s and other entities may ''not'' be, possibly because they are not known to any civilization.
+
Legends mode allows you to inspect the history of a world. Many players choose to generate a world where the option '''[[Advanced_world_generation#Reveal_All_Historical_Events|Reveal All Historical Events]]''' is set to YES (the default) - however, if you set the option to NO, then the vast majority of the world history will be hidden in Legends mode until uncovered by brave adventurers. Even when set to YES some things may not be revealed; all events will be revealed, but some [[Historical figure]]s, [[Site]]s, [[Region]]s, and [[Civilization]]s and other entities may not be, possibly because they are not known to any civilization.
  
 
Ways for an adventurer to uncover events and other things include:
 
Ways for an adventurer to uncover events and other things include:
Line 11: Line 11:
 
* viewing items with images, like [[coin]]s, [[armor]], [[engraving]]s, [[statue]]s, etc
 
* viewing items with images, like [[coin]]s, [[armor]], [[engraving]]s, [[statue]]s, etc
 
* finding artifacts and [[book]]s and other written works
 
* finding artifacts and [[book]]s and other written works
* possibly reading written works{{verify}} or by listening to stories and songs{{verify}}  
+
* possibly reading written works{{verify}}
 +
* possibly by listening to stories and songs{{verify}}  
 +
 
 +
You don't ''have'' to have had an adventurer or fortress game active in order to use Legends mode - some players simply enjoy it for the option of looking at the interactive historical map, or to read about the last time their favorite kingdom went to war, or for the ability to export lists of all the sites and governments active in the world. In fact, Legends Mode cannot be entered if there is an active adventurer or fortress in the world. However, a copy of such a world can be made, loaded in the game and the current mode retired or abandoned, then opened in Legends mode.
 +
 
 +
==Legends information==
 +
 
 +
=== Number of Events Undiscovered ===
 +
A self-explanatory number indicating how many "legends" are still lost in the mists of time. If you chose to reveal all history during world generation, the number displayed should be 0. Otherwise, better get out there and adventure some more.
  
You don't ''have'' to have had an adventurer or fortress game active in order to use Legends mode - some players simply enjoy it to read about the last time their favorite kingdom went to war, or learn about the dwarven civilizations before choosing to embark, etc. In fact, Legends Mode cannot be entered if there is an active adventurer or fortress in the world. However, a copy of such a world can be made, loaded in the game and the current mode retired or abandoned, then opened in Legends mode.
+
=== Historical Figures ===
 +
The number to the right indicates how many [[historical figure]]s exist in this world's history. Historical figures include entries on [[megabeast]]s, [[forgotten beast]]s, [[demon]]s, [[deity|gods]], [[Dwarf|dwarves]], [[human]]s, [[goblin]]s, [[kobold]]s, and named [[creature]]s.
  
== Accessing Legends Mode ==
+
=== Sites ===
When you choose "Start Playing" in a world that doesn't have a current active game, the options include Legends mode. By accessing Legends mode, you are deciding to reveal all the knowledge of the world that would otherwise be discoverable only in pieces, through Fortress or Adventurer Mode.
+
The number to the right indicates how many [[site]]s have existed throughout this world's history. [[Site]]s include things like [[town]]s, [[Tower (necromancy)|tower]]s, [[fortress]]es, [[forest retreat]]s, and [[cave]]s.
  
:Note: If you are already playing a fortress on the save you want to use, you can save to a new timeline after choosing to retire or abandon, both leaving the active fortress and allowing access to Legends mode in the new timeline.
+
=== Regions ===
 +
A list of the various [[regions]] of the world, along with the various historical events that occurred within those regions.
  
=== Navigation ===
+
=== Civilizations and Entities ===
Upon entering legends mode, the player is presented with a list of categories.
+
The number to the right indicates how many [[civilizations]], local governments, and religions have existed throughout this world's history. The histories of these various groups can be viewed as well, detailing events like when a site was founded, when a person was kidnapped, or when a road was completed.
To the right of each category is the number of entries for that category.
 
[[File:Legends menu v50.png|thumb|Legends Mode landing page]]
 
  
Clicking into a category opens a tab for that category, with a list of entries for that category.
+
=== Structures ===
The entries will be displayed with a name on the left, and (usually) a pertinent piece of information on the right.
+
Structures are buildings found throughout the world. Fortresses, towers, shops, taverns, temples and more can all be found in this list.
[[File:Legends artifacts list.png|thumb|Example of Artifacts entries]]
+
Temples are the central location of [[religion]]s, and can be 'profaned' by historical figures, though it is not explained what this involves.
  
Clicking into a specific entry opens the entry's legend page, consisting of a  
+
=== Historical Map ===
* Title (dwarven name, english translation, what it is)
+
The historical map is a very cool feature of Legends mode - from here you can view the territorial disputes between different civilizations and entities, including those that were destroyed before your starting year. If you are new to ''Dwarf Fortress'', reading the map may be a little difficult, but play around with these buttons and you might get a better grasp of what you are seeing. Press {{k|Enter}} while looking at the map to change between the political and geographical view of the world. The geographic map is colored (blue seas, gray mountains, green forests etc.) while the political map's background is tan (think parchment) with colored fields corresponding to the territories of different civilizations. Multiple civilizations can lay claim to the same area, causing the colored territory markers to overlap. You can also see how territories change over time by moving 10 or 100 years forward and back through time. Pressing {{k|c}} while looking at the political map will show local government territories instead of civilizations, but that's generally a pretty messy scene.
* Description
 
* Events
 
* Notable Stats (kills, relatives, etc)
 
** Some entry types don't have any stats, such as sites
 
[[File:Legends artifact entry rulnimak.png|thumb|Legends mode entry for the artifact Rulnimak]]
 
  
On the entry's legend page, all highlighted phrases are hyperlinks to other entries (the color of the highlight indicates what category the entry is in).
+
=== The Age of... ===
Clicking on one of these will open a new tab for that entry.
+
During world generation, the [[Calendar#Ages|Ages]] are named for the greatest powers extant in the world. Ages commonly advance during world generation (e.g. Age of Legends, Age of Heroes, Age of Humans) due to the death of megabeasts, and they sometimes even regress due to the creation of [[night creature]]s and the birth of new [[megabeast]]s. When you choose to look at the history of an [[Calendar#Ages|Age]], you will be given a list of all historical events in chronological order. Here you can read the battle reports from various wars, or the duels that took place between long dead champions, or the <s>burninations</s> rampages of [[megabeast]]s amongst the [[peasant]]s.  See [[Calendar#Ages|here]] for a list of ages and their conditions.
  
 +
==Exporting information from Legends Mode==
  
===Categories===
+
Legends mode has built-in tools to export lists of events, maps at various scales, and data such as locations of sites.  This is particularly useful as input data for the utilities described below; there are even tools to make this export process easier. 
  
The following table provides a brief description of the different categories
+
=== Accessing Legends Mode ===
of entries accessible in legends mode.
+
By accessing Legends mode, you are deciding to reveal all the knowledge of the world that would otherwise be discoverable only in pieces, through Dwarf Fortress or Adventurer Mode. This mode is only accessible when you do not have an active fortress or adventurer in the world. Most players choose to make a copy of their existing world from the [[Saved_game_folder|Save folder]] and then retire the fortress from that copy. When you chose "Start Playing" again from that copied world, you will be presented with Legends Mode option.
The "List Detail" is the information that is visible to the right of the name
 
when viewing the category, and the "Stats" column describes what sort of information
 
is available beneath the event list when viewing the entry's legends page.
 
  
{| class="wikitable"
+
=== XML dump ===
|+ Caption text
 
|-
 
! Category !! Link Color !! List Detail !! Stats !! Description
 
|-
 
| Historical Figures
 
  || Blue
 
  || Birth/Death year
 
  || Related Historical Figures, Related Entities, Kills
 
  || [[megabeast]]s, [[forgotten beast]]s, [[demon]]s, [[deity|gods]], [[Dwarf|dwarves]], [[human]]s, [[goblin]]s, [[kobold]]s, and other named [[creature]]s
 
|-
 
| Sites
 
  || Orange
 
  || Site Type
 
  ||
 
  || See [[Site]]
 
|-
 
| Artifacts
 
  || Yellow
 
  || [[Item]] material/type
 
  || Kills, Slayer (wielder during the kill)
 
  || See [[Legendary artifact]]
 
|-
 
| Codices, scrolls, etc.
 
  || Pink
 
  || [[Item]] material/type
 
  ||
 
  || Items with writing from around the world. Includes all sorts of [[books]], [[slabs]], etc
 
|-
 
| Regions
 
  || Green
 
  ||
 
  ||
 
  || See [[Region]]
 
|-
 
| Underground regions
 
  || Purple
 
  ||
 
  ||
 
  || These regions appear to all be "Unnamed underground area", and other events will refer to them as "the depths of the world". Forgotten beasts seem to spawn here.
 
|-
 
| Civilizations and other entities
 
  || Teal
 
  ||
 
  ||
 
  || [[civilization]]s, local governments, and [[religion]]s, etc
 
|-
 
| Structures
 
  || N/A
 
  || Structure Type
 
  ||
 
  || Constructed/erected buildings found in sites. See [[structures]]
 
|-
 
| Chronicles by age
 
  || N/A
 
  || Number of historical events
 
  ||
 
  || A list of all historical events in chronological order that occur within a specific Age in the world history. Here, you can read the battle reports from various wars, or the duels that took place between long-dead champions, or the <s>burninations</s> rampages of [[megabeast]]s amongst the [[peasant]]s.  See [[Ages|here]] for a list of ages and their conditions.
 
  
|}
+
Once you've generated a world, you can dump much of the historical data into an XML file for external analysis. The XML dump currently doesn't include every detail of world history, but it contains many of the important ones. Be warned that a large world with, say, 1000 years (or even 10,000) of history can produce an XML dump up to a full gigabyte in size, which may prove unwieldy. Press {{k|x}} while in Legends mode to produce an XML dump (it will be placed in the root ''Dwarf Fortress'' directory and named the same as your game's save folder) See [[Main:XML dump|XML dump]] for information on the XML file's format.
  
==Exporting World information==
+
=== Export Map/Gen Information===
 +
Another option is to export the map/gen information by pressing {{k|p}} in Legends mode. This produces three .txt files and one bitmap image that are placed in the root directory of ''Dwarf Fortress''.  The exported data files are named by the save file name, and the current world date:
 +
# (save name)-world_gen_param.txt - contains the world generation settings.
 +
# [[World History file|(save name)-(year)-(month)-(day)-world_history.txt]] - Includes some information about the deities, and rulers of the Human, Dwarven, Elven, and Goblin civilizations.
 +
# [[World Sites file|(save name)-(year)-(month)-(day)-world_sites_and_pops.txt]]  - Lists the sites' population, owner, parent civilization and warlord. This one will also list all the animal populations above and below ground including demons.
 +
# (save name)-(year)-(month)-(day)-world_map.bmp  - This is the full world map as it is shown on the embark screen, and unlike the detailed maps below will depend on the tileset and colour scheme you have installed.
  
Legends mode has a built-in tool to export xml. This is particularly useful as input data for the utilities described below; there are even tools to make this export process easier (see next section).
+
=== Export Detailed Maps ===
 +
Pressing {{k|d}} in Legends mode reveals a list of the different kinds of map you can export. The images are exported to the game's root directory when you highlight the one you want and press {{k|Enter}}.
  
In previous versions there were [[DF2014:Legends#Exporting_World_information|additional export options]] (maps, text files, etc), but these are not currently available due to ...[[missing features|well, time constraints]].
+
*'''Standard biome+site map (detailed map)
Note that the inclusion of maps and map exports in legends mode is planned to be re-added in the near future.{{cite|putnam-reddit|https://www.reddit.com/r/dwarffortress/comments/15jwh5q/comment/jv36ot3}}
+
*[[Advanced_world_generation#Elevation|Elevations]] incl. lake and ocean floors
 +
*[[Advanced_world_generation#Elevation|Elevations]] respecting water level
 +
*[[Advanced_world_generation#Temperature|Temperature]]
 +
*[[Advanced_world_generation#Rainfall|Rainfall]]
 +
*[[Advanced_world_generation#Drainage|Drainage]]
 +
*[[Advanced_world_generation#Savagery|Savagery]]
 +
*[[Advanced_world_generation#Volcanism|Volcanism]]
 +
*[[Vegetation|Current vegetation]]
 +
*[[Evil]]
 +
*[[Water|Salinity]]
 +
* Diplomacy
 +
* Hydrological map (rivers, streams, lakes, oceans)
 +
* [[Noble|Nobility]]
 +
* Cadaster (Structures, roads, ...)
 +
* [[Trading|Trade]]
  
=== XML dump ===
+
<gallery>
 +
Image:Standard biome and site map.png|Biome & site map
 +
Image:World_graphic-el-region5-203-10075.PNG|Elevation incl. lake and ocean floors
 +
Image:World_graphic-elw-region5-203-10075.PNG|Elevation respecting water level
 +
Image:World graphic-tmp-region5-203-10075.PNG|Temperature
 +
Image:World_graphic-rain-region5-203-10075.PNG|Rainfall
 +
Image:World_graphic-drn-region5-203-10075.PNG|Drainage
 +
Image:World_graphic-sav-region5-203-10075.PNG|Savagery
 +
Image:World_graphic-vol-region5-203-10075.PNG|Volcanism
 +
Image:World_graphic-veg-region5-203-10075.PNG|Current vegetation
 +
Image:World_graphic-evil-region5-203-10075.PNG|Evil
 +
Image:World_graphic-sal-region5-203-10075.PNG|Salinity
 +
</gallery>
  
Once you've generated a world, you can dump much of the historical data into an XML file for external analysis. The XML dump currently doesn't include every detail of world history, but it contains many of the important ones. Be warned that a large world with, say, 1000 years (or even 10,000) of history can produce an XML dump up to a full gigabyte in size, which may prove unwieldy. Clicking the Export XML button (shown below) while in Legends mode to produce an XML dump (it will be placed in the root ''Dwarf Fortress'' directory and named the same as your game's save folder) See [[Main:XML dump|XML dump]] for information on the XML file's format.
+
==Legends Utilities==
[[File:Legends export xml button.png|frame|none]]
 
  
== Utilities & Tools ==
+
There are many [[utilities]] that work with the data exported from Legends mode, or make exporting that info easier.   
{{Main|Utilities#Legends tools}}
 
There are many utilities that work with the data exported from Legends mode (or at least were before v50), or make exporting that info easier.   
 
  
 
===Export tools===
 
===Export tools===
  
When using [[DFHack]], you can use the built-in <code>exportlegends</code> to export the "detailed" data in an XML. By default with DFHack enabled, this will automatically run when the export XML button is clicked, generating both the vanilla **and** detailed xml files{{cite|DFHack Docs: exportlegends|https://docs.dfhack.org/en/stable/docs/tools/exportlegends.html}}.
+
[http://dffd.wimbli.com/file.php?id=7696 The dfhack script 'exportmaps'] will export all detailed maps, saving a lot of time on large worlds compared to exporting them individually and waiting for each to finish.  [https://github.com/PeridexisErrant/dfhack/blob/master/scripts/exportlegends.lua exportlegends] likewise exports all detailed maps, as well as their worldgen info and legends XML. 
 +
 
 +
[http://www.bay12forums.com/smf/index.php?topic=131307 Export processing script] can automate processing of Legends information, and is included in the Windows [[Utility:Lazy_Newb_Pack|Lazy Newb Pack]]. If GIMP is installed, the script will use Dwarf Map Maker (see below); optipng can be used to compress the images from bitmaps to .png files. This tool also removes non-printing ASCII characters from the XML dump that can crash Legends Viewer (usually caused by DFHack's workflow), and creates a compressed folder for each region suitable for Legends Viewer (or simply compresses the XML if some parts have not been exported).
  
 
===Legends viewing tools and visualisers===
 
===Legends viewing tools and visualisers===
  
Unfortunately, it appears that the most famous such utility, [[Utilities#Legends_Viewer|Legends Viewer]], is no longer maintained with the steam release{{cite forum|154617.450}}{{cite|GitHub LegendsViewer|https://github.com/Kromtec/LegendsViewer}}.
+
The most famous is likely [[Utilities#Legends_Viewer|Legends Viewer]], an alternative interface that recreates legends mode from exported data with many more features such as graphs, filtering, sorting, and hyperlinks. There are alternative tools with similar functionality, including [[DF2014:Utilities#World_Viewer|World Viewer]].  
Members are working on other utilities, such as [https://github.com/itsiggyboy/DwarvenSurveyor Dwarven Surveyor]{{cite reddit|15jwh5q}}, but they are not at feature parity with what Legends Viewer supplied pre-v50.
+
 
 +
[http://www.bay12forums.com/smf/index.php?topic=73095.msg2261106#msg2261106 The Dwarf Map Maker] is available as a GIMP script (free software) or a photoshop actionscript.  Both use the detailed maps to produce a pretty fantasy map that looks somewhat like a satellite image.  The GIMP script is called as part of PeridexisErrant's legends processing script, if the dependencies are present.
  
 
{{Translation| dwarven = gomath | elvish = liceva | goblin = olzul | human = en}}
 
{{Translation| dwarven = gomath | elvish = liceva | goblin = olzul | human = en}}
  
 
{{Category|Guides}}
 
{{Category|Guides}}
{{Category|Legends mode}}
 
 
[[ru:Legends]]
 
[[ru:Legends]]

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)

This page is a member of 2 hidden categories: