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.

Graphics

From Dwarf Fortress Wiki
Jump to navigation Jump to search
This article is about the current version of DF.
Note that some content may still need to be updated.

Graphics v50 preview.png
For a list of all Premium graphics tokens and basic usage, see Graphics token.
For a repository of all Classic tilesets used in DF, see Tileset repository.
For details on creating Classic tilesets, see Tileset repository.

The graphics system in v50 is still being reverse engineered. It is a custom solution which appears to involve compositing graphics sets directly in C++ before texmapping them to SDL. This blitting approach is software rendered and so largely doesn't use hardware acceleration on graphics cards. This system means that despite graphics sets supporting rudimentary animation, there is no traditional sprite mapping, which places extensive limits on the types of graphics that are possible. While the number of user editable graphics sets has increased significantly in v50, many game elements are still hard coded graphics sets, or using a tileset over the older style graphics from classic DF.

Premium Graphics[edit]

For a list of all Premium graphics tokens and basic usage, see Graphics token.

The [OBJECT:GRAPHICS] object defines the use of various tile-based graphics in the game. As of version 50.01, graphics tokens have been greatly expanded to accommodate the release of the Steam & Itch premium version. This section is a basic description of how to define various types of graphics.

Making custom graphics requires multiple interacting files to function:

  1. An 8bit RGBA (sometimes called 32bit) "imagename.png" in the \<mod_id>\graphics\images folder
  2. A "tile_page_name.txt" in the \<mod_id>\graphics folder
  3. A "graphics_type_name.txt" in the \<mod_id>\graphics folder

Mods can reuse any graphics loaded ahead of them (including vanilla) by using the same tile page token.


Tile Page[edit]

Tile pages link image files to a tile page token so they can be referenced by the graphics file. Just like all other Raw files, Tile Pages must be defined from within a properly named "tile_page_<name>.txt" file and follow:

tile_page_<name>

[OBJECT:TILE_PAGE]

After the object type is defined as above, any number of tile pages can be defined according to the format below.

  [TILE_PAGE:<tile page identifier>]
     [FILE:images/imagename.png]
     [TILE_DIM:<tile x dim>:<tile y dim>]
     [PAGE_DIM_PIXELS:<page x dim>:<page y dim>]
  • tile page identifier: The Internal ID being created for the image.
  • imagename.png: The file name of the 8bit RGBA (sometimes called 32bit) in the \graphics\images folder of the mod.
  • tile x dim: The width of each tile in pixels (usually 32).
  • tile y dim: The height of each tile in pixels (usually 32).
  • page x dim: The width of the image file in pixels.
  • page y dim: The height of the image file in pixels.

Known issues:

  • Currently it is only recommended to use [TILE_DIM:32:32] as only the upper left 32×32 pixels are displayed on tiles defined larger, and smaller tiles are displayed starting from the upper left of each in-game square (individually by tile with large graphics) rather than centered and bottom justified as might be expected.
  • It is important that the [PAGE_DIM_PIXELS:<x dim>:<y dim>] matches the size of the referenced image exactly - as the game will stretch tile pages with a dimension larger than the actual image by inserting blank lines, and a tile page smaller than the image will cause a crash to desktop.

Creature Graphics[edit]

For a list of all known creature graphics tokens, see Graphics token#Creature Graphics..

Creature graphics are found within graphics_creature_x files (such as graphics_creature_domestic or graphics_creature_layered). All graphics files must begin with the file name, followed by the [OBJECT:GRAPHICS] token that tells the game that the file contains graphics definitions.

Basic Graphics[edit]

The most basic form of creature graphics is a single tile, defined below:

[CREATURE_GRAPHICS:<creature id>]
   [<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]
  • condition: The condition the creature needs to be in for this image to be displayed. Use DEFAULT for generic graphics.
  • creature id: The Creature ID of the creature the graphics represent.
  • tile page identifier: The Internal ID of the image defined in the Tile Page.
  • x position: The x position of the graphic to be displayed in tiles counting from 0 (left→right).
  • y position: The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
  • color type: (optional) Uncertain function, frequently replaced with AS_IS in vanilla RAWs. ColorTypeEnum[1]
  • secondary condition: (optional) An additional condition that must be satisfied for the image to be displayed.

When the condition [DEFAULT] is used, this graphic will be displayed for the creature in all conditions unless additional, more specific conditions are also defined.

Basic Conditions

Different graphics can be defined for the same creature based on some properties about it. Below is a list of the most common creature conditions tokens.

Condition Accepts
Secondary
Description
[DEFAULT] No The default condition that will be displayed unless overwritten by a more specific one below.
[CHILD] Yes Will only be displayed if the creature is a [CHILD] or [BABY] and is younger than one of those ages.
[ANIMATED] Yes Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from [CONDITION_SYN_CLASS] or from having [NOT_LIVING]/[OPPOSED_TO_LIFE].
[CORPSE] Yes Displayed as soon as the creature dies.
[LIST_ICON] Unknown Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise.


Caste Graphics[edit]

Creature caste graphics allow a simple alternative to Layered Graphics to represent males and females of a creature with different images.

