Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 3.86 KB

README.md

File metadata and controls

75 lines (52 loc) · 3.86 KB
Raw

Virtual Puppet Project (VPupPr)

Chat on Discord

All models should work as long as they are in .glb or .vrm format. .gltf has not been tested but might work. .scn files created with Godot should all import correctly as well.

The project status is tracked via a public GitHub project here.

Available trackers

Controls

  • spacebar - Calibrate your model. Useful when your camera is not directly in front of you
  • escape - Show/hide the UI

Quickstart

Regular releases are available under Releases.

Nightly releases for all supported operating systems are available via GitHub actions.

Windows

  1. Download the latest release
  2. Unzip all files into a directory (do not move any of the files)
  3. Run the .exe
  4. Start the facetracker from within the application

Linux

Flatpak

  1. Ensure that Flathub is enabled on your system
  2. Using a graphical interface that supports Flatpak, search for "virtual puppet project"
    1. Alternatively, you can use flatpak install vpuppr to list any apps that have the same string
    • VPupPr will be available under the name com.github.virtual_puppet_project.vpuppr
    • For the latest (alpha, beta) builds of VPupPr, you can download them from Flathub Beta
  3. Hit the install button and run it just like any other app!

Gentoo (GURU)

vpuppr is available on the GURU overlay for Gentoo.

  1. Add the GURU overlay with either eselect-repository or layman
  2. Sync and emerge vpuppr as normal

Using a precompiled binary

  1. Download the latest release
  2. Unzip all files into a directory (do not move any of the files)
  3. Run the binary
  4. Start the facetracker from within the application

Building from source

  1. Clone or download this repository at the appropriate tag (or master for the latest commit)
    • This repository uses git submodules, so the --recurse-submodules flag will need to be passed in order to clone the submodules as well
  2. Download a precompiled Godot editor binary from the virtual-puppet-project's Godot fork
  3. Download a precompiled Godot release template from the same repository in step 2
  4. Run python3 scripts/setup_extensions.py --setup to setup extensions
  5. Run the custom Godot editor and open your local copy of vpuppr with the editor
  6. Follow the Godot instructions for exporting a project and use the custom templates downloaded from step 3 instead of the default templates
  7. Next to your resulting binary, copy the resources folder next to it. The resources folder is read at runtime

Special thanks