README.md

Vpuppr

VTuber software made with Godot.

Godot 4 rewrite in progress.

The Godot 3 version is currently located on the godot-3 branch.

Status

General:

• VRM model loading
• Receive tracking data
• Map tracking data onto a VRM model
• GUI (half-implemented)
• Save data

Tracking

• MediaPipe
• iFacialMocap
• MeowFace
• VTube Studio
• OpenSeeFace
• Mouse tracking
• Lip sync

Building From Source

Prerequisites:

• Godot 4.1.x
• Rust 1.70+
• Python 3.8+ (any 3.x version is probably fine)

Run setup.sh to:

• refresh gitsubmodules
• build libvpuppr
• copy libvpuppr's .gdextension file into the main project

In order to build GDMP, follow the instructions in that repo.

Contributing

Please see the document about contributing.

Various technical documents are stored under the docs directory.