💾 Get the current version of Volux over at 🦊 the GitLab repository here.

NEW REPOSITORY: https://gitlab.com/volux/volux

Volux

Description

Volux is a high-level media/entertainment workflow automation platform.

Demos

Demo Video

Getting Started

Important Notes

Incompatibilities

Please note that pyaudio - a requirement of the voluxaudio module - does not support python versions above 3.6.9 on windows 10. Any version of Python 3.6.x should work fine.

Installation

Requirements

* may already be installed on your OS, only install if install fails

** normally installed by default with python 3

Installing Volux and modules

To install Volux, enter the following into your operating system's CLI

• Windows users, use powershell
• Mac/Linux users, use terminal *

* note for Linux users: install in a virtual environment to avoid heartache

Using Volux

Enter the following in your operating system's CLI

* make sure voluxgui is installed first or you'll get an error!

Documentation

For more information on how to use volux and how it works, check out the documentation here.

What does it do?

Volux operates using an Operator object and various instances of VoluxModule subclasses.

Each aspect of your media/entertainment setup is represented by it's own volux module.

The operator object acts as a hub for a standard method of communication between volux modules added to it.

These modules can read/write data of the associated aspects in coordination with each other to create seamless workflows.

Installing from source

See here.

Basic script for creating a workflow

Breakdown of setup

1. Import the framework + essentials

import volux

2. Import modules for use

from voluxcliprint import VoluxCliPrint
from voluxaudio import VoluxAudio
from voluxGui import VoluxGui

3. Create operator object

vlx = VoluxOperator()

4. Load the modules into the operator

vlx.add_module(VoluxCliPrint())
vlx.add_module(VoluxAudio())
vlx.add_module(
    VoluxGui(shared_modules=[vlx.audio,vlx.cli]),
    req_permissions=[
        volux.RequestNewConnection,
        volux.RequestGetConnections,
        volux.RequestStartSync
    ]
)

5. Launch the GUI!

vlx.gui.init_window()

Issues and bugs

If you have any problems running Volux, please kindly post an issue to this repository. Issues can be solved much faster if you can provide:

• Operating system
• Desktop environment (if using Linux)
• Python version
• Summary of issues experienced
• Relevant screenshot/s (if applicable)

Additional testing has been done under these conditions: