1
- ## Linux
1
+ ## Installation
2
+ !!! important
3
+ Minimum Python version required is 3.10. Please check by running `python3
4
+ --version`.
5
+
6
+ Run the following command in a terminal:
7
+
8
+ ``` shell
9
+ python3 -m pip install --local git+https://github.com/eeriemyxi/mechvibes-lite
10
+ ```
11
+
12
+ Now you should be able to do ` mvibes --version ` from your terminal. If not then
13
+ I am afraid you have a messy Python3 setup on your system. However if everything
14
+ is fine then please follow the next instructions in the next header.
15
+
16
+ ## Getting Access to Input Events
2
17
This program uses [ scan codes] ( https://en.wikipedia.org/wiki/Scancode ) to detect
3
18
keyboard input. Scan codes are not readable to normal users out-of-the-box on
4
19
Linux. Below are various methods to get access to scan codes on Linux.
@@ -18,9 +33,10 @@ Then log out and log back in. Now you should have read access to events in
18
33
instructions] ( #testing-access-for-input-event ) .
19
34
20
35
### Method II
21
- !!! warning
22
- This method is more involved and requires much more knowledge about what
23
- you are doing. Do not attempt it until you do.
36
+ !!! warning
37
+ This method is more involved and requires you to understand what you
38
+ are doing; please do not attempt it if all you do right now is copy-paste
39
+ random commands into your terminal.
24
40
25
41
When you do ` mvibes daemon ` it automatically starts a ` wskey ` daemon unless told
26
42
otherwise. ` wskey ` daemon is essentially just a websocket server that sends the
@@ -127,3 +143,8 @@ Event: time 1734882563.557881, -------------- SYN_REPORT ------------
127
143
Event: time 1734882563.726942, type 1 (EV_KEY), code 18 (KEY_E), value 1
128
144
Event: time 1734882563.726942, -------------- SYN_REPORT ------------
129
145
```
146
+
147
+ # What To Do Next?
148
+ Now that you access to input events, you will have to add ` wskey.event_id `
149
+ option in your configuration file. More in-depth explanation is
150
+ [ here] ( ../configuration.md ) .
0 commit comments