Difference between revisions of "DF2014:Graphic set"

A graphic set is an additional tileset for objects. While this is eventually planned for all objects in game, currently only creatures can assigned to graphic sets.

Graphic sets are placed in raw/graphics (as well as the raw folder of each save); A corresponding text file assigns tiles to objects.

==Documentation==

The graphic sets themselves are placed into subfolders. It is recommended that they have the same tile size as the main [[tileset]], but the number of tiles and their spatial arrangement doesn't matter (see [[Graphic_set#Notes|Notes]] for details).

All [[creature]]s can have separate graphics assigned to their adult and child states, undead, and their -men and giant variants. In addition, the major [[Civilization]]s can have separate graphics for all professions (such as miner, mason, caravan guard, and ghost). You can assign one graphic to several creatures/states, and you can set each tile to either be displayed as it appears or let the game color them. Vermin and different genders cannot have separate graphics assigned to them.

===Text File Syntax===

A Graphic set needs a text file that tells the game which tile is used for which creature. You can use separate text files for each graphic set, or a single one for several. Each text file consists of a header, one or more graphic set definitions (called "TILE_PAGE") and several creature graphics entries, each of which has subentries for professions.

Below is an example of such a file.

  graphics_mygraphics &larr; <small><span style="color:#808080">'''The first line of the header. You'll be saving the text document as this name (graphics_mygraphics.txt) <br>                            This name should match the folder name you will be using in "raw/graphics".'''</span></small><br>

  below are dwarves &larr; <small><span style="color:#808080">'''text outside brackets gets ignored. You can use it for comments and organizing your file visually with lines'''</span></small> <br>  

  [TILE_PAGE:MYDWARVES] &larr; <small><span style="color:#808080">'''Here you are defining properties of a single graphic set image. The title MYDWARVES will be used in creature graphic entries to refer to that graphic set. The title doesn't have to match any creature, folder, or image name.'''</span></small>  

         [FILE:mygraphics/mydwarves.png] &larr; <small><span style="color:#808080">'''The subfolder where the graphic set is located (relative to this text file) and its filename, including the file extension. '''</span></small>

         [PAGE_DIM:5:3] &larr; <small><span style="color:#808080">'''Width:Height - Tiles per image and how they're arranged in rows and columns.'''</span></small> <br>

  humans <br>

  [TILE_PAGE:MYHUMANS] &larr; <small><span style="color:#808080">'''The next TILE_PAGE definition. You could put that (and its creature graphic entries) in a separate text file, but it would have to contain its own header.'''</span></small>

         [PAGE_DIM:1:4] <br>

  animals <br>

         [PAGE_DIM:6:2] <br>

         ['''TRAINED_HUNTER''':MYANIMALS:4:0:AS_IS:DEFAULT] &larr; <small><span style="color:#808080">'''TRAINED_HUNTER profession only works with animals that have the [TRAINABLE] or [TRAINABLE_HUNTING] tag.'''</span></small>

         ['''TRAINED_WAR''':MYANIMALS:5:0:AS_IS:DEFAULT] &larr; <small><span style="color:#808080">'''TRAINED_WAR profession only works with animals that have the [TRAINABLE] or [TRAINABLE_WAR] tag.'''</span></small>

===Coordinates===

The PAGE_DIM value in the TILE_PAGE section defines how many columns and rows a given TILE_PAGE (graphic set) has. The first value is the X axis (or "width"), the second value the Y axis ("height"). The origin (0,0) is at the top left.  

| 0:0

| 1:0

| 2:0

| '''3:0'''

| 0:1

| 1:1

| 2:1

| 3:1

| 4:1

Note that the coordiantes start at 0, not 1. So, ''the last column in a 5 tile wide image is at 4'', not at 5.

  [CREATURE_GRAPHICS:'''Creature name''']

        ['''Profession''':MYHUMANS:0:0:AS_IS:'''Texture Token''']

===Texture Tokens===

'''Note that the Tokens GHOST and ANIMATED go in the ''profession'' spot, not the texture token as you would expect''' - this means that you can't have separate graphics for miner zombies, axedwarf zombies, speardwarf zombies, etc.

===Professions===

You can find these in ''raw/objects/entity_default.txt'' as PERMITTED_JOB and POSITION. All 5 major [[Civilization]]s (Dwarves, Elves, Humans, Goblins, Kobolds) use at least some of these professions. POSITIONS are only defined under the entry for Dwarves, but all Civilizations use these definitions.{{verify}}

The second column displays which [[Civilization]] uses those professions (currently incomplete).

The highest skill of a creature determine which profession graphic it uses.

Position Tokens are graphics used for appointed positions in the world, like queen, baron, general, but also slave and prisoner. When a creature does have a position and a graphic exists for that position, it takes precedence over the profession graphic.

|  

! Civilians !! used by

|style="vertical-align:top;"|  

{|class="wikitable"

|CHAMPION ||  

| CHILD ||  

| BABY ||  

| DRUNK ||  

|}

|style="vertical-align:top;"|  

| MONARCH ||  

| GENERAL ||  

| LIEUTENANT ||  

| CAPTAIN ||  

| MILITIA_COMMANDER ||  

| MILITIA_CAPTAIN ||  

| SHERIFF ||  

| CAPTAIN_OF_THE_GUARD ||  

| EXPEDITION_LEADER ||  

| MAYOR ||  

| CHIEF_MEDICAL_DWARF ||  

| BOOKKEEPER ||  

| DIPLOMAT ||  

| DUKE ||  

| COUNT ||  

| BARON ||  

| CHAMPION ||  

| HAMMERER ||  

| FORCED_ADMINISTRATOR ||  

| DRUID ||  

| GENERAL ||  

| LEADER ||  

| DIPLOMAT ||  

| RANGER_CAPTAIN ||  

| HIGH_PRIEST ||  

| PRIEST ||  

===Creatures===

:''For a table with general information about creatures, see [[Creature|here]]''

:''For a table sorted by default tile, including alternate tiles, see [[Tilesets#Creatures|here]]''

:''For a table with trainable animals, see [[Animal_trainer#Trainable_war.2Fhunting_animals|here]]''

Creatures that use a raw name you might not expect (space instead of underscore, bird without BIRD_ preffix, THING_GIANT instead of GIANT_THING) have a differently colored background. be extra careful to spell these correctly.

{|class="wikitable"

!scope="row" colspan="3"| creature_amphibians

| TOAD

| toad

| VERMIN

!scope="row" colspan="3"| creature_annelids

| WORM