Keymap

This page or section may require cleanup, updating, spellchecking, reformatting and/or updated images. Please improve this page if you can. The discussion page may contain suggestions.

Keyboard.xml is a XML base keymap file that define the mappings of keys (keyboard keys, mouse/remote/joysticks buttons and more) to XBMC actions. Keyboard.xml was first introduced in XBMC 10 ("Dharma"), in versions prior to that it was called Keymap.xml.

1 Location of keymaps

Keymap configuration files are stored in the "keymaps" folder in the userdata folder:

Note: the Android folder is usually inside of "sdcard" so the path is usually /sdcard/Android/data/org.xbmc.xbmc/files/.xbmc/userdata/.

The keymap configuration files that ship with XBMC are stored in the "/system/keymaps/" folder within the XBMC root directory.

All *.xml files in these folders are applied as keymaps. All *.xml files are processed in alphabetical order. Keymaps defined in an .xml file add to or override mappings in previous .xml file. Keymaps defined in user folders add to or override mappings in the global keymap.

By default there will be no files in these locations, so grab one from the link below to make a new one/over-ride:

Default keymaps shipped with XBMC

2 101 on keymaps

For a full guide, see: HOW-TO:Modify keyboard.xml

• Go to your userdata folder and go into the keymaps folder
• Make a new text document and call it keyboard.xml
• Cut and paste this into the document: https://raw.github.com/xbmc/xbmc/Frodo/system/keymaps/keyboard.xml

Now, you don't actually need to copy the default keymap, because XBMC is smart enough to only load changes, so you can just add one or two keys and it will apply it to the existing keymap. It's nice to use a full copy because it makes it easier to see what is and isn't in use, and when you see the full mapping you get a feel for what the different options do, etc.

3 Structure

There is one global keymap and several window-specific keymaps.
XBMC falls back to the global map when the window-specific map hasn't bound the key being pressed.

The format of keymapping files is as follows:

<keymap>
  <global>
    <gamepad>
      <A>Select</A>
      [...]
    </gamepad>
 
    <remote>
      <select>Select</select>
      [...]
    </remote>
 
    <keyboard>
      <enter>Select</enter>
      [...]
    </keyboard>
 
    <universalremote>
      <obc25>XBMC.ActivateWindow(MyMusic)</obc25>
      [...]
    </universalremote>
 
    <joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
      <button id="15">Select</button>
      [...]
    </joystick>
  </global>
 
  <Home>
    [...]
  </Home>
 
  [...]
 
</keymap>

As you can see, it's divided into a <global> section, and a number of window sections (such as <Home>).
A list of the available window names can be seen here. The WINDOW can also be a custom window formatted as <windowId#> (e. g. <window1113>).
Each of these sections can contain Gamepad, Remote, Keyboard, Universal Remote, and custom Joystick sections.

The format for mapping a particular key under one of these device types is as follows:

  <keyname>action</keyname>

4 Keynames

4.1 Gamepad Section

An up to date list of the available actions can be found in the source code of XBMC in ButtonTranslator.cpp where the TranslateGamepadString() function does the work.

Example:

<gamepad>
  <A>Select</A>
</gamepad>

4.2 Remote Section

An up to date list of the available actions can be found in the source code of XBMC in ButtonTranslator.cpp where the TranslateRemoteString() function does the work.

Example:

<remote> 
  <play>Play</play>
</remote>

4.3 Universal Remote Section

To map Universal Remote buttons using the RCA infrared protocol, you may add <universalremote> sections to keymap.xml.
In this case, the tags used are <obc#> where # is the original button code (OBC) of the button.
You would put it inside a <universalremote> section in the <window> or <global> sections.

Example:

<universalremote> 
  <obc148>Stop</obc148>
</universalremote>

Will map Stop Playback to the RCA DVD repeat button <obc148>, which is not used by XBMC by default.

• Note: ensure that the <universalremote> section is NOT added 'within' the <remote> section - it can appear before or after. Otherwise it will not be recognised and produces errors in the logfile.

Remote keys can be observed in the xbmc.log file (~/.xbmc/temp/xbmc.log on Linux) when debugging is enabled in the GUI (Settings -> debugging ). The list of pre-defined OBC codes can be found at XBIRRemote.h.

4.4 Keyboard Section

Valid keyboard keymap syntax includes <keyname>, <key id="">, and <keyname mod="">.

