A TypeScript implementation of the VTube Studio WebSocket API.
npm install vtubestudioAn implementation of the WebSocket-based VTube Studio API for Node and browser JavaScript.
See the generated API documentation for type definitions and comments for the various public classes and interfaces, or use an editor with TypeScript support to automatically get types and comments when inspecting objects and fields.
See the official VTube Studio API documentation for more details on the semantic meaning of individual fields and the behaviors of the various API calls.
``bash`NPM
npm i vtubestudioYarn
yarn add vtubestudio
This package has no runtime dependencies. To avoid node_modules bloat, use npm install --only=prod or NODE_ENV=production to skip unnecessary dev dependencies.
This library is platform-agnostic, allowing it to be used for both Node projects and for browsers via tools like webpack. Use it by importing and instantiating an ApiClient:
`javascript
// ES Modules (NodeJS or browser with bundler)
import { ApiClient } from "vtubestudio";
// CommonJS/Require (NodeJS)
const vts = require("vtubestudio");
const ApiClient = vts.ApiClient;
// ES Modules (CDN)
import { ApiClient } from "https://unpkg.com/vtubestudio/lib/esm/vtubestudio.min.js?module";
// Global Variable (CDN)
//