Vkav is an audio visualizer written in C++ using Vulkan as its rendering backend.
Shown on the left is the eclipse shader.
Windows support has not been implemented

Getting Started

Binaries can be found under releases or on the Vkav website.

Prerequisites

• GLFW
• Vulkan
• libpng (optional)
• libjpeg (optional)
• Pulseaudio (Linux only)
• WASAPI (Windows only)*
• Libsoundio (optional)
• X11 (optional)

Compilation Tools:

• g++ >= 8 or clang++ >= 7
• cmake >= 3.12

*Windows support has not been implemented.

Debian/Ubuntu:

Install the required dependencies by running:

$ sudo apt install libglfw3-dev libvulkan-dev libpulse-dev libpng-dev libjpeg-dev libx11-dev

Installing

Linux:

Clone the repository and compile Vkav using:

$ git clone https://github.com/Dougal-s/Vkav.git
$ cd Vkav
$ mkdir build && cd build
$ cmake ..
$ make

and finally install Vkav using:

$ sudo make install

To install the config files to a user accessible location, run:

$ vkav --install-config

This will copy the config files from "/etc/vkav" to "~/.config/vkav".

MacOS (>= 10.15):

This assumes you have brew installed.

Install the required dependencies by running:

$ brew install glfw3 libsoundio libpng jpeg

Install the Vulkan SDK to some permanent location.

In order to compile vkav run:

$ git clone https://github.com/Dougal-s/Vkav.git
$ cd Vkav
$ mkdir build && cd build
$ cmake .. -DVULKAN_SDK_PATH="absolute path to vulkan sdk" -DINCLUDE_X11=OFF
$ make

Once that is finished, head over to the MacOS directory for instructions on building a .app bundle.

Usage

To run Vkav simply execute:

$ vkav

Config files can be located in "~/.config/vkav" on Linux and "~/Library/Preferences/vkav" on MacOS once the user has executed Vkav --install-config.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Authors

• Dougal Stewart - Dougal-s

Acknowledgments

This project was inspired by GLava.