Skip to main content

A python library for interacting with the VTube Studio API

Project description

pyvts

License: MIT issue build codecov

A python library for interacting with the VTube Studio API.

Overview

Create a class VTS connecting to the server running on VTubeStudio (default port: ws://localhost:8001).

Implement functions in VTS to send/receive text messages to/from the server, to achieve developers' goals. For example, adding new tracking parameters to enable more actions on live2d avatars.

Installation

pip3 install pyvts

Quick Start

Demo examples/start.py is a good startpoint to make plugin for VTubeStudio.

Before you get started, make sure you've installed all the dependcies

pip3 install -r requirements.txt

Then, launch VTubeStudio, and run

python3 examples/start.py

in command line. You will see a new tracking parameter "start_parameter" added to VTubeStudio and some information about it in command line ouput.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvts-0.1.1.tar.gz (6.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page