cajhin / capsicain

Powerful low-level keyboard remapping tool for Windows
362 stars 18 forks source link

documentation suggestion #91

Closed fmadio closed 1 year ago

fmadio commented 1 year ago

awesome project, this is exactly what was looking for thank you for sharing

while trying to understand how this works. would recommend updating the documentation

perhaps here https://github.com/cajhin/capsicain/wiki/.ini-Rules

as fresh eyes on this, how the modifier map works took a bit of digging. its mentioned here https://github.com/cajhin/capsicain/issues/7#issuecomment-727239762

probably maps to the enums here https://github.com/cajhin/capsicain/blob/master/capsicain/modifiers.cpp#L9

docs would be

Modifiers can be down (&), up (^), tapped (T) or ignored (.)

Modifier state [.... .... ....] described as follows

[.... .... ...&]   Left Shift key down
[.... .... ..&.]   Left Ctrl key down
[.... .... .&..]   Left Alt key down
[.... .... &...]   Left Win key down

[.... ...& ....]   Right Shift key down
[.... ..&. ....]   Right Ctrl key down
[.... .&.. ....]   Right Alt key down
[.... &... ....]   Right Win key down

[...& .... ....]   MOD9 key down
[..&. .... ....]   MOD10 key down
[.&.. .... ....]   MOD11 key down
[&... .... ....]   MOD12 key down

the enums seem to go up to 15?

cajhin commented 1 year ago

hi, does this https://github.com/cajhin/capsicain/wiki/Modifier-Strings answer your questions, or is anything left unclear?

fmadio commented 1 year ago

yes thats exactly what was looking for, thanks.