Usage¶
This page is a guide to using Mechvibes Lite from the command-line.
Important
Please ensure you have the software installed by following the instructions here.
Running Mechvibes Lite¶
mvibes daemon
Important
Please ensure you have a proper configuration file beforehand by following the instructions here.
Tip
A Wskey server is automatically ran in the background for you unless it is told otherwise.
Wskey¶
Wskey is included in the standard installation of Mechvibes Lite. It is a background process that tells Mechvibes Lite which keys you are pressing. That lets the main program know when to play which sound file. More advanced introduction below.
Wskey under the hood is just a WebSocket server. You can start this daemon yourself by doing the following:
mvibes wskey daemon
Wskey daemon on Linux depends on the evdev package from Pypi repositories. For
Windows it depends on keyboard package from the same repository.
Warning
As of now, the connection is fully un-encrypted. The only information the daemon sends are the scan codes. Unless a malicious program is specifically targeting Mechvibes Lite users, it should be plentifully obscure what the server is actually sending. However encrypted connection may be introduced in a future release.
The host address and the port is first fetched from wskey key in the
configuration file. More information is available here.
However the subcommand has a number of flags to override the configuration file:
mvibes wskey daemon --host localhost --port 8765 --event-id 18
Additionally the main daemon subcommand also has --wskey-port and
--wskey-host flags to specify which server to connect to.
Disable Automatically Starting a Wskey Server¶
By default when you do mvibes daemon it starts a Wskey server for you
automatically. To override this behavior, you may use the --no-wskey flag:
mvibes --no-wskey daemon