⚠️ The project is no longer beeing maintained due to overwhelming tech-debt. You can find the successor project here.
The Next-Generation Open-Source Virtual Assistant (or NOVA) is an easily expandable and modifyable virtual assistant. It uses Modules to add functionality. This repository will help you with developing Modules by providing tools, templates and guides.
A Module is essentially code that can be executed by NOVA. Every Module needs a manifest.json file with a predetermined structure in order for NOVA to use it. You can use the provided ManifestBuilder.py to build a correct manifest in the console.
Each module is its own folder, all located in 'Modules'. In the folder, there needs to be a manifest.json and the Entry Script. Other then that, the structure of your module is open and you can design it however you want.
When you run ManifestBuilder.py, it will search for a preexisting manifest.json file in the same directory. If it doesn't find one, it will create it. In the menu, you will be presented with a list of functions. Choose one by typing its number and press enter. Every function contains parameters that you have to fill out. Choose one by typing its number and press enter. Fill out the info and press enter again to return to the main menu.
- Module Name (required): The name of your module.
- Module Description (required): A description of what your module does, what information it returns and when and how to use it.
- Entry Script (required): The name of the script in which the Entry Function is that will be called when the module is called. Must be in the root directory of the module. Include the file extension ('ScriptName.py').
- Entry Function (required): The function in the Entry Script that will be called. The parentheses at the end are not required ('EntryFunction').
- Parameters (optional): Opens a new menu. Here you can choose a parameter to edit, add a new one or deltete one. The parameters are passed to your entry function. The number of parameters must match the number of parameters your Entry Function takes. Each parameter needs a name, description and type (String, Integer, etc.)
The Entry Script is a python file that sits in the root directory of your module and contains the Entry Function that will be called to activate the module. The Entry Script can either return None, or a String. These will be considered a sucessfull execution of the module. If a string is returned, it will be passed back to the AI. If False is returned, the execution is considered to have failed. You can use these to give the AI extra context about what your module is doing.
The Nova API is a python file that sits in the root directory and allows you to control and monitor Nova from another program.
- Make sure your python scripts working directory is the same as the root directory of Nova.
- Run
Import NovaAPI- You now have access to the following functions:
NovaAPI.SetSetting(name, value) #Change a setting
NovaAPI.GetSetting(name) #Get the value of a setting
NovaAPI.SetKey(name, value) #Change an API key
NovaAPI.GetKey(name) #Get the value of an API key
NovaAPI.StartNova(hotword) #Run Nova in the background. The parameter is aboolean that decides wether the hotword detection should run.
NovaAPI.StopNova() #Stop the current instance of Nova
NovaAPI.GetStatus() #Get the current status of Nova. 0 == Nova is turned off, 1 == Nova is turned on, 2 == Nova is currently starting
NovaAPI.AddToConversation(role, content) #Add something to the conversation. Role is a string. Choose from "user", "assistant" and "system". Content is the actual message.
NovaAPI.GetConversation() #Get the conversation history.
NovaAPI.SetConversation() #Completly overwrite the conversation with your own
NovaAPI.RunWithSpeech() #Prompt the language model to generate an answer and use the TTS to speak it.
NovaAPI.Run() #Prompt the language model to generate an answer. The answer is returned to you and not spoken by the TTS.
NovaAPI.ToggleHotwordDetection(OnOff) #The parameter is a boolean that will activate or deactivate the hotword detection
NovaAPI.Speak(text) #Use the TTS directly to say out the string of text you enter.As a Module is, at its core, just Python code that gets executed by Nova, it allows bad actors to run harmful code on your machine that could damage your machine, steal your data or similar. To prevent this, certain Python libraries cannot be used in a module. These include os, sys, subprocess and keyring. When developing a module, do not use these libraries, as trying to import them in your code will result in your code being terminated by the Nova system and the user receiving a warning about the module. Keep in mind that this system is not perfect and bad actors can still find ways to execute harmful code on your machine using Nova Modules. This is why you should always double-check the source code of Modules before running them and just use Modules which you completely trust. Nova's security systems will be updated over time to improve security; however, the best way to protect yourself is to never trust a Module that you have not developed yourself or when you do not understand how it works.