Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
darakuneko committed Jan 14, 2023
1 parent 2efdf89 commit 9387f22
Showing 1 changed file with 135 additions and 0 deletions.
135 changes: 135 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,141 @@ info.json - required fields
KLE json edited like VIA
https://www.caniusevia.com/docs/layouts


Convert (KLE json to QMK/Vial)
-------
https://user-images.githubusercontent.com/5214078/212449688-c9263962-5a9b-4e65-ae74-3c8a1c443887.mp4

#### KLE Guidelines

<img width="896" src="https://user-images.githubusercontent.com/5214078/212449850-e3fb4a3b-211d-4841-9128-7072bb05c7da.png">

If Keyboard Name and Author are entered, keyboard and username will be automatically populated upon import.

![switch](https://user-images.githubusercontent.com/5214078/212447224-56b04aa8-387c-4bf9-a8d3-bf383770c18c.png)

- 0: "label" in the info.json and layer 0
- 1: layer 1
- 2: (VIAL only) If there is a 'u' here, the key is included as a key for the unlock combo (Same as Firmware 'scripts)
- 3: Multilayout index (Same as Firmware 'scripts)
- 4: (VIAL only) If there is an 'e' here, the key is an encoder (Same as Firmware 'scripts)
- 5: Multilayout value (Same as Firmware 'scripts)
- 6: Secondary Multilayout name (Same as Firmware 'scripts)
- 7: Primary Multilayout name/label (Same as Firmware 'scripts)
- 8: layer 2
- 9: Row
- 11: Col

0 can use label.    
If the label of keycodes matches the 0 value of KLE Json, it is converted to "aliases" or "key" at layer 0.
In info.json, it is used as is.
https://keyboards.qmk.fm/v1/constants/keycodes_0.0.1.json
In 0, 1, and 8, a blank space is KC_NO.

Please refer to these KLE and make it.
https://t.ly/bNH0
https://t.ly/Y3BEW
https://t.ly/xiJG8

Main labels
```
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
1
2
3
4
5
6
7
8
9
0
Enter
Esc
Backspace
Tab
Spacebar
-
=
]
[
\\
#
;
'
`
,
.
/
Caps Lock
F1
F2
F3
F4
F5
F6
F7
F8
F9
F10
F11
F12
Print Screen
Scroll Lock
Pause
Insert
Home
Page Up
Delete
End
Page Down
Right
Left
Down
Up
Num Lock
Menu
Mute
Volume Up
Volume Down
Caps Lock
Num Lock
Left Control
Left Shift
Left Alt
Left GUI
Right Control
Right Shift
Right Alt
Right GUI
```


Update Repository
-------
Clone again to the latest state.
Expand Down

0 comments on commit 9387f22

Please sign in to comment.