HOW-TO:Modify keymaps - Revision history

Karellen at 20:40, 27 October 2020

2020-10-27T20:40:09Z

← Older revision		Revision as of 20:40, 27 October 2020
Line 34:		Line 34:
	Keymap configuration files are stored in the "'''keymaps'''" folder in the [[userdata]] folder:		Keymap configuration files are stored in the "'''keymaps'''" folder in the [[userdata]] folder:

	{{#~~lsth~~:userdata\|~~Location of the UserData folder~~}}		{{#lst:userdata\|location all}}

	== How to edit keyboard.xml ==		== How to edit keyboard.xml ==

Tripkip at 10:19, 28 December 2017

2017-12-28T10:19:49Z

← Older revision		Revision as of 10:19, 28 December 2017
Line 176:		Line 176:
	For the sections look for "static const ActionMapping windows[]".		For the sections look for "static const ActionMapping windows[]".

	Finally, there are ~~four~~ key modifiers you can use in key mappings:		Finally, there are five key modifiers you can use in key mappings:

	* {{keypress\|ctrl}} or {{keypress\|control}}		* {{keypress\|ctrl}} or {{keypress\|control}}
Line 182:		Line 182:
	* {{keypress\|alt}}		* {{keypress\|alt}}
	* {{keypress\|win}} or {{keypress\|super}} (the Windows key)		* {{keypress\|win}} or {{keypress\|super}} (the Windows key)
			* {{keypress\|longpress}} (holding down the key)

	{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}		{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}

Tripkip: Add keymap modifier 'longpress'

2017-12-28T10:17:54Z

Add keymap modifier 'longpress'

← Older revision		Revision as of 10:17, 28 December 2017
Line 100:		Line 100:

	configures a {{keypress\|control\|alt\|D}} keypress to execute the action. Incidentally the Notification action displays a little message at the bottom right of the screen. This can be useful for testing your key mappings.		configures a {{keypress\|control\|alt\|D}} keypress to execute the action. Incidentally the Notification action displays a little message at the bottom right of the screen. This can be useful for testing your key mappings.

			<pre><d mod="longpress">Notification(Keypress, You kept pressing D!, 3)</d></pre>

			configures a '''long''' {{keypress\|D}} keypress to execute the action.

	== An example ==		== An example ==

Ned Scott: a bit incomplete, but still accurate

2016-08-31T04:44:39Z

a bit incomplete, but still accurate

← Older revision		Revision as of 04:44, 31 August 2016
Line 181:		Line 181:
	{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}		{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}

	{{~~helix~~ updated}}		{{updated\|16}}

	[[Category:Remotes]]		[[Category:Remotes]]
	[[Category:How-to]]		[[Category:How-to]]
	[[Category:Manual]]		[[Category:Manual]]

Ned Scott: Ned Scott moved page HOW-TO:Modify keyboard.xml to HOW-TO:Modify keymaps

2015-05-16T06:26:57Z

Ned Scott moved page HOW-TO:Modify keyboard.xml to HOW-TO:Modify keymaps

← Older revision	Revision as of 06:26, 16 May 2015
(No difference)

Ned Scott at 06:26, 16 May 2015

2015-05-16T06:26:46Z

← Older revision		Revision as of 06:26, 16 May 2015
Line 1:		Line 1:
	{{mininav\| [[Remote controls]] }}		{{mininav\| [[Remote controls]] \| [[Keymaps]] }}

	{{bigger\| {{note\| You can also edit keymaps from within {{kodi}} by using '''[[Add-on:Keymap Editor]]'''. }} }}		{{bigger\| {{note\| You can also edit keymaps from within {{kodi}} by using '''[[Add-on:Keymap Editor]]'''. }} }}

Ned Scott at 06:24, 16 May 2015

2015-05-16T06:24:47Z

← Older revision		Revision as of 06:24, 16 May 2015
Line 134:		Line 134:
	</keymap></pre>		</keymap></pre>

	The global action for {{keypress\|control\|G}} is still Info, but the section overrides the global mapping when playing a video and configures {{keypress\|control\|G}} to display the OSD instead.		The global action for {{keypress\|control\|G}} is still Info, but the <FullScreenVideo> section overrides the global mapping when playing a video and configures {{keypress\|control\|G}} to display the OSD instead.

	== Debugging ==		== Debugging ==

Ned Scott at 06:24, 16 May 2015

2015-05-16T06:24:20Z

← Older revision		Revision as of 06:24, 16 May 2015
Line 2:		Line 2:

	{{bigger\| {{note\| You can also edit keymaps from within {{kodi}} by using '''[[Add-on:Keymap Editor]]'''. }} }}		{{bigger\| {{note\| You can also edit keymaps from within {{kodi}} by using '''[[Add-on:Keymap Editor]]'''. }} }}


	{{cleanup}}		{{cleanup}}
Line 15:		Line 14:
	You can edit keyboard.xml using any text editor such as Notepad++ in Windows or gedit/nano in Linux. The location where the file should be located after creation is in [[userdata]]		You can edit keyboard.xml using any text editor such as Notepad++ in Windows or gedit/nano in Linux. The location where the file should be located after creation is in [[userdata]]

	There is a more detailed discussion of the keyboard.xml file at [[keymaps]], while the remainder of this article is focussed on the gory details of editing it.~~<br />~~		There is a more detailed discussion of the keyboard.xml file at [[keymaps]], while the remainder of this article is focussed on the gory details of editing it.


	== Introduction ==		== Introduction ==
Line 33:		Line 31:

	== Where to find keyboard.xml ==		== Where to find keyboard.xml ==

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

	{{#lsth:userdata\|Location of the UserData folder}}		{{#lsth:userdata\|Location of the UserData folder}}

	== How to edit keyboard.xml ==		== How to edit keyboard.xml ==

	'''keyboard.xml''' is just a text file so you can edit it it using any text editor e.g. in Windows use Notepad++. In Windows there is a third party keymap editor available from http://xbmcmce.sourceforge.net/, or this editor is also available through the [[Add-on:MCERemote]] add-on.		'''keyboard.xml''' is just a text file so you can edit it it using any text editor e.g. in Windows use Notepad++. In Windows there is a third party keymap editor available from http://xbmcmce.sourceforge.net/, or this editor is also available through the [[Add-on:MCERemote]] add-on.

Line 50:		Line 51:

	* If you use the MCERemote add-on just select the "Edit keyboard.xml" option.		* If you use the MCERemote add-on just select the "Edit keyboard.xml" option.

	{{Note\|that KeyMapEdit.exe isn't included in the MCERemote add-on by default (because the rules for add-ons prohibit including executable files). You need to go into the add-on settings Misc section and enable the setting "Update/install keymap editor" then select "Edit keyboard.xml".}}		{{Note\|that KeyMapEdit.exe isn't included in the MCERemote add-on by default (because the rules for add-ons prohibit including executable files). You need to go into the add-on settings Misc section and enable the setting "Update/install keymap editor" then select "Edit keyboard.xml".}}

Line 132:		Line 134:
	</keymap></pre>		</keymap></pre>

	The global action for {{keypress\|control\|G}} is still Info, but the ~~<FullScreenVideo>~~ section overrides the global mapping when playing a video and configures {{keypress\|control\|G}} to display the OSD instead.		The global action for {{keypress\|control\|G}} is still Info, but the section overrides the global mapping when playing a video and configures {{keypress\|control\|G}} to display the OSD instead.

	== Debugging ==		== Debugging ==
Line 156:		Line 158:
	would be:		would be:

	<pre><g mod="ctrl">Notification(This is the title, This is the message, 3)</g></pre>		<pre><g mod="ctrl">Notification(This is the title, This is the message, 3)</g></pre>

	and the last argument, 3, is the number of seconds to display the message.		and the last argument, 3, is the number of seconds to display the message.

	== ~~Reference~~ ==		== References ==

	The ultimate reference for the possible keynames and actions is the Kodi source code and in particular the source file ButtonTranslator.cpp, which you can find at https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp		The ultimate reference for the possible keynames and actions is the Kodi source code and in particular the source file ButtonTranslator.cpp, which you can find at https://github.com/xbmc/xbmc/blob/master/xbmc/input/ButtonTranslator.cpp
Line 172:		Line 174:
	Finally, there are four key modifiers you can use in key mappings:		Finally, there are four key modifiers you can use in key mappings:

	~~<ul>~~		* {{keypress\|ctrl}} or {{keypress\|control}}
	~~<li>~~{{keypress\|ctrl}} or {{keypress\|control}}~~</li>~~		* {{keypress\|shift}}
	~~<li>~~{{keypress\|shift}}~~</li>~~		* {{keypress\|alt}}
	~~<li>~~{{keypress\|alt}}~~</li>~~		* {{keypress\|win}} or {{keypress\|super}} (the Windows key)
	~~<li>~~{{keypress\|win}} or {{keypress\|super}} (the Windows key)~~</li>~~
	~~</ul>~~

	{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}		{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}

Ned Scott at 06:22, 16 May 2015

2015-05-16T06:22:48Z

← Older revision		Revision as of 06:22, 16 May 2015
Line 15:		Line 15:
	You can edit keyboard.xml using any text editor such as Notepad++ in Windows or gedit/nano in Linux. The location where the file should be located after creation is in [[userdata]]		You can edit keyboard.xml using any text editor such as Notepad++ in Windows or gedit/nano in Linux. The location where the file should be located after creation is in [[userdata]]

	There is a more detailed discussion of the keyboard.xml file at [[~~Keyboard.xml~~]], while the remainder of this article is focussed on the gory details of editing it.<br />		There is a more detailed discussion of the keyboard.xml file at [[keymaps]], while the remainder of this article is focussed on the gory details of editing it.<br />


Line 60:		Line 60:
	This is an outline rather than a definitive guide.		This is an outline rather than a definitive guide.
	For the full details see		For the full details see
	[[~~Keyboard.xml~~]].		[[keymaps]].

	A keyboard.xml file will look something like:		A keyboard.xml file will look something like:
Line 180:		Line 180:

	{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}		{{note\|The {{keypress\|shift}} modifier can't be used alone. This is because Kodi isn't case sensitive when processing keystrokes, i.e. a {{keypress\|'''g'''}}is the same as a {{keypress\|'''G'''}}.}}

			{{helix updated}}

	[[Category:Remotes]]		[[Category:Remotes]]
	[[Category:How-to]]		[[Category:How-to]]
	[[Category:Manual]]		[[Category:Manual]]

Ned Scott: /* How to edit keyboard.xml */

2015-05-16T06:21:39Z

How to edit keyboard.xml

← Older revision		Revision as of 06:21, 16 May 2015
Line 37:		Line 37:

	== How to edit keyboard.xml ==		== How to edit keyboard.xml ==
	'''		'''keyboard.xml''' is just a text file so you can edit it it using any text editor e.g. in Windows use Notepad++. In Windows there is a third party keymap editor available from http://xbmcmce.sourceforge.net/, or this editor is also available through the [[Add-on:MCERemote]] add-on.
	keyboard.xml''' is just a text file so you can edit it it using any text editor e.g. in Windows use Notepad++. In Windows there is a third party keymap editor available from http://xbmcmce.sourceforge.net/, or this editor is also available through the [[Add-on:MCERemote]] add-on.

	<big>'''Windows'''</big>		<big>'''Windows'''</big>