kb01/kyria-keyboard-config
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Compare commits

base: kb01:0d2eb66449a1668d7fe1e9d6278f3a243e3c6fdd
Branches Tags
kb01:main
kb01:v1.0
kb01:f241defe4ad8ab8d1475b65a8180cf9b91ccc0fa
..
compare: kb01:464d88b1fa5bdbcbb6d835daba582c7ad35a0067
Branches Tags
kb01:main
kb01:v1.0
kb01:f241defe4ad8ab8d1475b65a8180cf9b91ccc0fa

3 commits
0d2eb66449 ... 464d88b1fa

Author SHA1 Message Date
kB01
464d88b1fa Added proper documentation to readme
All checks were successful
/ build (push) Successful in 3m54s
Details
2024-09-26 01:39:16 +02:00
kB01
28bc9e8047 Added KLE Renderings 2024-09-26 00:33:24 +02:00
kB01
f49825e675 Changed Color scheme 2024-09-26 00:33:08 +02:00
12 changed files with 149 additions and 68 deletions
Show stats Expand all files Collapse all files

64
README.md
View file

@ -1,2 +1,66 @@
# kyria-keyboard-config
![Gitea Last Commit](https://img.shields.io/gitea/last-commit/kB01/kyria-keyboard-config?gitea_url=https%3A%2F%2Fgit.kb-one.de)
![Forgejo Issues](https://img.shields.io/gitea/issues/open/kb01/kyria-keyboard-config?gitea_url=https%3A%2F%2Fgit.kb-one.de)
![Forgejo Release](https://img.shields.io/gitea/v/release/kb01/kyria-keyboard-config?gitea_url=https%3A%2F%2Fgit.kb-one.de)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
This repository contains the Source Code and Documentation for my Kyria Split Keyboard.
I got mine from [splitkb.com](https://splitkb.com/products/kyria-rev3) (not sponsored), and configured it with a [nice!nano v2](https://nicekeyboards.com/nice-nano/) (not sponsored) and a Linear Rotary Encoder (EC11E183440C).
## Table of Contents
- [Features](#features)
- [Flashing the Keyboard](#flashing-the-keyboard)
- [The Layout](#the-layout)
- [The Keyboard](#the-keyboard)
- [License](#license)
## Features
- Slightly modified [Seniply Layout](https://stevep99.github.io/seniply/)
- RGB Controls
- German QWERTZ layout as fallback or for people trying the keyboard
## Flashing the Keyboard
- Get the latest [Release](https://git.kb-one.de/kb01/kyria-keyboard-config/releases) or [Build](https://git.kb-one.de/kb01/kyria-keyboard-config/actions)
- Double press the reset switch on the left keyboard
- Drag and drop the file kyria_rev3_left-nice_nano_v2-zmk.uf2 on to NICENANO drive
- Double press the reset switch on the right keyboard
- Drag and drop the file kyria_rev3_right-nice_nano_v2-zmk.uf2 on to NICENANO drive
## The Layout
The Layout is Based on the [Seniply Layout](https://stevep99.github.io/seniply/).
Modifications are:
- Removed Symbols from the Symbols Layer which where allready on the Number Layer
- Replaced Colemak-DHm dot and comma with german ones (capital dot = : and capital comma = ;)
- Replaced Colemak-DHm slash and colon with german hash (capital hash = ') and minus
- Added german umlauts to symbol layer.
### Base Layer: Colemak Mod-DH
![Base Layer Image](./docs/keyboard-layout-editor%20base%20colemak-dhm.png)
### Extend Layer
![Extend Layer Image](./docs/keyboard-layout-editor%20extend.png)
### Function Layer
![Function Layer Image](./docs/keyboard-layout-editor%20function.png)
### Symbols Layer
![Symbols Layer Image](./docs/keyboard-layout-editor%20symbol.png)
### Numbers Layer
![Numbers Layer Image](./docs/keyboard-layout-editor%20number.png)
### The Encoder
The Encoder currently is only Programmed to mouse scroll Vertically or Horizontally.
To support this, this Repo currently builds against petejohansons [Pullrequest](https://github.com/zmkfirmware/zmk/pull/2027) for this Feature.
## The Keyboard
Currently I don't have build the Case yet, so it looks a bit barebones.
![Image of physical Keyboard](./docs/photo.jpg)
## License
[MIT © kB01](../LICENSE)

8
docs/keyboard-layout-editor base colemak-dhm.json
View file

@ -1,8 +1,9 @@
[
{
"backcolor": "#1D262F",
"name": "KB's Layout on Kyria rev 3 - Base",
"author": "kB01",
"notes": "Kyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"notes": "Check out my complete Layout at https://git.kb-one.de/kb01/kyria-keyboard-config\n\nKyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"switchMount": "cherry",
"switchBrand": "kailh",
"switchType": "PG151101D49/D09"
@ -10,8 +11,9 @@
[
{
"y": 0.25,
"x": 3,
"c": "#d9dae0",
"x": 3,
"c": "#3C3C3C",
"t": "#ffffff",
"a": 5,
"f": 6
},

BIN
docs/keyboard-layout-editor base colemak-dhm.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 58 KiB

37
docs/keyboard-layout-editor extend.json
View file

@ -1,8 +1,9 @@
[
{
"backcolor": "#1D262F",
"name": "KB's Layout on Kyria rev 3 - Extend",
"author": "kB01",
"notes": "Kyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"notes": "Check out my complete Layout at https://git.kb-one.de/kb01/kyria-keyboard-config\n\nKyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"switchMount": "cherry",
"switchBrand": "kailh",
"switchType": "PG151101D49/D09"
@ -11,7 +12,8 @@
{
"y": 0.25,
"x": 3,
"c": "#d9dae0",
"c": "#3C3C3C",
"t": "#ffffff",
"a": 7,
"f": 6
},
@ -55,11 +57,11 @@
[
{
"y": -0.625,
"c": "#adadad"
"c": "#555555"
},
"TAB",
{
"c": "#d9dae0"
"c": "#3C3C3C"
},
"ESC",
{
@ -67,7 +69,7 @@
},
"Caps",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -76,7 +78,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"⇑\n\n\n\nsticky",
{
@ -120,11 +122,11 @@
[
{
"y": -0.625,
"c": "#adadad"
"c": "#555555"
},
"ESC",
{
"c": "#d9dae0"
"c": "#3C3C3C"
},
"Alt\n\n\n\nsticky",
{
@ -132,7 +134,7 @@
},
"Del",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -141,7 +143,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"<i class='fa fa-copy'></i>",
{
@ -182,11 +184,11 @@
[
{
"y": -0.625,
"c": "#adadad"
"c": "#555555"
},
"",
{
"c": "#d9dae0"
"c": "#3C3C3C"
},
"<i class='mss mss-Undo-5'></i>",
{
@ -195,7 +197,7 @@
},
"Print",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -217,7 +219,8 @@
"ry": 8.175,
"y": -4.675000000000001,
"x": -0.5,
"c": "#a84234"
"c": "#a84234",
"t": "#000000"
},
""
],
@ -226,7 +229,7 @@
"rx": 13,
"y": -4.675000000000001,
"x": -0.5,
"c": "#666666"
"c": "#555555"
},
""
],
@ -236,7 +239,7 @@
"rx": 4,
"y": -4.675000000000001,
"x": -0.5,
"c": "#adadad"
"t": "#ffffff"
},
"&uArr;"
],
@ -310,7 +313,7 @@
"r": -15,
"y": -1,
"x": -0.5,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"<i class='kb kb-Return-2'></i>"
]

BIN
docs/keyboard-layout-editor extend.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 62 KiB

36
docs/keyboard-layout-editor function.json
View file

@ -1,8 +1,9 @@
[
{
"backcolor": "#1D262F",
"name": "KB's Layout on Kyria rev 3 - Function",
"author": "kB01",
"notes": "Kyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"notes": "Check out my complete Layout at https://git.kb-one.de/kb01/kyria-keyboard-config\n\nKyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"switchMount": "cherry",
"switchBrand": "kailh",
"switchType": "PG151101D49/D09"
@ -11,7 +12,8 @@
{
"y": 0.25,
"x": 3,
"c": "#d9dae0",
"c": "#3C3C3C",
"t": "#ffffff",
"a": 7,
"f": 6
},
@ -56,12 +58,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 4
},
"TAB",
{
"c": "#d9dae0"
"c": "#3C3C3C"
},
"<i class='fa fa-stop'></i>",
{
@ -69,7 +71,7 @@
},
"Scr",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -78,7 +80,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"&uArr;\n\n\n\nsticky",
{
@ -125,12 +127,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 4
},
"ESC",
{
"c": "#d9dae0"
"c": "#3C3C3C"
},
"Alt\n\n\n\nsticky",
{
@ -139,7 +141,7 @@
},
"<i class='fa fa-keyboard-o'></i>\n\n\n\nqwertz",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -148,7 +150,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"&uArr;<i class='fa fa-copy'></i>",
{
@ -189,11 +191,11 @@
[
{
"y": -0.625,
"c": "#adadad"
"c": "#555555"
},
"",
{
"c": "#d9dae0"
"c": "#3C3C3C"
},
"<i class='fa fa-volume-off'></i>X",
{
@ -202,7 +204,7 @@
},
"<i class='fa fa-keyboard-o'></i>\n\n\n\ncolemak",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -224,7 +226,8 @@
"ry": 8.175,
"y": -4.675000000000001,
"x": -0.5,
"c": "#a84234"
"c": "#a84234",
"t": "#000000"
},
""
],
@ -242,7 +245,8 @@
"rx": 4,
"y": -4.675000000000001,
"x": -0.5,
"c": "#adadad"
"c": "#555555",
"t": "#ffffff"
},
"&uArr;"
],
@ -316,7 +320,7 @@
"r": -15,
"y": -1,
"x": -0.5,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"<i class='kb kb-Return-2'></i>"
]

BIN
docs/keyboard-layout-editor function.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 65 KiB

36
docs/keyboard-layout-editor number.json
View file

@ -1,8 +1,9 @@
[
{
"backcolor": "#1D262F",
"name": "KB's Layout on Kyria rev 3 - Number",
"author": "kB01",
"notes": "Kyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"notes": "Check out my complete Layout at https://git.kb-one.de/kb01/kyria-keyboard-config\n\nKyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"switchMount": "cherry",
"switchBrand": "kailh",
"switchType": "PG151101D49/D09"
@ -11,7 +12,8 @@
{
"y": 0.25,
"x": 3,
"c": "#d9dae0",
"c": "#3C3C3C",
"t": "#ffffff",
"a": 7,
"f": 8
},
@ -54,12 +56,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 4
},
"TAB",
{
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 8
},
"",
@ -68,7 +70,7 @@
},
"+",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -77,7 +79,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"&uArr;\n\n\n\nsticky",
{
@ -124,12 +126,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 4
},
"ESC",
{
"c": "#d9dae0"
"c": "#3C3C3C"
},
"Alt\n\n\n\nsticky",
{
@ -138,7 +140,7 @@
},
"-",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -147,7 +149,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 8
},
"<i class='kb kb-Tab-1'></i>",
@ -189,12 +191,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 6
},
"",
{
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 8
},
"",
@ -203,7 +205,7 @@
},
"/",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -233,7 +235,8 @@
"rx": 13,
"y": -4.675000000000001,
"x": -0.5,
"c": "#a84234"
"c": "#a84234",
"t": "#000000"
},
""
],
@ -251,7 +254,8 @@
"r": 30,
"y": -2,
"x": -0.5,
"c": "#adadad",
"c": "#555555",
"t": "#ffffff",
"f": 4
},
"HUE"
@ -317,7 +321,7 @@
"r": -15,
"y": -1,
"x": -0.5,
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 4
},
"SPC"

BIN
docs/keyboard-layout-editor number.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 62 KiB

36
docs/keyboard-layout-editor symbol.json
View file

@ -1,8 +1,9 @@
[
{
"backcolor": "#1D262F",
"name": "KB's Layout on Kyria rev 3 - Symbol",
"author": "kB01",
"notes": "Kyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"notes": "Check out my complete Layout at https://git.kb-one.de/kb01/kyria-keyboard-config\n\nKyria Layout from u/Samonitari\nhttps://www.reddit.com/r/ErgoMechKeyboards/comments/fxqp16/kyria_layout_recommendation_anybody/",
"switchMount": "cherry",
"switchBrand": "kailh",
"switchType": "PG151101D49/D09"
@ -11,7 +12,8 @@
{
"y": 0.25,
"x": 3,
"c": "#d9dae0",
"c": "#3C3C3C",
"t": "#ffffff",
"a": 7,
"f": 8
},
@ -54,12 +56,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 4
},
"TAB",
{
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 8
},
"Ä",
@ -68,7 +70,7 @@
},
"Ö",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -77,7 +79,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0"
"c": "#3C3C3C"
},
"&uArr;\n\n\n\nsticky",
{
@ -121,12 +123,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 4
},
"ESC",
{
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 6
},
"Alt\n\n\n\nsticky",
@ -136,7 +138,7 @@
},
"<",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -145,7 +147,7 @@
{
"y": -0.75,
"x": 3,
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 8
},
"\\",
@ -187,12 +189,12 @@
[
{
"y": -0.625,
"c": "#adadad",
"c": "#555555",
"f": 6
},
"",
{
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 8
},
"@",
@ -201,7 +203,7 @@
},
">",
{
"c": "#adadad",
"c": "#555555",
"f": 6
},
""
@ -231,7 +233,8 @@
"rx": 13,
"y": -4.675000000000001,
"x": -0.5,
"c": "#a84234"
"c": "#a84234",
"t": "#000000"
},
""
],
@ -241,7 +244,8 @@
"rx": 4,
"y": -4.675000000000001,
"x": -0.5,
"c": "#adadad"
"c": "#555555",
"t": "#ffffff"
},
""
],
@ -315,7 +319,7 @@
"r": -15,
"y": -1,
"x": -0.5,
"c": "#d9dae0",
"c": "#3C3C3C",
"f": 4
},
"SPC"

BIN
docs/keyboard-layout-editor symbol.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 62 KiB

BIN
docs/photo.jpg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.2 MiB