Skip to content

aerctic/pyvts

 
 

Repository files navigation

pyvts

License: MIT issue build codecov PyPI docs

A python library for interacting with the VTube Studio API.

Overview

pyvts is a python library for interacting with the VTube Studio API.

You can easily use the library to develop VTubeStudio Plugin to achieve your goals. For example, adding new tracking parameters to enable more actions on live2d avatars.

Quick Start

Installation

pip3 install pyvts 

Get Started

First import library you need,

import pyvts
import asyncio

Create an instance with default values, and do whateveer you want!

async def main():
    vts = pyvts.vts()
    await vts.connect()
    # Implement what you want to do
    await vts.close()

if __name__ == "__main__":
    asyncio.run(main())

Demo

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

Before you get started, make sure you've clone the library and 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.

About

A python library for interacting with the VTubeStudio API

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Python 100.0%