From 1ba34769e1a0d482ae1d34042c8918eaf81d3890 Mon Sep 17 00:00:00 2001 From: cyber-sushi <99445392+cyber-sushi@users.noreply.github.com> Date: Fri, 1 Dec 2023 23:49:17 +0100 Subject: [PATCH] Docs updated for v0.2.1 --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 372804a..55fac1c 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,9 @@ Previously only a controller daemon, the scope has now been extended because I h - Autostart it from your window manager's config file (usually `exec /path/to/makima`). ## Configuration: -You can find some sample config files on this Github. -Pick one that fits your use case and copy it inside `~/.config/makima`, then edit it to your needs. -To associate a config file to an input device, the file name should be identical to that of the device. -For example, if you run `evtest` and see that your Dualshock 4 controller is named "Sony Interactive Entertainment Wireless Controller", then you'll have to name your config file "Sony Interactive Entertainment Wireless Controller.toml". +You can find some sample config files on this Github; pick one that fits your use case and copy it inside `~/.config/makima`, then edit it to your needs.\ +**To associate a config file to an input device, the file name should be identical to that of the device.**\ +For example, if you run `evtest` and see that your Dualshock 4 controller is named "Sony Interactive Entertainment Wireless Controller", then you'll have to name your config file "Sony Interactive Entertainment Wireless Controller.toml".\ All config files will be parsed automatically when `makima` is launched. The config file has three sections, a `[keys]` section, where you'll remap your keys, a `[rel]` section to remap scroll wheels and a `[settings]` section containing a few options. @@ -58,9 +57,9 @@ BTN_RIGHT = ["KEY_S", "KEY_H", "KEY_U", "KEY_T", "KEY_D", "KEY_O", "KEY_W", "KEY BTN_MIDDLE = ["KEY_S", "KEY_H", "KEY_U", "KEY_T", "KEY_D", "KEY_O", "KEY_W", "KEY_N", "KEY_SPACE", "KEY_N", "KEY_O", "KEY_W", "KEY_ENTER"] ``` To check all of the available key codes, refer to the file `/usr/include/linux/input-event-codes.h`.\ -Remember that keys like Ctrl and Alt will have key codes like `KEY_LEFTCTRL`, `KEY_RIGHTCTRL`, `KEY_LEFTALT` and `KEY_RIGHTALT`. Just using `KEY_CTRL` and `KEY_ALT` will throw a parsing error because the key code does not exist. +Remember that keys like Ctrl and Alt will have key codes like `KEY_LEFTCTRL`, `KEY_RIGHTCTRL`, `KEY_LEFTALT` and `KEY_RIGHTALT`. Just using `KEY_CTRL` and `KEY_ALT` will throw a parsing error because the key code does not exist.\ Keys that are not explicitly remapped will keep their default functionality. -If you don't need to remap keys, you can just omit the entire `[keys]` paragraph. +If you don't need to remap any key, you can just omit the entire `[keys]` paragraph. ### \[rel] Example where the mouse scroll wheel will zoom in and out of a browser page: