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.

Difference between revisions of "Interface.txt"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(changed colors.txt to interface.txt in the file hierarchy)
(Tagging v50 page (2289/4888))
(20 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
{{Quality|Superior|20:29, 30 April 2013 (UTC)}}
+
{{migrated article}}
 +
{{Quality|Unrated}}
 
{{av}}
 
{{av}}
 
{{file|DF/data/init/interface.txt}}
 
{{file|DF/data/init/interface.txt}}
−
See [[Controls]] for the default key binds.
+
: ''See [[Controls]] for the default key binds.''
−
__TOC__
+
 
−
==Key bindings==
 
 
'''Key bindings''' determine how the game responds to the user (you) pressing different keys on their keyboard, numberpad, laptop, whatever.  
 
'''Key bindings''' determine how the game responds to the user (you) pressing different keys on their keyboard, numberpad, laptop, whatever.  
  
−
To access the key bindings, start a game(or just edit [[Interface.txt#Vanilla interface.txt|interface.txt]]), then hit {{k|Esc}} - using the up/down arrows, highlight "Key Bindings" and hit {{k|Enter}}. This then shows the various game mode/screen categories (and [[Macros]]) selecting one shows all of the bindable game commands in that category.
+
The game key bindings are stored in '''interface.txt'''. They can be configured in the {{DFtext|Key Bindings}} section of the in-game options screen or by editing this file directly.
 +
 
 +
Each action can be bound to any number of keys, either by keyboard location or letter. They can also be given a repeat style which specified what happens when any of the bound keys are held:
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Repeat Style
 +
! Behavior
 +
|-
 +
| Don't repeat
 +
| The action does not repeat at all; pressing the key performs the action exactly once, no matter how long it is held.
 +
|-
 +
| Delayed repeat
 +
| The action repeats after a delay of [[DF2014:Technical_tricks#Keyboard|<code>KEY_HOLD_MS</code>]] milliseconds.
 +
|-
 +
| Immediate repeat
 +
| The action repeats immediately.
 +
|}
  
−
On the left you see you see list of bindable commands and on the right side you see "Add binding" option the "Don't repeat", "Delayed repeat" and "Immediate repeat" after that refer to what happens when you hold down the key, the one in red is selected and finally the ones starting with "By position:  " and "By letter:  " are the currently set binds of the command.
+
== Changing key bindings in-game==
 +
When in-game, press {{k|Esc}} to open the options screen and select {{DFtext|Key Bindings}}. This shows the various game mode/screen categories (and [[Macros]]).
  
−
For example if you wanted to add {{k|9}} to "Select" command(odd, but your choice) you would then select the General category, press right on the first command(Select) and hit {{k|Enter}} on the "Add binding" option to open a key registration prompt and then press {{k|9}} and select whether you want to bind [[#Differences_between_KEY_and_SYM|by position or by key]] and hit {{k|Enter}} or if you hit the wrong button {{k|Esc}}(or whatever you have set to "Main menu" or "Leave screen" keys) to abort. However, you'd then have to find any action that '''also''' is controlled by  {{k|9}}, or you'll be sending '''both''' commands every time you hit that key. Changes should be planned carefully with that last in mind. To remove the command you added select the "By letter: 9" or "By position: 9" or "By position: Numpad 9" on the select command with arrow keys and press backspace(your "String: Backspace" key) to delete the keybind.
+
Selecting one shows all of the bindable game commands in that category. On the left is a list of bindable commands and on the right are options to add bindings and change the action's repeat style. Use the left and right selection keys to move between them.
  
−
Additional commands can be viewed by scrolling using the up/down arrows, or by screen using the page up/page down keys (unless you've changed those).
+
Use {{k|Backspace}} on a binding to remove it.
  
−
==Additional Up/Down Z-Level Keys==
+
For example if you wanted to add {{k|9}} to "Select" command (odd, but your choice) you would then select the General category, press right on the first command(Select) and hit {{k|Enter}} on the "Add binding" option to open a key registration prompt and then press {{k|9}} and select whether you want to bind [[#Differences_between_KEY_and_SYM|by position or by key]] and hit {{k|Enter}} or if you hit the wrong button {{k|Esc}} (or whatever you have set to "Main menu" or "Leave screen" keys) to abort.
  
−
One of the more common key binding changes, is to use the comma {{k|,}} and period {{k|.}}, rather than {{k|<}} and {{k|>}} (the same keys + {{k|Shift}}) for up/down [[z-level]]s, thus avoiding the need to use two hands/keys for this common action.  
+
Adding bindings does not remove any other binding that also uses this key. This is almost never what you want, so you'd then have to find any command that is also bound to your added key, or you'll be sending both commands every time.
  
−
You'll need to add the following in the general category.
+
== Useful custom bindings ==
  
−
Move view/cursor up (z)                By position/letter: ,
+
===Scrolling without keypad===
−
Move view/cursor down (z)              By position/letter: .
 
  
−
''Then, also '''be sure''' remove'' the following entry from the dwarf mode,  
+
If you're on a laptop or using a restricted keyboard, using {{k|+}} and {{k|*}} to scroll on some menus is inconvenient since it requires the Shift key. To scroll with <code>-=[]</code> instead of <code>-+/*</code>, add:
  
−
Main: One-Step                          By letter: .
+
{| class="wikitable"
 +
|-
 +
! Category !! Command !! Key
 +
|-
 +
| General || Move secondary selector down || {{k|<nowiki>=</nowiki>}}
 +
|-
 +
| General || Page secondary selector up || {{k|[}}
 +
|-
 +
| General || Page secondary selector down || {{k|]}}
 +
|}
  
−
This avoids advancing the game one [[Frames per second|step]] each time you move the game view "down" one [[z-level]], since both would be controlled by the {{k|.}} key.  But advancing one step would become unbound so you could use {{k|<}} or {{k|>}} or any other '''unused''' key for that.
+
===Change z-level without shift===
  
 +
You can use the comma {{k|,}} and period {{k|.}}, rather than {{k|<}} and {{k|>}} (the same keys + {{k|Shift}}) for up/down [[z-level]]s, thus avoiding the need to use two hands/keys for this common action.
  
−
Some players may feel more comfortable by switching the PgDn/PgUp keys to control moving between z-levels, though this is not recommended should you use the numpad for movement.
+
Add the following:
  
−
== Laptop Bindings ==
+
{| class="wikitable"
−
[[40d:Key_bindings#Laptop Bindings|40d version]] required some editing to use non-numpad versions of keys but this is no longer necessary so there are no longer any changes possible that could make laptop keyboards easier to use for playing DF.
+
|-
 +
! Category !! Command !! Key
 +
|-
 +
| General || Move view/cursor up (z) || {{k|,}}
 +
|-
 +
| General || Move view/cursor down (z) || {{k|.}}
 +
|}
  
−
== Vanilla interface.txt ==
+
Then remove the following to avoid clashing:
  
 +
{| class="wikitable"
 +
|-
 +
! Category !! Command !! Key
 +
|-
 +
| Dwarf mode || Main: One-Step || {{k|.}}
 +
|}
 +
 +
== interface.txt ==
 +
The file can be found in <code>Dwarf Fortress\data\init\interface.txt</code>
 +
 +
=== Default settings ===
 
{{gamedata}}
 
{{gamedata}}
  
−
== Key syntax ==
+
=== Key syntax ===
 +
A key bindings block has this structure:
 +
<pre>
 +
[BIND:Action:Repeat_Style]
 +
[SYM:Modifiers:Key]
 +
[KEY:Key]
 +
</pre>
 +
It is made of two parts:
 +
*The <code>BIND</code> part, which defines what the key does,
 +
*And the <code>SYM/KEY</code> part, which defines which key the action is mapped to.
  
−
===<code>SYM</code>===
+
====BIND====
−
<code>SYM</code> is used for keys listed as {{DFtext|By position}} in the keybinding menu.
+
<code>BIND</code> begins a block of key bindings for a specified action in the Key Bindings menu.
 +
 
 +
Syntax:
 +
<pre>
 +
[BIND:Action:Repeat_Style]
 +
</pre>
 +
 
 +
Each <code>BIND</code> is followed by a block of one or more key bindings (<code>SYM</code> or <code>KEY</code>; see below) terminated either by the next <code>BIND</code> or by the end of file.
 +
 
 +
The repeat style is given as one of the following:
 +
{| class="wikitable"
 +
|-
 +
! String
 +
! Repeat Style
 +
|-
 +
| <code>REPEAT_NOT</code>
 +
| Don't repeat
 +
|-
 +
| <code>REPEAT_SLOW</code>
 +
| Delayed repeat
 +
|-
 +
| <code>REPEAT_FAST</code>
 +
| Immediate repeat
 +
|}
 +
It is not possible to specify key bindings with different repeat styles for the same action; if more than one <code>BIND</code> exists for the same action, the repeat style of the last <code>BIND</code> is used for all bound keys.
 +
 
 +
Vanilla interface.txt already includes <code>BIND</code> entries for all valid actions. It is possible to remove all key bindings for a given action by removing all <code>SYM</code> and <code>KEY</code> entries after the action's <code>BIND</code>, and (optionally) removing the <code>BIND</code> itself. This, however, can result in frequent warnings output to the terminal if the game wants to display a key binding for the action (e.g. {{DFtext|;: Movies}} in the Dwarf Mode side bar; one can mitigate this by closing the side bar with {{k|Tab}}).
 +
 
 +
====SYM====
 +
<code>SYM</code> is used for keys listed as {{DFtext|By position}} in the Key Bindings menu.
  
 
Syntax:
 
Syntax:
Line 66: Line 148:
 
For example, <code>[SYM:0:A]</code> represents {{k|a}}, <code>[SYM:1:Enter]</code> represents {{k|Shift}}-{{k|Enter}}, and <code>[SYM:6:Left]</code> represents {{k|Ctrl}}-{{k|Alt}}-{{k|&larr;}}.
 
For example, <code>[SYM:0:A]</code> represents {{k|a}}, <code>[SYM:1:Enter]</code> represents {{k|Shift}}-{{k|Enter}}, and <code>[SYM:6:Left]</code> represents {{k|Ctrl}}-{{k|Alt}}-{{k|&larr;}}.
  
−
The key can be any letter or number, or can be listed by name. This is useful when typing the actual symbol would cause a syntax error (for example, <code>[KEY:0:]]</code> and <code>[KEY:0::]</code> cause errors instead of representing {{k|]}} and {{k|:}}), or when the symbol isn't type-able (it's hard to insert a backspace character in a basic text editor without deleting something).
+
The key can be any letter or number, or can be listed by name. This is useful when typing the actual symbol would cause a syntax error (for example, <code>[SYM:0:]]</code> and <code>[SYM:0::]</code> cause errors instead of representing {{k|]}} and {{k|&#58;}}), or when the symbol isn't type-able (it's hard to insert a backspace character in a basic text editor without deleting something).
  
−
===<code>KEY</code>===
+
====KEY====
  
−
<code>KEY</code> is a simpler version of <code>SYM</code>, only allowing plain keys (no modifiers). These are listed as {{DFtext|By letter}} in the keybinding menu.
+
<code>KEY</code> is a simpler version of <code>SYM</code>, only allowing plain keys (no modifiers). These are listed as {{DFtext|By letter}} in the Key Bindings menu.
  
 
Syntax: <pre>[KEY:Key]</pre>
 
Syntax: <pre>[KEY:Key]</pre>
Line 76: Line 158:
 
For example, <code>[KEY:a]</code> represents the {{k|a}} key.
 
For example, <code>[KEY:a]</code> represents the {{k|a}} key.
  
−
===Differences between <code>KEY</code> and <code>SYM</code>===
+
Unlike the above, the key must be given as an actual symbol. Entries such as <code>[KEY:]]</code> and <code>[KEY::]</code> work as one might expect, i.e., representing {{k|]}} and {{k|&#58;}}, respectively.
 +
 
 +
====Differences between <code>KEY</code> and <code>SYM</code>====
  
 
<code>KEY</code> '''does''' allow special characters '''if''' they are able to be typed. For example, <code>[KEY:%]</code> is equivalent to <code>[SYM:1:5]</code>. Note that <code>SYM</code> requires the key on the keyboard, while <code>KEY</code> requires the letter generated.
 
<code>KEY</code> '''does''' allow special characters '''if''' they are able to be typed. For example, <code>[KEY:%]</code> is equivalent to <code>[SYM:1:5]</code>. Note that <code>SYM</code> requires the key on the keyboard, while <code>KEY</code> requires the letter generated.

Revision as of 00:34, 21 December 2022

!!UNKNOWN!!  · xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
v50.14 · v0.47.05
This article is about the current version of DF.
Note that some content may still need to be updated.
File

Folder-orange.svg Dwarf Fortress

Folder.svg data

Folder.svg init

Text-x-generic.svg interface.txt

See Controls for the default key binds.

Key bindings determine how the game responds to the user (you) pressing different keys on their keyboard, numberpad, laptop, whatever.

The game key bindings are stored in interface.txt. They can be configured in the Key Bindings section of the in-game options screen or by editing this file directly.

Each action can be bound to any number of keys, either by keyboard location or letter. They can also be given a repeat style which specified what happens when any of the bound keys are held:

Repeat Style Behavior
Don't repeat The action does not repeat at all; pressing the key performs the action exactly once, no matter how long it is held.
Delayed repeat The action repeats after a delay of KEY_HOLD_MS milliseconds.
Immediate repeat The action repeats immediately.

Changing key bindings in-game

When in-game, press Esc to open the options screen and select Key Bindings. This shows the various game mode/screen categories (and Macros).

Selecting one shows all of the bindable game commands in that category. On the left is a list of bindable commands and on the right are options to add bindings and change the action's repeat style. Use the left and right selection keys to move between them.

Use Backspace on a binding to remove it.

For example if you wanted to add 9 to "Select" command (odd, but your choice) you would then select the General category, press right on the first command(Select) and hit Enter on the "Add binding" option to open a key registration prompt and then press 9 and select whether you want to bind by position or by key and hit Enter or if you hit the wrong button Esc (or whatever you have set to "Main menu" or "Leave screen" keys) to abort.

Adding bindings does not remove any other binding that also uses this key. This is almost never what you want, so you'd then have to find any command that is also bound to your added key, or you'll be sending both commands every time.

Useful custom bindings

Scrolling without keypad

If you're on a laptop or using a restricted keyboard, using + and * to scroll on some menus is inconvenient since it requires the Shift key. To scroll with -=[] instead of -+/*, add:

Category Command Key
General Move secondary selector down =
General Page secondary selector up [
General Page secondary selector down ]

Change z-level without shift

You can use the comma , and period ., rather than < and > (the same keys + Shift) for up/down z-levels, thus avoiding the need to use two hands/keys for this common action.

Add the following:

Category Command Key
General Move view/cursor up (z) ,
General Move view/cursor down (z) .

Then remove the following to avoid clashing:

Category Command Key
Dwarf mode Main: One-Step .

interface.txt

The file can be found in Dwarf Fortress\data\init\interface.txt

Default settings

Key syntax

A key bindings block has this structure: 

[BIND:Action:Repeat_Style]
[SYM:Modifiers:Key]
[KEY:Key]

It is made of two parts:

  • The BIND part, which defines what the key does,
  • And the SYM/KEY part, which defines which key the action is mapped to.

BIND

BIND begins a block of key bindings for a specified action in the Key Bindings menu.

Syntax: 

[BIND:Action:Repeat_Style]

Each BIND is followed by a block of one or more key bindings (SYM or KEY; see below) terminated either by the next BIND or by the end of file.

The repeat style is given as one of the following:

String Repeat Style
REPEAT_NOT Don't repeat
REPEAT_SLOW Delayed repeat
REPEAT_FAST Immediate repeat

It is not possible to specify key bindings with different repeat styles for the same action; if more than one BIND exists for the same action, the repeat style of the last BIND is used for all bound keys.

Vanilla interface.txt already includes BIND entries for all valid actions. It is possible to remove all key bindings for a given action by removing all SYM and KEY entries after the action's BIND, and (optionally) removing the BIND itself. This, however, can result in frequent warnings output to the terminal if the game wants to display a key binding for the action (e.g. ;: Movies in the Dwarf Mode side bar; one can mitigate this by closing the side bar with Tab).

SYM

SYM is used for keys listed as By position in the Key Bindings menu.

Syntax: 

[SYM:Modifiers:Key]

The modifiers are represented as the sum of their codes listed below:

Modifier Value
Shift 1
Ctrl 2
Alt 4

For example, [SYM:0:A] represents a, [SYM:1:Enter] represents Shift-Enter, and [SYM:6:Left] represents Ctrl-Alt-←.

The key can be any letter or number, or can be listed by name. This is useful when typing the actual symbol would cause a syntax error (for example, [SYM:0:]] and [SYM:0::] cause errors instead of representing ] and :), or when the symbol isn't type-able (it's hard to insert a backspace character in a basic text editor without deleting something).

KEY

KEY is a simpler version of SYM, only allowing plain keys (no modifiers). These are listed as By letter in the Key Bindings menu.

Syntax: 

[KEY:Key]

For example, [KEY:a] represents the a key.

Unlike the above, the key must be given as an actual symbol. Entries such as [KEY:]] and [KEY::] work as one might expect, i.e., representing ] and :, respectively.

Differences between KEY and SYM

KEY does allow special characters if they are able to be typed. For example, [KEY:%] is equivalent to [SYM:1:5]. Note that SYM requires the key on the keyboard, while KEY requires the letter generated.

Mac-specific

  • Some keys unavailable on the keyboard (such as PgDown) can be generated with the fn key. Dwarf fortress sees these as independent keys; the fn key is essentially invisible to DF. There is no modifier code for fn.
  • Characters like å aren't recognized when typed as alt-a.
  • The Command key is unrecognized by DF and can't be used as a modifier.
V · T · E
Settings
Gameplay settings
Log files
Other
Retrieved from "https://dwarffortresswiki.org/index.php?title=Interface.txt&oldid=277369"