Desktop version

Stable release

The preferred way to install Vipster is via a package manager.

It is available in these repositories:

Otherwise, please find precompiled builds here.

Installation instructions

• Windows:
  Unpack the archive, then simply run Vipster.exe.
• Linux:
  After downloading the AppImage, make it executable:

  $ chmod +x Vipster-Linux-x86_64.AppImage

  You can then run it directly:

  $ ./Vipster-Linux-x86_64.AppImage

  or integrate it into your system by installing AppImageLauncher.

Browser version

Vipster can also run in your browser. A standalone application can be found here.
This is a full visualization tool, but lacks many of the editing features of the desktop application.

If you want to include Vipster in your own web application, you can find it on npm:

npm install vipster

Note: rendering requires WebGL2 which unfortunately is blocked by Apple in its Safari browser. Sorry!

Python bindings

If you want to use the Vipster library in your Python environments, you can install them via:

$ pip install vipster

Note:

• if you installed Vipster via a package manager, the bindings may already be installed for your system Python installation
• if you install Vipster via pip, the GUI is not included

Build from source

To build Vipster from source, you need CMake (≥ 3.14) and a C++-17 compatible compiler (including <filesystem> support).

To build the GUI, you also need to install Qt ≥ 5.10.

For detailed build instructions, please refer to INSTALL.md. Other dependencies are described in external/README.md.

It is recommended to obtain the source via Git:

$ git clone https://github.com/sgsaenger/vipster

This allows to easily track development and automatically obtain missing dependencies.