Home

Welcome to the Vokey wiki!

What is Vokey?

Vokey is an application that runs user-defined macros when specific keywords are detected by voice recognition.

Vokey is seperated into two different programs:

• vokey_service: This runs in the background doing voice recognition and activating corresponding actions.
• vokey_manager: This is a configuration tool to allow for easier use of Vokey, using a graphical interface.

Vokey allows you to configure multiple profiles. Each profile contains several events, which in turn activate actions.

How do I contribute?

A good first step is to report any problems you encounter in the GitHub Issues tab. You're also welcome to suggest anything that would improve Vokey.

If you want to do more, feel free to have a look through the source code. Most of it is described using comments to allow for easier reading.

Can I use Vokey without the GUI?

Yes. The vokey_service doesn't have a GUI and configures itself by reading the configuration files (.json format) from ~/.config/vokey. If you want to, you can edit them by hand, although errors in these config files may result in vokey_service crashing.