vtube-python Documentation

vtube-python (vtpy) is a Python library for interfacing with VTube Studio’s WebSocket API. VTube Studio is a desktop application that allows users to control Live2D avatars using face tracking.

Features

• 🚀 Async/Await Support: Built with Python’s asyncio for efficient asynchronous operations

• 🔌 WebSocket Communication: Direct WebSocket connection to VTube Studio

• 🎭 Event-Driven: Subscribe to and handle VTube Studio events in real-time

• 📦 Type Hints: Full type hint support for better IDE integration

• 🛡️ Error Handling: Comprehensive error handling with clear, actionable messages

Quick Start

import asyncio
from vtpy import VTS
from vtpy.data.requests import StatisticsRequestData

async def main():
    vts = VTS(plugin_name="MyPlugin", plugin_developer="MyName")
    await vts.start(host="localhost", port=8001)

    stats = await vts.request_statistics(StatisticsRequestData())
    print(f"VTube Studio Version: {stats.data.vTubeStudioVersion}")

    await vts.close()

asyncio.run(main())

Contents:

• Getting Started
  • Installation
  • Prerequisites
  • Basic Connection
  • Authentication
  • Making Requests
  • Handling Events
  • Error Handling
  • Next Steps
• Guides
  • Connection Guide
  • Events Guide
  • Models Guide
  • Hotkeys Guide
  • Parameters Guide
  • Items Guide
• API Reference
  • Main Module
  • Data Models
  • Error Handling
• Examples
  • Basic Examples
  • Basic Usage
  • Events Usage
  • Running Examples
  • Additional Examples

Indices and tables

• Index

• Module Index

• Search Page