-
Notifications
You must be signed in to change notification settings - Fork 80
Plugins
Note: Plugins are not supported on smartphones. See Discord for more info.
VTube Studio supports third-party plugins using the VTube Studio API. Some stuff plugins can do:
- Activate hotkeys (for example via Twitch donations, YouTube superchats, ...)
- Control face tracking parameters and control the model.
- Add entirely new tracking parameters and inject data for them, allowing for literally anything to control your model (software, game controllers, ...)
- Move the model, scale and rotate it.
- ...and more!!
A plugin could be an app running on your PC/Mac or even just a website that takes control of VTS running on your PC!!
Plugins cannot access your webcam or read any personal data through VTS.
Please reach out on Discord if you want your plugin added to this list.
For info on how to use those plugins, please check out the linked plugin websites. Important: These plugins are UNOFFICIAL and are not developed by DenchiSoft. Please only use plugins you trust!!
-
Cheers Bot
- By HawkBar
- Trigger hotkeys, model changes and more based on Twitch stream events (donations, etc.)
-
VTS P.O.G
- By Eruben
- Easily add chat/bit/sub triggered TTS messages to your Twitch-streams and have your models (for example a mascot model) read them. Image
-
Audiomimi
- By Artemiz and Mokunine
- Audiomimi is a VTube Studio plugin that allows you to use sound effects based on VTS parameter movement.
-
ViewLink
- By Kawa Entertainment
- Are you a VTuber that wants to stream VR games, but only have a Live2D model? With ViewLink, you can have your Live2D avatar react to VR gameplay without any fancy setup or additional hardware!
-
VTS React
- By Fugi and Iron Vertex
- Easy to use web-based Twitch/YouTube integration for VTube Studio.
-
VTS Desktop Audio
- By Lua Lucky
- A plugin for using desktop audio as input parameters in VTS.
-
VBridger
- By PiPuProductions and Serp
- VBridger is a face tracking plugin designed for VTube Studio and Live2D, which allows the user to make better use of iPhone ARKit tracking.
-
Mix It Up Streaming Bot
- A versatile streaming bot that also supports VTS integration, including activating hotkeys on stream events such as donations, etc.
-
VTChaos
- By Raelice
- A YouTube/Twitch chat bot that sends commands to VTube Studio when someone uses certain commands in chat.
-
VTube Studio Stream Deck Plugin (download via official Stream Deck app store)
- By Cazzar
- Access all VTube Studio functionality directly using your Stream Deck, including triggering hotkeys and changing models.
-
TP_VTS - Touch Portal Integration for VTube Studio
- By Wiccy
- Plugin that makes it easy to control VTube Studio using the Touch Portal smartphone app. Supports triggering hotkeys, loading and moving models, coloring ArtMeshes and more!
- Links: Download and documentation
-
VtubeStudioSimpleSETool
- By 物部モノ子
- A VTube Studio plugin that can automatically play custom sound effects when tracking parameters reach certain values you can configure.
-
Twitch Integrated Throwing System
- By Remasuri32
- A VTube Studio plugin that lets your viewers throw stuff at your model using Twitch redeems, etc. and have your model react accordingly like it's getting hit.
-
VTS-Puppet
- By Eruben (@eruben_thillior)
- This VTube Studio plugin lets you control your model using a gamepad, for example using an Xbox controller or Switch Pro Controller. You can move your model trigger hotkeys and more directly using your controller.
-
VTSLivePlugins
- By 最速のゆっくり (@fastest_yukkuri)
- This plugin lets you control your model using the current time of the day (seconds, minutes, hours, ...), movement of sun and moon and weather information from any place on earth. You could for example automatically change Live2D parameters based on the current time or weather.
-
VTS Heartrate
- By Tom "Skeletom" Farro (@FomTarro)
- Are you looking to do workout streams in the new year? Why not connect your heartbeat to VTube Studio?
-
Karasubonk
- By typeou (@typeou)
- Karasubonk (KBonk) is a lightweight Twitch and VTube Studio plugin that gives viewers the ability to interact with the streamer by throwing things at them!
-
VTS Chameleon
- By Shotaro Akiyama (@satetsu888)
- VTS-Chameleon is a colorizer plugin for VTube Studio. Change colors and expressions at will!
-
Nyarupad VTS
- By Maruseu (@nyaruseu)
- Simple and lightweight gamepad plugin for VTube Studio! Adds custom input parameters so its possible to rig game controllers directly to your Live2D model.
For info on how to use a specific plugin, please refer to the manual/website of that plugin or ask the plugin authors.
If you want to use plugins, first make sure the API (interface for the plugins) is turned on. It starts a local (websocket) server that plugins can then connect to. The server is started on port 8001 per default. If that port is taken (for example by another instance of VTube Studio), the server will be started on port 8002 and so on. You can also change the port manually. The number in parenthesis is the actual port the API was started on.
Now plugins (websites or apps running on your PC) can connect. Once connected, they will have to request your permission first. A popup will appear on screen once a plugin does that. If you deny it, the plugin can try requesting permission again at any time.
You can view the list of all allowed plugins and confirm the plugin is on there now. Connected plugins will also be marked as "Active" on that list. The plugin now has full control over VTube Studio, so please only allow this for plugins from sources you trust.
A given plugin has to only request permission once for a PC/Mac, so the permission-popup will not be shown the next time the plugin connects to VTube Studio, unless you have revoked the permission in the meantime. All plugin-related information is saved in the "Plugins" folder, which can be found in the "Config" folder next to the "Live2DModels" folder. Deleting the "Plugins" folder will also remove all permissions from all plugins.
Plugins can create "Custom Parameters". Once created, the custom parameters will show up in VTube Studio exactly like normal face tracking parameters like FaceAngleY
or MouthX
, so you can use them to control Live2D parameters in your model. Plugins can freely create those parameters and inject data for them, so using any kind of hardware/software/controller/etc. to control parts of your Live2D model is easily possible.
Custom parameters are marked as such (blue color and P symbol) when selecting them as INPUT in the VTube Studio model config.
When a plugin is removed (revoked permissions by user), all custom parameters created by that plugin are also deleted, but they will still be set as INPUT if a model is using them. They will then be marked in red. The plugin can recreate those parameters at any time and the model will be able to use them again.
Anyone can develop plugins!! It's free and there are no restrictions! If you want, you can even sell your plugins. There are no royalties or licensing payments required to VTube Studio/DenchiSoft if you do.
If you're a developer and you're interested in making a plugin, please head over to the VTube Studio API Development Page for all the details. If you have any questions, please ask in the API channel in the VTube Studio Discord.
And most importantly, if you make something cool, please post videos on Twitter and tweet them at @VTubeStudio!! If it's something really cool and user friendly with a good manual I'd also like to feature it on this page.
If you have any questions that this manual doesn't answer, please ask in the VTube Studio Discord !!
- Android vs. iPhone vs. Webcam
- Getting Started
- Introduction & Requirements
- Preparing your model for VTube Studio
- Where to get models?
- Restore old VTS Versions
- Controlling multiple models with one device
- Copy config between models
- Loading your own Backgrounds
- Recoloring Models and Items
- Record Animations
- Recording/Streaming with OBS
- Sending data to VSeeFace
- Starting as Admin
- Starting without Steam
- Streaming to Mac/PC
- VNet Multiplayer Overview
- Steam Workshop
- Taking/Sharing Screenshots
- Live2D Cubism Editor Communication
- Lag Troubleshooting
- Connection Troubleshooting
- Webcam Troubleshooting
- Crash Troubleshooting
- Known Issues
- FAQ
- VTube Studio Settings
- VTS Model Settings
- VTube Studio Model File
- Visual Effects
- Twitch Interaction
- Twitch Hotkey Triggers
- Spout2 Background
- Expressions ("Stickers"/"Emotes")
- Animations
- Interaction between Animations, Tracking, Physics, etc.
- Google Mediapipe Face Tracker
- NVIDIA Broadcast Face Tracker
- Tobii Eye-Tracker
- Hand-Tracking
- Lipsync
- Item System
- Live2D-Items
- Item Scenes & Item Hotkeys
- Add Special ArtMesh Functionality
- Display Light Overlay
- VNet Security
- Plugins (YouTube, Twitch, etc.)
- Web-Items
- Web-Item Plugins