Allow vial config to be done at a keyboard level

7 votes

Currently to support vial with a keyboard the following needs to be done
- Add VIAL_KEYBOARD_UID to the config.h in the keymap folder
- Add vial.json to the keymap folder

What would be nice to have is to be able to add a keyboard variant that contains both the vial.json and config.h.

For example currently when you've got 2 keymaps supporting VIAL it look like this.
This would require the vial.json and config.h to be created 2 times

<details><summary>Folder structure now</summary>
<pre>
keyboards/
├─ pieterv24/
│ ├─ testboard/
│ │ ├─ keymaps/
│ │ │ ├─ default/
│ │ │ │ ├─ keymap.c
│ │ │ ├─ pieterv24/
│ │ │ │ ├─ config.h
│ │ │ │ ├─ keymap.c
│ │ │ │ ├─ rules.mk
│ │ │ │ ├─ vial.json
│ │ │ ├─ vial/
│ │ │ │ ├─ keymap.c
│ │ │ │ ├─ rules.mk
│ │ │ │ ├─ vial.json
│ │ │ │ ├─ config.h
│ │ ├─ config.h
│ │ ├─ info.json
│ │ ├─ readme.md
│ │ ├─ rules.mk
│ │ ├─ testboard.c
│ │ ├─ testboard.h
</pre>
</details>

Under consideration Suggested by: Moderator (21 Jul, '21) • Upvoted: 22 Sep, '22 • Comments: 2

Comments: 2

21 Jul, '21
Moderator Admin
My proposal would be to allow the following

<details><summary>Folder structure proposal</summary>
<pre>
keyboards/
├─ pieterv24/
│ ├─ testboard/
│ │ ├─ keymaps/
│ │ │ ├─ default/
│ │ │ │ ├─ keymap.c
│ │ │ ├─ pieterv24/
│ │ │ │ ├─ keymap.c
│ │ │ │ ├─ rules.mk
│ │ ├─ vial/
│ │ │ ├─ vial.json
│ │ │ ├─ config.h
│ │ ├─ readme.md
│ │ ├─ rules.mk
│ │ ├─ testboard.c
│ │ ├─ testboard.h
</pre>
</details>

In this configuration the idea would be that you could compile each keymap as a vial compatible keymap.
For example like this:
`make pieterv24/testboard/vial:default`
`make pieterv24/testboard/vial:pieterv24`

or without vial like:
`make pieterv24/testboard:default`
`make pieterv24/testboard:pieterv24`
1
14 Mar, '23
TweetyDaBird
That would possibly conflict with the fact that some functions in keymaps differ from how vanilla QMK should work.

Possibly make the vial folder on the same level as the keymaps contain the vial config and then nest vial compatible keymaps inside it instead, effectively creating two keymap folders, one dedicated to vial.