[CREATURE_CASTE_GRAPHICS:<creature id>:<caste id>]
   [<condition>:<tile page identifier>:<x position>:<y position>:<color type>:<secondary condition>]
  • caste id: The Caste ID of the caste whose graphics are being defined.
  • All other parameters are identical to basic graphics.

Creature caste graphics only accept MALE and FEMALE as caste id's even in creatures that have more than two castes.


Large Graphics[edit]

The only difference between graphics for large creatures and small creatures is the addition of LARGE_IMAGE and additional coordinates to the line below:

   [<condition>:<tile page identifier>:LARGE_IMAGE:<x1>:<y1>:<x2>:<y2>:<color type>:<secondary condition>]
  • LARGE_IMAGE: This tag allows a rectangular image with multiple tiles to be defined by its upper left and lower right tiles. Valid for 1x1 - 3x2 tiles.
  • x1: The x position of the upper left tile counting from 0 from the left of the tile page.
  • y1: The y position of the upper left tile counting from 0 from the top of the tile page.
  • x2: The x position of the lower right tile.
  • y2: The y position of the lower right tile.
  • All other parameters are identical to basic graphics.

Large images and small images can be used within the same CREATURE_GRAPHICS or CREATURE_CASTE_GRAPHICS definition, and in fact it is often useful to include a single tile image to act as a [LIST_ICON] for menus.


Statue Graphics[edit]

Statue graphics are the generic images placed on top of a pedestal whenever a creature is the primary subject of a statue. The image is implied to occupy multiple tiles, and all examples in vanilla are 1x2 vertical rectangles. Statue graphics are defined as below:

[STATUE_CREATURE_GRAPHICS:<creature id>]
       [DEFAULT:STATUES_LAYERED:<x1>:<y1>:<x2>:<y2>]
  • creature id: The Creature ID the graphics represent.
  • x1: The x position of the upper left tile counting from 0 from the left of the tile page.
  • y1: The y position of the upper left tile counting from 0 from the top of the tile page.
  • x2: The x position of the lower right tile.
  • y2: The y position of the lower right tile.


Layered Graphics[edit]

Layered graphics are a method for displaying overlapping body parts, equipment, clothing, professions, hairstyles.. etc. They allow much more freedom in conditions than normal basic graphics, and they allow combinations of many graphical variations within the same creature to give your graphics more personality and display more information about the individuals. All layered graphics started as shown below:

[CREATURE_GRAPHICS:<creature id>]
	[LAYER_SET:<condition>]
  • creature id: The Creature ID of the creature the graphics represent.
  • condition: The condition the creature needs to be in for this set of layers to be displayed.

Once you start defining a Layer Set, you can begin adding individual layers from the bottom up to create your final image. For example, if you want to draw a helmet being worn on a head, you would define the head layer first, then define the helmet layer. Layers are defined according to this format:

[LAYER:<layer name>:<tile page id>:<x position>:<y position>:<color type>]
	[<layer condition(s)>]
  • layer name: The internal name of the layer. No known function at this time, but using a descriptive label is recommended.
  • tile page identifier: The Internal ID of the image defined in the Tile Page.
  • x position: The x position of the graphic to be displayed in tiles counting from 0 (left→right).
  • y position: The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
  • LARGE_IMAGE:x1:y1:x2:y2: (optional) Allows a multiple tile image to be displayed. Replaces <x position>:<y position>.
  • color type: (optional) Uncertain function, frequently replaced with AS_IS in vanilla RAWs. ColorTypeEnum[2]
  • layer condition(s): One or more conditional tokens that define under what conditions the layer is displayed and how it interacts with other layers.


Forgotten Beast Graphics[edit]

Forgotten beast graphics define layered graphics based on which body parts are present in each procedurally-generated forgotten beast.

   [TILE_GRAPHICS_RECTANGLE:<tile page id>:<x1>:<y1>:<x2>:<y2>:<beast body token>]
  • tile page identifier: Internal ID of the image defined in Tile Page.
  • x1: The x position of the upper left tile counting from 0 from the left of the tile page.
  • y1: The y position of the upper left tile counting from 0 from the top of the tile page.
  • x2: X position of the lower right tile.
  • y2: Y position of the lower right tile.
  • beast body token: The internal ID of generated forgotten beast body types and body parts.

The TILE_GRAPHICS_RECTANGLE token displays a large image with the upper left corner being defined by <x1>, <y1> and the lower right corner defined by <x2>, <y2>. The <beast body token> is a conditional token that causes the graphics for each layer to be displayed only when the forgotten beast has that particular body type or part.[Verify]

There is not currently a way to use procedurally defined graphics like this for non-[FEATURE_BEAST] creatures.[Verify]

Item Graphics[edit]

Item graphics can also be defined, but are mostly hardcoded. This section of the wiki needs to be fleshed out.


World Map Graphics[edit]

