Skip to content

VTS-API

vts-api - строго-типизированный асинхронный фреймворк для работы с VTubeStudio API.

Подготовка

Для начала работы установите фреймворк следующей командой:

shell
pip install vts-api

Последняя версия с GitHub

shell
pip install -U https://github.com/Timtaran/vts-api/archive/refs/heads/master.zip

Разрабатывающаяся версия с GitHub

shell
pip install -U https://github.com/Timtaran/vts-api/archive/refs/heads/dev.zip

Пример использования

В этом примере мы обрабатываем каждый новое событие о том, что сервер отправил нам токен авторизации.

python
from vts_api import Connector, EventTypes 
from vts_api.types import AuthenticationTokenResponse

from loguru import logger

vts = Connector(
    websocket_ip="ws://127.0.0.1:8001",  # Все параметры необязательны
    plugin_name="Test Integration", 
    plugin_developer="Timtaran"
)


@vts.listener.on_event(EventTypes.AuthenticationTokenResponse)  # Регистрация хэндлера 
async def on_token_response(response: AuthenticationTokenResponse) -> None:
	logger.info(f'Server send authentication_token: {response.data.authentication_token}')

vts.run_polling()

Опубликовано под лицензией MIT.