Home

Installation

Linux

Crucial Steps

This app depends on keyboard scancodes. By default you need to be root to access the scancodes as they are on driver level on Linux. What you can do is having read access to the files that offer the scancodes, for this you need to see who owns /dev/input stuff:

ls -la /dev/input
total 0
drwxr-xr-x  4 root root     400 Oct 29 14:47 .
drwxr-xr-x 20 root root    3920 Oct 29 14:47 ..
drwxr-xr-x  2 root root      80 Oct 29 14:47 by-id
drwxr-xr-x  2 root root     200 Oct 29 14:47 by-path
crw-rw----  1 root input 13, 64 Oct 29 14:47 event0
crw-rw----  1 root input 13, 65 Oct 29 14:47 event1
crw-rw----  1 root input 13, 74 Oct 29 14:47 event10
crw-rw----  1 root input 13, 75 Oct 29 14:47 event11
crw-rw----  1 root input 13, 76 Oct 29 14:47 event12
crw-rw----  1 root input 13, 66 Oct 29 14:47 event2
crw-rw----  1 root input 13, 67 Oct 29 14:47 event3
crw-rw----  1 root input 13, 68 Oct 29 14:47 event4
crw-rw----  1 root input 13, 69 Oct 29 14:47 event5
crw-rw----  1 root input 13, 70 Oct 29 14:47 event6
crw-rw----  1 root input 13, 71 Oct 29 14:47 event7
crw-rw----  1 root input 13, 72 Oct 29 14:47 event8
crw-rw----  1 root input 13, 73 Oct 29 14:47 event9
crw-rw----  1 root input 13, 63 Oct 29 14:47 mice
crw-rw----  1 root input 13, 32 Oct 29 14:47 mouse0
crw-rw----  1 root input 13, 33 Oct 29 14:47 mouse1

So, as you can see the files are owned by root and the group is input. You simply have to add your user to the input group:

# usermod -a -G input eeriemyxi

Here eeriemyxi is the username.

Note

This will give write access to /dev/input stuff. If you are not okay with this, consider adding a new user with a distinct password just to run the project. You would add this account to the input account, but now your primary account.

Manual Installation

Same as Windows' Manual Installation guide. Follow the steps given for manual installation on Windows once you have access to /dev/input.

Windows

Manual Installation

Dependencies

• Poetry 1.6 or newer.
  • See: https://python-poetry.org/docs/#installation
• Python 3.10 or newer.
  • See: https://www.python.org/downloads/

Steps

Clone the main branch:

git clone https://github.com/eeriemyxi/mechvibes-lite

Change the current working directory to the repository:

cd mechvibes-lite

Install the dependencies of the project and the project itself:

poetry install

Done! Now you should be able do use the app (try mvibes run).

Others

Other operating systems are not supported. I'd have added support for Darwin, but I can't afford the environment to test it out on. I will gladly accept contributions though.