magnusja / hippo7

Hippo7, modular vjing tool

Hippo7

"Why is this called hippo7? I don't know, but hippos are cool."

Hippo7 is a tool for visual live shows that can be synchronized to music.

The tool was build by Benedikt Wiberg and myself during an TUM Project at Luminovo.ai.

Documentation

For a quickstart, installation help, examples and cool videos checkout the documentaion.

Development

Pre-commit

Please make sure to have the pre-commit hooks installed. Install pre-commit and then run pre-commit install to register the hooks with git.

Poetry

Use poetry to manage your dependencies. Please make sure it is installed for your current python version. Then to install the defined dependencies for our project run:

poetry install

Makefile

We use make to streamline our development workflow. Run make help to see all available commands.

$ make help 
help                 Show this help message
build                Build the docker container and docs
check                Run all static checks (like pre-commit hooks)
docs                 Serve all docs
test                 Run all tests
test-docker          Run tests in the docker environment
dev-install          Install all the packages in the local python environment for development
run-server           Runs the render server
run-client           Runs the client to control the server