Getting Started

Requirements

This program requires a working installation of Python 3. Tools such as FFmpeg and OBS Studio are recommended.

Download the latest release from the release page. Install it with:

pip install beatviewer-X.X.X.tar.gz

Install the module directly from my package server:

pip install beatviewer --extra-index-url="https://packages.chalier.fr/"

Clone the repository:

git clone https://github.com/ychalier/beatviewer.git

Then install the module with:

cd beatviewer
python setup.py install

Clone the repository:

git clone https://github.com/ychalier/beatviewer.git

Manually install the dependencies:

cd beatviewer
pip install -r requirements.txt

Then, instead of calling the module with python -m beatviewer <args>, you may execute the beatviewer.py script file instead with:

python beatviewer.py <args>

To check whether your installation really was successful, execute the following command:

python -m beatviewer dummy 60 galaxy

If everything is setup correctly, you should get a metronome beating everything second.

You can get a detailed summary of available options with the -h or --help flag. Basically, it boils down to:

python -m beatviewer <Beat Tracking Args> <Handler Args>

For more details about beat tracking arguments, please refer to the Beat Tracking wiki
For more details about handler arguments, please refer to the Visuals and Tools wikis
Fore more details about the rendering utility, please refer the Rendering wiki