Skip to content

Dougal-s/Vkav

Repository files navigation

Github Actions

Vkav is an audio visualizer written in C++ using Vulkan as its rendering backend.
Shown on the left is the eclipse shader.
MacOS and 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)*
  • Coreaudio (MacOS only)*
  • Libsoundio (optional)
  • X11 (optional)

Compilation Tools:

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

*Windows and MacOS support has not been implemented.

Debian/Ubuntu:

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

Installing

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".

Usage

To run Vkav simply execute:

$ vkav

Config files can be located in "~/.config/Vkav" 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

Acknowledgments

This project was inspired by GLava.