World map graphics come in two variations:

   [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>]
   [TILE_GRAPHICS:<tile page identifier>:<x position>:<y position>:<graphic id>:<variation {1 - 5}>]
  • tile page identifier: The Internal ID of the image defined in the Tile Page.
  • x position: The x position of the graphic to be displayed in tiles counting from 0 (left→right).
  • y position: The y position of the graphic to be displayed in tiles counting from 0 (top→bottom).
  • graphic id: The Graphic Token of the world map tile the graphics represent.
  • variation {1 - 5}: For Graphic IDs that allow variants.

These values can be validated by checking the RAW vanilla file [DF Installion]\data\vanilla\vanilla_world_map\graphics\graphics_world_map.txt

Classic Graphics[edit]

For a list of all tile characters used in DF, see Tilesets.
For a chart with the default ASCII characters, see Character table.
For user-created creature tilesets, see Tileset repository.
For information about Graphic sets, see Graphic set.
For information on how tilesets get colored, see color.

General Information[edit]

Although commonly referred to as text or "ASCII"-graphics, classic DF uses a bitmap tileset* with characters from the IBM Code Page 437, displayed with a foreground and background color picked from 16 predefined colors. Text files (and often hardcoded values) define the tile, and colors of all objects. Both color scheme and tileset can be changed (see below), and definitions that are in text files can be modified. In addition, interface text can be displayed with a TrueType font and creatures (which normally are displayed as letters) can be assigned to separate tilesets called graphic sets. The main tileset is sometimes called "character tileset", while the graphic sets are also referred to as "object tilesets".

*except when using PRINT_MODE:TEXT

Tileset[edit]

Main article: Tilesets

The main tileset (also called 'character set' or just 'tileset') is an image in BMP or PNG format that contains the 256 different tiles, corresponding to the IBM Code Page 437, which are used to display all objects, creatures, and UI elements in game. The tiles are always arranged in a 16x16 grid, but its dimensions can be varied. You can have both square and non-square tiles, with 16x16 pixels being the most common size. Creatures are displayed as colored letters (a white 'B' is a polar bear, a brown 'd' a dog, and a grey 'c' is a cat).

As the tileset is limited to only 256 tiles, some objects share the same tile. Most notably, even with upper and lower case letters and 16 colors, a lot of creatures still look identical (goblin, goat, various gibbons, gremlin, goose, etc.). The tile for bins, up/down stairs and the cursor are the same; bags use the same tile as the symbol for "male"; and the "female" symbol shares a graphic with amulets. Roads and large rivers on the world map, minecart tracks and walls all share the same tiles as well.

Some of those can be changed in the raws and init files, and creatures can have separate graphics, but in most cases they are hardcoded.

That also can be used to categorize custom tilesets: Those that are made for and come bundled with modified raws/init files, and those that are made for and work with the default raws. Usually, the latter are more symbolic, or 'ASCII-like', while the former are often more pictographic, detailed or "pixel-arty". These sometimes are also bundled with their own creature graphics. Tilesets that are made for default raws have the advantage that you can use them immediately without any work for any new version that is released. With modified raws, you need to manually edit the new raws again, or wait for the maintainer to do that.

Graphic set[edit]

Main article: Graphic set

Graphic sets are additional tilesets used to give objects different graphics. As opposed to the main tileset, any number of tiles can be arranged in any grid configuration. Currently, DF only supports graphic sets for creatures. Every graphic set needs a corresponding text file that assigns a tile to a creature.

Color[edit]

Main article: Color

In general, a tileset has white tiles with a transparent background. White pixels show the foreground color, transparent pixels (magenta pixels for .bmp) the background color. Black pixels remain black. Shades of grey, partial transparency and even colored tiles can be used for various effects. Additionally, creature graphics can be set to be displayed in the colors they're drawn in.

Otherwise, the game selects from 16 colors (the color scheme) to decide the color: which of the 16 colors the game uses depends on the color value or color token of the material/item.


Installation[edit]

Further information: Mod, Tilesets, Graphic set, and Color scheme

Repositories[edit]

Users of the Steam version can subscribe to mods on Steam Workshop. The wiki has repositories for tilesets, graphic sets, and color schemes. You will find more in the bay 12 graphics subforum and on DFFD. Some graphic sets and tilesets are additionally maintained on github. Often, tileset creators offer preinstalled downloads or folders you just have to drop into your DF folder and overwrite files when prompted. They usually come with installation instructions either in a readme file or in their respective forum thread. In addition, there are various launcher applications that let you install and change graphics automatically.

For manual installation of the various components, see here:

Tileset[edit]

Put the tileset you want to use into the data/art/ folder. Open up init.txt (in data/init/) with a text editor and change the entries FONT, FULLFONT, GRAPHICS_FONT, and GRAPHICS_FULLFONT to the filename of your new tileset.

Creature Graphics[edit]

Put the graphic set into a subfolder in raw/graphics and the corresponding text file directly in raw/graphics. If you have an active save you will have to put them into the raw folder of your save as well (data/save/<your region>/raw/graphics). Finally, set GRAPHICS to YES in data/init/init.txt

Color Scheme[edit]

Replace colors.txt in data/init with your new colors.

True Type Font[edit]

Replace font.ttf in data/art with your new font.


See Also[edit]