Skip to content

Commit

Permalink
Merge pull request #282 from kodi-game/keyboard-readme
Browse files Browse the repository at this point in the history
game.controller.keyboard: Rename some keys and improve Readme
  • Loading branch information
garbear committed Jan 15, 2024
2 parents dfdf13c + d0265ec commit d0066a7
Show file tree
Hide file tree
Showing 3 changed files with 159 additions and 153 deletions.
153 changes: 3 additions & 150 deletions Readme-Addons.md
Expand Up @@ -90,156 +90,9 @@ Buttons must provide a `type` attribute to specify analog or digital input.

#### Keys

Keys must provide a `symbol` attribute to facilitate keyboard mapping. Symbols are hardware-independent virtual key representations. The following symbols are used:

##### ASCII keys

Symbol | Character | ASCII value
--- | --- | ---
backspace | | 8
tab | | 9
clear | | 12
return | | 13
pause | | 19
escape | | 27
space | | 32
exclaim | ! | 33
doublequote | " | 34
hash | # | 35
dollar | $ | 36
ampersand | & | 38
quote | ' | 39
leftparen | ( | 40
rightparen | ) | 41
asterisk | * | 42
plus | + | 43
comma | , | 44
minus | - | 45
period | . | 46
slash | / | 47
0 | 0 | 48
1 | 1 | 49
2 | 2 | 50
3 | 3 | 51
4 | 4 | 52
5 | 5 | 53
6 | 6 | 54
7 | 7 | 55
8 | 8 | 56
9 | 9 | 57
colon | : | 58
semicolon | ; | 59
less | < | 60
equals | = | 61
greater | > | 62
question | ? | 63
at | @ | 64
leftbracket | [ | 91
backslash | \ | 92
rightbracket | ] | 93
caret | ^ | 94
underscore | _ | 95
grave | ` | 96
a | a | 97
b | b | 98
c | c | 99
d | d | 100
e | e | 101
f | f | 102
g | g | 103
h | h | 104
i | i | 105
j | j | 106
k | k | 107
l | l | 108
m | m | 109
n | n | 110
o | o | 111
p | p | 112
q | q | 113
r | r | 114
s | s | 115
t | t | 116
u | u | 117
v | v | 118
w | w | 119
x | x | 120
y | y | 121
z | z | 122
leftbrace | [ | 123
bar | \| | 124
rightbrace | ] | 125
tilde | ~ | 126
delete | | 127

##### Symbols without ASCII characters
Symbol | Comment
--- | ---
kp0 | Numpad 0
kp1 | Numpad 1
kp2 | Numpad 2
kp3 | Numpad 3
kp4 | Numpad 4
kp5 | Numpad 5
kp6 | Numpad 6
kp7 | Numpad 7
kp8 | Numpad 8
kp9 | Numpad 9
kpperiod | Numpad .
kpdivide | Numpad /
kpmultiply | Numpad *
kpminus | Numpad -
kpplus | Numpad +
kpenter | Numpad Enter
kpequals | Numpad =
up |
down |
right |
left |
insert |
home |
end |
pageup |
pagedown |
f1 |
f2 |
f3 |
f4 |
f5 |
f6 |
f7 |
f8 |
f9 |
f10 |
f11 |
f12 |
f13 |
f14 |
f15 |
numlock |
capslock |
scrollock |
leftshift |
rightshift |
leftctrl |
rightctrl |
leftalt |
rightalt |
leftmeta |
rightmeta |
leftsuper | Left "Windows" key
rightsuper | Right "Windows" key
mode | "Alt Gr" key
compose | Multi-key compose key
help |
printscreen |
sysreq |
break |
menu |
power | Power Macintosh power key
euro | Some European keyboards
undo | Atari keyboard has Undo
oem102 | Present in some European layouts
Keys must provide a `symbol` attribute to facilitate keyboard mapping. Symbols are hardware-independent virtual key representations.

See [Readme-Keyboard.md](Readme-Keyboard.md) for a list of symbols and their properties.

### Topology

Expand Down
153 changes: 153 additions & 0 deletions Readme-Keyboard.md
@@ -0,0 +1,153 @@
## Keyboard Symbols

Keys must provide a `symbol` attribute to facilitate keyboard mapping. Symbols are hardware-independent virtual key representations. The following symbols are used:

### ASCII keys

Symbol | Character | ASCII value | Label (en_gb)
--- | --- | --- | ---
backspace | | 8 | _Backspace_
tab | | 9 | _Tab_
clear | | 12 | _Clear_
enter | | 13 | _Enter_
pause | | 19 | _Pause_
escape | | 27 | _Escape_
space | | 32 | _Space_
exclaim | ! | 33 | _!_
doublequote | " | 34 | _"_
hash | # | 35 | _#_
dollar | $ | 36 | _$_
ampersand | & | 38 | _&_
quote | ' | 39 | _'_
leftparen | ( | 40 | _(_
rightparen | ) | 41 | _)_
asterisk | * | 42 | _*_
plus | + | 43 | _+_
comma | , | 44 | _,_
minus | - | 45 | _-_
period | . | 46 | _._
slash | / | 47 | _/_
0 | 0 | 48 | _0_
1 | 1 | 49 | _1_
2 | 2 | 50 | _2_
3 | 3 | 51 | _3_
4 | 4 | 52 | _4_
5 | 5 | 53 | _5_
6 | 6 | 54 | _6_
7 | 7 | 55 | _7_
8 | 8 | 56 | _8_
9 | 9 | 57 | _9_
colon | : | 58 | _:_
semicolon | ; | 59 | _;_
less | < | 60 | _<_
equals | = | 61 | _=_
greater | > | 62 | _>_
question | ? | 63 | _?_
at | @ | 64 | _@_
leftbracket | [ | 91 | _[_
backslash | \ | 92 | _\\_
rightbracket | ] | 93 | _]_
caret | ^ | 94 | _^_
underscore | _ | 95 | _
grave | ` | 96 | _`_
a | a | 97 | _A_
b | b | 98 | _B_
c | c | 99 | _C_
d | d | 100 | _D_
e | e | 101 | _E_
f | f | 102 | _F_
g | g | 103 | _G_
h | h | 104 | _H_
i | i | 105 | _I_
j | j | 106 | _J_
k | k | 107 | _K_
l | l | 108 | _L_
m | m | 109 | _m_
n | n | 110 | _n_
o | o | 111 | _O_
p | p | 112 | _P_
q | q | 113 | _Q_
r | r | 114 | _R_
s | s | 115 | _S_
t | t | 116 | _T_
u | u | 117 | _U_
v | v | 118 | _V_
w | w | 119 | _W_
x | x | 120 | _X_
y | y | 121 | _Y_
z | z | 122 | _Z_
leftbrace | { | 123 | _{_
bar | \| | 124 | _\|_
rightbrace | } | 125 | _}_
tilde | ~ | 126 | _~_
delete | | 127 | _Delete_

### Symbols without ASCII characters

Symbol | Label (en_gb)
--- | ---
kp0 | _Num Pad 0_
kp1 | _Num Pad 1_
kp2 | _Num Pad 2_
kp3 | _Num Pad 3_
kp4 | _Num Pad 4_
kp5 | _Num Pad 5_
kp6 | _Num Pad 6_
kp7 | _Num Pad 7_
kp8 | _Num Pad 8_
kp9 | _Num Pad 9_
kpperiod | _Num Pad ._
kpdivide | _Num Pad /_
kpmultiply | _Num Pad *_
kpminus | _Num Pad -_
kpplus | _Num Pad +_
kpenter | _Num Pad Enter_
kpequals | _Num Pad =_
up | _Up_
down | _Down_
right | _Right_
left | _Left_
insert | _Insert_
home | _Home_
end | _End_
pageup | _Page Up_
pagedown | _Page Down_
f1 | _F1_
f2 | _F2_
f3 | _F3_
f4 | _F4_
f5 | _F5_
f6 | _F6_
f7 | _F7_
f8 | _F8_
f9 | _F9_
f10 | _F10_
f11 | _F11_
f12 | _F12_
f13 | _F13_
f14 | _F14_
f15 | _F15_
numlock | _Num Lock_
capslock | _Caps Lock_
scrollock | _Scroll Lock_
leftshift | _Left Shift_
rightshift | _Right Shift_
leftctrl | _Left Ctrl_
rightctrl | _Right Ctrl_
leftalt | _Left Alt_
rightalt | _Right Alt_
leftmeta | _Left Meta_
rightmeta | _Right Meta_
leftsuper | _Left Windows_
rightsuper | _Right Windows_
mode | _Mode/Option/AltGr_
compose | _Compose_
help | _Help_
printscreen | _Print Screen_
sysreq | _SysReq_
break | _Break_
menu | _Menu_
power | _Power_
euro | _€_
undo | _Undo_
oem102 | _OEM 102nd Key_
Expand Up @@ -459,11 +459,11 @@ msgid "Right Meta"
msgstr ""

msgctxt "#30108"
msgid "Left Super"
msgid "Left Windows"
msgstr ""

msgctxt "#30109"
msgid "Right Super"
msgid "Right Windows"
msgstr ""

msgctxt "#30110"
Expand Down Expand Up @@ -547,7 +547,7 @@ msgid "~"
msgstr ""

msgctxt "#30130"
msgid "Mode"
msgid "Mode/Option/AltGr"
msgstr ""

msgctxt "#30131"
Expand Down

0 comments on commit d0066a7

Please sign in to comment.