77 lines
3.8 KiB
Markdown
77 lines
3.8 KiB
Markdown
# Joyful Configuration
|
|
|
|
Configuration is divided into three sections: `devices`, `modes`, and `rules`. Each yaml file can have any number of these sections; joyful will combine the configuration from all files at runtime.
|
|
|
|
### Device configuration
|
|
|
|
Each entry in `devices` must have a couple of parameters:
|
|
|
|
* `name` - This is an identifier that your rules will use to refer to the device. It is recommended to avoid spaces or special characters.
|
|
* `type` - Should be `physical` for an input device, and `virtual` for an output device.
|
|
|
|
`physical` devices must additionally define these parameters:
|
|
|
|
* `device_name` - The name of the device as reported by the included `evlist` command. If your device name ends with a space, use quotation marks (`""`) around the name.
|
|
|
|
`virtual` devices must additionally define these parameters:
|
|
|
|
* `buttons` - a number between 0 and 80. Linux may not recognize buttons greater than 56.
|
|
* `axes` - a number between 0 and 8.
|
|
|
|
Virtual devices can also define a `relative_axes` parameter; this must be a list of `REL_` event keycodes, and can be useful for a simulated mouse device. Some environments will only register mouse events if the device *only* supports mouse-like events, so it can be useful to isolate your `relative_axes` to their own virtual device.
|
|
|
|
### Rules configuration
|
|
|
|
All `rules` must have a `type` parameter. Valid values for this parameter are:
|
|
|
|
* `button` - a single button mapping
|
|
* `button-combo` - multiple input buttons mapped to a single output. The output event will trigger when all the input conditions are met.
|
|
* `button-latched` - a single button mapped to a single output, but each time the input is pressed, the output will toggle.
|
|
* `axis` - a simple axis mapping
|
|
* `axis-to-button` - causes an axis input to produce a button output. This can be repeated with variable speed proportional to the axis' input value
|
|
* `axis-to-relaxis` - like axis-to-button, but produces a "relative axis" output value. This is useful for simulating mouse scrollwheel and movement events.
|
|
|
|
Configuration options for each rule 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 KEY_
|
|
```
|
|
|
|
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.
|
|
|
|
## Modes
|
|
|
|
Modes are optional, and also have the simplest configuration. To define modes, add this to your configuration:
|
|
|
|
```
|
|
modes:
|
|
- mode1
|
|
- mode2
|
|
- mode3
|
|
```
|
|
|
|
The first mode that Joyful reads will be the mode that Joyful starts up in. For that reason, it is recommended to define all your modes in the same file.
|
|
|
|
Once modes are defined, each rule may specify a `modes` parameter. That rule will only be processed if a matching mode is active. If a rule omits the `modes` parameter, it will be processed in all modes.
|
|
|
|
For example:
|
|
|
|
```
|
|
rules:
|
|
- name: Test Rule 1 # This rule will be used when we are in mode1 or mode2
|
|
modes:
|
|
- mode1
|
|
- mode2
|
|
# define the rest of the rule here...
|
|
- name: Test Rule 2 # This rule will be used when we are in mode3
|
|
modes:
|
|
- mode3
|
|
# define the rest of the rule here...
|
|
```
|