VoiceAssistant - Setup Guide
What is Javi?
A multifunction and fully offline usable open-source voice assistant written in Java.
Features
Completely customizable by writing your own plugins and ovlerlay with many function .
Used libraries in this Project:
- MaryTTS (Text-To-Speech)
- Vosk (speech recognizer)
- QT / QT Jambi (just the simple Text-Overlay)
- java-discord-rpc (Discord RPC)
- dbus java for communicating with MPRIS
- a PC based on x86_64 (amd64) with a Linux installation or MacOS
- Java (version 18 recommended)
- QT 6
- Git (optional, only for downloading)
- any x86_64 PC OS doesn't matter
- Java
- Git (optional, only for downloading)
- java-discord-rpc (Discord RPC)
- dbus java for communicating with MPRIS
- Running standalone:
- 1.Clone the repository:
git clone https://github.com/TheRedstoneDEV-DE/VoiceAssistant
and get the voice model for vosk from (the small one is recommended) VOSK Models unzip it, rename the folder inside it to 'model' and put it into the project root -
2.Build:
mvn install -
3.Run the Jar file, which was generated in the 'target' folder after copieng it into the project root:
java -jar [JARFILE] -
4.Configure via setup window:
The fields in the window should be selfexplaining:
- 'Overlay position' definines the coordinates for the overlay (should only be necessary, if you have multiple screens)
- 'CPU temp file' defines the file, in which the cpu temperature is logged by the kernel (if you don't have the overlay enabled, this is not used at all)
- any MPRIS settings are just defining, which player you are targeting in the dbus interface (you can start, pause and skip titles with voicecommands)
Building and Running
Requirements to run fully:
Requirements to run (only basic funtionality):
git clone https://github.com/TheRedstoneDEV-DE/VoiceAssistant
and get the voice model for vosk from (the small one is recommended) VOSK Models unzip it, rename the folder inside it to 'model' and put it into the project root on the server.
mvn install
java -jar [JARFILE]
device (here it really could be Windows and should'n affect anything)
Next you will be asked some questions, because of the certificate and a password for the key (you should remember it, because you need
it when running)
bash genkeys.sh
KEY_PASSPHRASE=[Password of the Keystore] java -jar [JARFILE] --server
Then the client (you could even use multiple with one server):
KEY_PASSPHRASE=[password of the Truststore] java -jar [JARFILE]
--client [server IP address]
List of commands
| command | short explanation |
|---|---|
| hey computer | just the base command, has to be said, before any other voice command |
| set volume to [number between 10-90] percent | sets the volume of the main audio output via mixer |
| open [application name] | opens the named application in another "screen" |
| reconfigure | opens the setup ui again (in case you missconfigured something) |
| reconfigure programs | opens the setup ui for adding programs to the open [application name] command |
| [hide/show] overlay | hides or shows the overlay |
| pause / resume / next / previous | plays/pauses a mediaplayer, skippes one title forward/backward |
List of Environment variables
| env variable | explanation |
|---|---|
| OUTPUT_GAIN | adjusts the output volume of the tts system (in case you are using it with some audio server like alsa) |
| AUDIODEV | sets the audio device for input and ouput, but only if it is supported, if it is not supported the voice assistant won't have any audio |