anna/joyful
1
0
Fork 0
Code Pull requests Releases Activity Actions

Documentation on getting keycodes.

Browse source
This commit is contained in:
Anna Rose Wiggins 2025-07-05 11:27:34 -04:00
parent 7ef62cbdc7
commit 102e0808f8
1 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

18
readme.md
View file

@ -17,7 +17,7 @@ Joyful might be the tool for you.
### Current Features - try them today!
* Create virtual devices with up to 8 axes and 80 buttons.
* Create virtual devices with up to 8 axes and 56 buttons.
* Make simple 1:1 mappings of buttons and axes: Button1 -> VirtualButtonA
* Make combination mappings: Button1 + Button2 -> VirtualButtonA
* Multiple modes with per-mode behavior.
@ -29,6 +29,7 @@ Joyful might be the tool for you.
* Macros - have a single input produce a sequence of button presses with configurable pauses.
* Sequence combos - Button1, Button2, Button3 -> VirtualButtonA
* Proportional axis to button mapping; repeatedly trigger a button with an axis, with frequency controlled by the axis value
* More ways to specify keycodes
## Configuration
@ -64,6 +65,21 @@ All `rules` must have a `type` field. Valid values for this field are:
Configuration options for each type vary. See <examples/ruletypes.yml> for an example of each type with all options specified.
### Keycodes
Currently, there is only one way to specify a button or axis: using evdev's Keycodes. These look like `ABS_X` for axes and `BTN_TRIGGER`
for buttons. See <https://github.com/holoplot/go-evdev/blob/master/codes.go> for a full list of these codes, but note that Joyful's virtual devices currently only uses a subset. Specifically, the axes from `ABS_X` to `ABS_RUDDER`, and the buttons from `BTN_JOYSTICK` to `BTN_DEAD`, as well as all of the `BTN_TRIGGER_HAPPY*` codes.
For input, you can figure out what keycodes your device is emitting by running the Linux utility `evtest`. `evtest` works well with `grep`, so if you just want to see button inputs, you can do:
```
evtest | grep
```
The authors of this tool recognize that this is currently a pain in the ass. Easier ways to represent keycodes (as well as outputting additional keycodes) is planned for the future.
We don't have the cycles to develop tool-assisted configuration, but pull requests (or separate projects that produce compatible YAML) are very welcome!
### Modes
The top-level `modes` field is a simple list of strings, defining the different modes available to rules. The initial mode is always