How do I set up Vpuppr with MediaPipe for facial tracking?

You need to build Vpuppr from source using the setup.sh script, which requires installing Godot, Rust, and Python, then configure MediaPipe to send tracking data to the application via its supported protocols.

Does Vpuppr work with VRM models from VRoid Studio?

Yes, Vpuppr supports VRM model loading, which includes models exported from VRoid Studio, a popular tool for creating 3D VTuber avatars. Ensure the VRM file is compatible and loaded correctly in the application.

What are the system requirements for running Vpuppr?

Vpuppr requires a system capable of running Godot 4.1.x, with dependencies like Rust and Python for building. Real-time performance depends on your hardware for 3D rendering and tracking input processing.

Can I use Vpuppr for live streaming on Twitch?

Yes, it can animate avatars in real-time, but the incomplete GUI may make integration with streaming software like OBS more manual. You'll likely need to use window capture and configure tracking sources separately.

Vpuppr or VTube Studio: which is better for beginners?

VTube Studio is better for beginners due to its polished GUI and ease of use, while Vpuppr is ideal for developers who need open-source customization and support for multiple tracking inputs but are okay with a steeper setup.

How to contribute to the Vpuppr project?

Check the CONTRIBUTING.md file and docs directory for guidelines. Contributions are welcome, especially for completing the GUI, adding missing tracking features, or improving documentation.

Does Vpuppr have real-time lip sync for audio?

No, lip sync is listed as a planned feature under development and not yet implemented, so you cannot currently sync avatar lip movements directly to audio input in real-time.

Open-Awesome

vpuppr

MPL-2.0GDScript0.9.0

An open-source VTuber application built with Godot 4 for real-time facial motion capture and avatar animation.

GitHub

812 stars73 forks0 contributors

What is vpuppr?

Vpuppr is an open-source VTuber application built with Godot 4 that allows users to animate 3D VRM avatars using real-time facial tracking data from various sources like MediaPipe and iFacialMocap. It solves the problem of needing proprietary, closed-source software for VTuber avatar animation by providing a customizable, self-hosted alternative.

Target Audience

VTubers, streamers, and digital content creators who want to animate 3D avatars with open-source tools, as well as developers interested in motion capture and real-time graphics using Godot.

Value Proposition

Developers choose Vpuppr for its open-source nature, support for multiple tracking inputs, and the flexibility of being built on Godot, which allows for extensive customization and integration compared to commercial VTuber software.

Overview

VTuber application made with Godot 4

Use Cases

Best For

Animating VRM avatars for live streaming or recording
Integrating custom facial tracking solutions into VTuber setups
Developing open-source alternatives to commercial VTuber tools
Experimenting with real-time motion capture in Godot projects
Creating customizable VTuber software with modular tracking support
Building self-hosted VTuber applications without proprietary dependencies

Not Ideal For

Users needing a polished, out-of-the-box VTuber software with a complete GUI for live streaming
Non-technical creators who want simple installation without compiling from source or coding
Projects requiring all promised features like OpenSeeFace tracking and lip sync to be fully implemented and stable

Pros & Cons

Pros

Multi-Source Tracking

Supports facial tracking from MediaPipe, iFacialMocap, MeowFace, and VTube Studio, providing flexibility for different hardware and software setups.

Open-Source Foundation

Fully open-source, allowing customization and modification, which is ideal for developers building tailored VTuber tools without proprietary lock-in.

Godot Engine Integration

Built on Godot 4, leveraging its real-time 3D rendering and extensibility, making it suitable for graphics-heavy applications and further development.

VRM Model Support

Reliably loads and animates 3D VRM avatars, a standard format for VTubers, enabling use with models from tools like VRoid Studio.

Cons

Incomplete User Interface

The README states the GUI is only half-implemented, making it less user-friendly and requiring technical workarounds for practical use.

Complex Setup Process

Building from source requires Godot 4.1.x, Rust, Python, and running setup scripts, which can be daunting for those without development experience.

Missing Core Features

Save data is not implemented, and key tracking inputs like OpenSeeFace and lip sync are only planned, limiting functionality for production use.

Open Source Alternative To

vpuppr is an open-source alternative to the following products:

VTube Studio

VTube Studio is a desktop application that allows VTubers (virtual YouTubers) to use Live2D or 3D models for live streaming and content creation with facial tracking and animation controls.

Frequently Asked Questions

Related Projects

SimulaVR

Linux VR Desktop

Stars3,209

Forks112

Last commit12 days ago

godot-python

Python support for Godot 🐍🐍🐍

Stars2,094

Forks154

Last commit6 months ago

Waterways

A tool to generate river meshes with flow and foam maps based on bezier curves.

Stars1,333

Forks92

Last commit9 months ago

Open Source A-RPG Demo

A-RPG demo made with Godot, MIT-licensed, from our Godot course

Stars1,274

Forks128

Last commit5 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub