jay/qmk_firmware
1
0
Fork 0
mirror of https://github.com/jmwtsn/qmk_firmware.git synced 2026-06-03 19:53:31 -03:00
Code Issues Packages Projects Releases Wiki Activity

Allow custom data sync for community modules (#25955)

Browse Source 
* Allow custom data sync for community modules

* Stub out community_config.h codegen

* Fix SPLIT_TRANSACTION_RPC logic
This commit is contained in:
Joel Challis
2026-02-19 11:03:26 +00:00
committed by GitHub
parent a0166fef43
commit 5591a68b65
10 changed files with 154 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/community_modules.md
+8
View File
@@ -95,6 +95,10 @@ The use of `features` matches the definition normally provided within `keyboard.
The `keycodes` array allows a module to provide new keycodes (as well as corresponding aliases) to a keymap.
### `config.h`
This file will be automatically added to the build as if it were present in the keyboard or keymap.
### `rules.mk` / `post_rules.mk`
These two files follows standard QMK build system logic, allowing for `Makefile`-style customisation as if it were present in the keyboard or keymap.
@@ -131,6 +135,10 @@ This file defines LED matrix effects in the same form as used with `led_matrix_k
This file defines RGB matrix effects in the same form as used with `rgb_matrix_kb.inc` and `rgb_matrix_user.inc` (see [Custom RGB Matrix Effects](rgb_matrix#custom-rgb-matrix-effects)). Effect mode names are prepended with `RGB_MATRIX_COMMUNITY_MODULE_`.
### Custom split keyboard data sync
Defines follow the convention, `SPLIT_TRANSACTION_IDS_MODULE_<MODULE>` (see [Custom LED Matrix Effects](split_keyboard#custom-data-sync)).
### Compatible APIs
Community Modules may provide specializations for the following APIs: