CooVTS

✨ Another library for making VTube Studio plugins with Python ✨

English | 简体中文

✨ Features

• ✨ Full type hints support with static type checking
• 🎯 Data validation and serialization using Pydantic
• 🔄 Async-first design with WebSocket communication
• 🎨 Easy-to-use event system for plugin development
• 🛡️ Built-in error handling and reconnection mechanisms

📖 Introduction

Style at a glance

import asyncio

from coovts.plugin import Plugin
from coovts.types import api, event

# no token yet: VTS asks the user once
plugin = Plugin("A Creative Plugin Name", "LgCuwukii☆")


@plugin.subscribe_event(event.ModelMovedEventData)
async def _(data: event.ModelMovedEventData):
    print(data.model_position)


# Requests need a session, so they belong in `on_authenticated`, which fires again after every reconnect;
# `call_api` is typed per request and returns that request's response model.
@plugin.on_authenticated
async def _():
    model = await plugin.call_api(api.CurrentModelRequest())
    print("current model:", model.model_name, model.model_id)


async def main() -> None:
    await plugin.run()


asyncio.run(main())

plugin.run() hands back the supervisor task; it must be awaited inside a running event loop, because asyncio.run() builds its argument before the loop starts.

Next

• Read the guide in detail
• Read examples/basic.py — the same plugin, with every logging hook filled in

Thanks for using it, and contributions are welcome 😊

💿 Install

You should use at least Python 3.12 to use this library.

pip install coovts

or

uv add coovts

📞 Contacts

• Telegram: @lgc2333
• QQ: 3076823485 / Group: 168603371
• Email: lgc2333@126.com
• Discord: lgc2333 (Not active)

📝 Changelog

CHANGELOG.md