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

Update documentation.

Browse source
This commit is contained in:
Anna Rose Wiggins 2025-08-04 15:27:25 -04:00
parent 97e1aa83e3
commit e4246dd62e
2 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/readme.md
View file

@ -22,6 +22,7 @@ Each entry in `devices` must have a couple of parameters:
A couple of additional notes on virtual devices:
* Users are encouraged to use the `preset` options whenever possible. They have the highest probability of working the way you expect. If you need to output to multiple types of device, the best approach is to create multiple virtual devices.
* For all 3 of the above options, there is a priority order. If you specify a `preset`, it will be used ignoring any other settings. An explicit list will override the corresponding `num_` parameter.
* Some environments/applications are prescriptive about what combinations make sense; for example, they will only register mouse events if the device *only* supports mouse-like events. The `presets` attempt to take this into account. If you are defining capabilities manually and attempt to mix and match button codes, you may also run into this problem.