Skip to main content

Overview

Video Tutorials​

We have made some video tutorials explaining how to use Puppetstring and make use of Mannequin to create your personalized VTuber model: Free 2D VTuber Livestreaming with Mannequin and Puppetstring!

Opening Your Model​

To open your model file, clik the Open Model File button and choose via the file browser window. You can also open a model file by clicking one of the Recent Files list item. Finally, at the bottom of Overview screen, you can also try one of the provided example models.

Canvas Size​

Before opening any model file, you can adjust how big the Model Viewer window size by setting the width and height in Canvas Size.

On Windows, you can set these numbers to be larger than your current display resolution, which can be useful to capture high resolution full body size of your model. However, by doing this you will risk covering the entire screen with the Model Viewer window, sometimes hiding the controller window (the one where all the buttons are) behind. To fix this, use Windows + Tab key combination and switch back to the controller window.

Closing Model Viewer​

To close Model Viewer window, click the X icon or click the ... icon beside the current model name at the top of controller window, then click Close Model Viewer.

Moving Your Model Around​

You can switch between two method of moving your model on screen:

  • Easy adjustment mode uses mouse to operate. Click and drag your model to move it around. Click, hold and roll the scroll wheel to enlarge/shrink your model.
  • Precise adjustment mode uses exact numbers which can be adjusted in the corresponding input fields. Puppetstring will remember these numbers after closing, so you can use this mode to keep your model in the exact same position each time it's opened.

Capturing Your Model in Open Broadcaster Software (OBS)​

There are two ways to capture your model in OBS:

Game Capture (Easy)​

To use this method, click + at the bottom left of Sources panel in OBS and choose Game Capture. In the configuration window that shows up, select Capture Specific Window mode, then choose Puppetstring Model Viewer window. Make sure Allow Transparency and Premultiplied Alpha is checked.

Please note that while using this method, you must keep Puppetstring Model Viewer window open (your model will freeze in OBS if Model Viewer window is minimized).

Using Spout2 plugin for OBS is less resource intensive. Using this method, Model Viewer window can also be minimized and your model will still show up properly in OBS. Please note that Spout2 plugin is only available on Windows.

To do this, first you have to download and install Spout2 plugin for OBS, which can be obtained here. After you're done with the installation, Spout2 should be available in OBS as source option. Click + at the bottom left of Sources panel in OBS and choose Spout2 Capture. Choose Puppetstring Model Viewer for Spout Sender, and choose Premultiplied Alpha for Composite Mode.