Mapping for arbitrary key codes can be configured using the following syntax:

<key id="123">

where "123" is replaced by the key code.

A full list of valid keynames can be found in

• the TranslateKeyboardString() method in ButtonTranslator.cpp
• or in List of XBMC keynames.
  

Example:

<keyboard>
  <key id="123">action</key> -- id is the keys keycode. >
  <a mod="shift,alt">action</a> -- corresponds to shift-alt-a, the mod="" syntax is enabled since build 26407. >
  <space>action</space> -- for a complete list of valid keynames, see ButtonTranslator.cpp or List of XBMC keynames above. >
</keyboard>

4.5 Microsoft XBOX 360 Controller Section

Valid Microsoft XBOX 360 Controller syntax is <button id="x">action</button> or <axis id="x" limit="y">action</axis>.

Here is a full list of button and axis mappings:

Buttons:

• 1 - A
• 2 - B
• 3 - X
• 4 - Y
• 5 - LB
• 6 - RB
• 7 - Start
• 8 - Guide
• 9 - Left Stick Button
• 10 - Right Stick Button
• 11 - D-Pad Up
• 12 - D-Pad Down
• 13 - D-Pad Left
• 14 - D-Pad Right
• 15 - Back

Axis Mappings:

• 1 - Left Stick L/R
• 2 - Left Stick U/D
• 3 - Left Trigger
• 4 - Right Stick L/R
• 5 - Right Stick U/D
• 6 - Right Trigger

Example:

<keymap>
  <global>
    <joystick name="Xbox 360 Wireless Receiver">
      <altname>Controller (Gamepad for Xbox 360)</altname>
      <altname>Controller (XBOX 360 For Windows)</altname>
      <button id="1">Select</button>
      <button id="2">Back</button>
      <button id="3">FullScreen</button>
      <button id="4">ContextMenu</button>
    </joystick>
  </global>
</keymap>

4.6 Custom Joystick Configuration

Custom joysticks are defined using the following syntax:

<joystick name="JOYSTICK NAME">
  <button id="BUTTON ID">action</button>
</joystick>

Getting the joystick name:

• On linux: 'cat /proc/bus/input/devices'
• or see your xbmc log file

Getting the button ids:

• 'id' is the button ID used by SDL. Joystick button ids of connected joysticks appear in xbmc.log when they are pressed. Use your log to map custom buttons to actions.

Example:

<joystick name="PLAYSTATION(R)3 Controller (00:1B:FB:F6:E0:F2)">
  <button id="15">Select</button>
  <button id="14">PreviousMenu</button>
</joystick>

5 Actions

The most recent available actions can be found in the TranslateActionString() method in in ButtonTranslator.cpp.

For those debugging integer action codes from the debug log, the mapping of action codes to constants is in Key.h

In addition to the following actions, you can also use Built-in scripting in XBMC.

Main actions

Other

6 Windows

This table cross-references Window names, Window definitions, Window ID, and the delta Window ID's (this is the delta from the home window.) The code that performs the cross-reference is found in ButtonTranslator.cpp.

• keymap.xml uses the Window name.
• XBMC's C++ code uses the Window definitions and Window ID's.
• skin .xml files use the Delta Window ID's
• XBMC.ActivateWindow() can use either the Window name, the Window ID, or the delta Window ID.
• sounds.xml can use the window name or window ID
  

You can use secondary parameters with all media windows, as can be seen here:

• Opening Windows and Dialogs
  

Example:

• You want a button in your skin or on your remote taking you directly to the movie listing you let that button do

ActivateWindow(VideoLibrary,MovieTitles)   (dharma)

ActivateWindow(Videos,MovieTitles)   (eden and up)

7 See also

Development:

• Add-on development
• Skinning

8 Additional keys

Other keys that can be mapped to actions.

8.1 Media keyboards/remotes

• browser_back
• browser_forward
• browser_refresh
• browser_stop
• browser_search
• browser_favorites
• browser_home
• volume_mute
• volume_down
• volume_up
• next_track
• prev_track
• stop
• play_pause
• launch_mail
• launch_media_select
• launch_app1
• launch_app2
• play
• pause
• fastforward
• rewind
• channelup
• channeldown

8.2 Mouse actions

• leftclick
• rightclick
• middleclick
• doubleclick
• wheelup
• wheeldown
• mousedrag
• mousemove

9 See also

Development:

• Add-on development
• Python development
• Skinning