Alternative keymaps for mice

From Official Kodi Wiki
Jump to navigation Jump to search

Alternative keymaps for mice and remotes with airmouse features, as suggested by the community.

Installing keymaps

There are a few methods to load custom keymaps on Kodi.

File manager

Kodi's built in file manager can be used to copy files from a network file share (such as SMB/Windows sharing), or a USB thumb drive, to the userdata folder.

  1. Save the keymap you want to use as a plain text file as "keymap.xml" (it can be anything as long as it ends in .xml) on the file share.
  2. Go to the File Manager in Kodi. For the default skin, Confluence, highlight the "System" tab and then select the submenu "File manager" option.
  3. Add the file share as a source in the "A" window, then navigate to where the keymap file is.
  4. In the "B" window go do the Profile directory which will be the userdata folder, then open the keymaps folder.
  5. Highlight the keymap file from the "A" window, then press menu, and then select copy. This will copy the selected keymap to the Fire TV's userdata folder.
  6. Now just restart Kodi to load the new keymap.

Copy directly to userdata folder

  1. Save the keymap you want to use as a plain text file as "keymap.xml" (it can be anything as long as it ends in .xml)
  2. Use a file manager of your choice, such as the one build into your OS, and copy this file to the userdata folder within the keymaps folder.

The Userdata folder is a subfolder of the Kodi Data Folder and is located as shown in the table below.

Operating system Userdata Folder
Android Android/data/org.xbmc.kodi/files/.kodi/userdata/ (see note)
iOS /private/var/mobile/Library/Preferences/Kodi/userdata/
LibreELEC /storage/.kodi/userdata/
Linux ~/.kodi/userdata/
macOS /Users/<your_user_name>/Library/Application Support/Kodi/userdata/
Nvidia Shield (SMB) smb://<nvidiashieldurl>/internal/Android/data/org.xbmc.kodi/files/.kodi/userdata
OSMC /home/osmc/.kodi/userdata/
tvOS /private/var/mobile/Library/Preferences/Kodi/userdata/
Windows %APPDATA%\Kodi\userdata
Windows Portable <Install location chosen by you>\portable_data\userdata\
Windows via Microsoft Store %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
Windows Xbox %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\
Note: In some Android setups the path may be slightly different to the one stated above.


Keymap 1

What it does
  • Disables mouse movement for fullscreen video and audio.
  • Click anywhere to bring up the on-screen-controls, which will re-enable mouse movement.
Note: You can right-click to manually hide the on-screen-controls instead of waiting for it to disappear.
  • Scroll wheel controls volume when on fullscreen video or audio playback. <wheeldown> and <wheelup> can be moved to <global> if you want it to always control volume.
Keymap
Cut and paste the following into a new text document and save as NoMouseMove.xml and place in userdata/keymaps/
<keymap>
  <Global>
    <mouse>
 <!--     <wheeldown>VolumeDown</wheeldown> --> <!-- Remove arrows to enable global volume control -->
 <!--     <wheelup>VolumeUp</wheelup> --> <!-- Remove arrows to enable global volume control -->
    </mouse>
  </Global>
  <FullScreenVideo>
    <mouse>
      <mousedrag>noop</mousedrag>
      <mousemove>noop</mousemove>
      <wheeldown>VolumeDown</wheeldown>
      <wheelup>VolumeUp</wheelup>
    </mouse>
  </FullScreenVideo>
  <VideoMenu>
    <mouse>
      <mousedrag>mousedrag</mousedrag>
      <mousemove>mousemove</mousemove>
      <wheeldown>VolumeDown</wheeldown>
      <wheelup>VolumeUp</wheelup>
    </mouse>
  </VideoMenu>
  <VideoOSD>
    <mouse>
      <mousedrag>mousedrag</mousedrag>
      <mousemove>mousemove</mousemove>
      <wheeldown>VolumeDown</wheeldown>
      <wheelup>VolumeUp</wheelup>
    </mouse>
  </VideoOSD>
 <Visualisation>
    <mouse>
      <mousedrag>noop</mousedrag>
      <mousemove>noop</mousemove>
      <wheeldown>VolumeDown</wheeldown>
      <wheelup>VolumeUp</wheelup>
    </mouse>
  </Visualisation>
  <MusicOSD>
    <mouse>
      <mousedrag>mousedrag</mousedrag>
      <mousemove>mousemove</mousemove>
      <wheeldown>VolumeDown</wheeldown>
      <wheelup>VolumeUp</wheelup>
    </mouse>
  </MusicOSD>
</keymap>

Disable mouse

What it does
  • Completely disables mouse movement.
Keymap
Cut and paste the following into a new text document and save as NoMouseMove.xml and place in userdata/keymaps/
<keymap>
  <global>
    <mouse>
      <mousedrag>noop</mousedrag>
      <mousemove>noop</mousemove>
    </mouse>
  </global>
</keymap>

Live TV focused

What it does
  • Specifically used for LiveTV / IPTV.

- Middle wheel button stops channel playing, but more importantly, stops the "Working ... - Death Spin". - You can now use the EPG Guide to peruse the channels. Your Wheel will now move channels Up/Down vertically, instead of moving the timeline horizontally. - While in Fullscreen TV mode, a Left Click will bring up your previous channel.(only when bottom info display is not on screen) - Right Click gets rid of the Bottom Info Display (or it times out after ~5 sec.). Another Right Click will bring up the Channel List or EPG Guide, whichever one you use.

Keymap
Cut and paste the following into a new text document and save as LiveTVMouse.xml and place in userdata/keymaps/

<keymap>
<global>
<mouse>
<leftclick>leftclick</leftclick>
<rightclick>rightclick</rightclick>
<middleclick>Stop</middleclick>
<doubleclick id="0">doubleclick</doubleclick>
<longclick id="0">contextmenu</longclick>

<wheeldown>wheeldown</wheeldown>
<wheelup>wheelup</wheelup>
<mousedrag>mousedrag</mousedrag>
<mousemove>mousemove</mousemove>
</mouse>
</global>
<tvguide>
<mouse>
<wheelup>PageUp</wheelup>
<wheeldown>PageDown</wheeldown>
</mouse>
</tvguide>
<FullscreenLiveTV>
<mouse>
<leftclick>Number0</leftclick>
<rightclick>PreviousMenu</rightclick>
</mouse>
</FullscreenLiveTV>
</keymap>