Skip to content

Installation

Cazzar edited this page Oct 3, 2021 · 5 revisions

Installing VTubeStudio StreamDeck plugin

Prerequisites

Here I am assuming that we already have the StreamDeck application running and fully installed and running.

I have tested this with the first generation StreamDeck (15 buttons) though it should work on all StreamDeck.

Installation (non-elgato store only)

Here I am going to walk through installing the VTubeStudio StreamDeck plugin.

Firstly, we need to obtain the latest release from the GitHub releases page. There should be an attached file named dev.cazzar.streamdeck.vtubestudio.streamDeckPlugin. This file is what we need.

Once you have downloaded the plugin file, installation and updating should be as simple as running the file, and it will automatically open with the StreamDeck application giving you the following warning:

Stream deck warning on install

To proceed with the installation, click the Install button.

Once you have the StreamDeck plugin installed, you should see a new set of Actions you can use for the Streamdeck labelled "VTubeStudio [Cazzar]".

Stream Deck actions list showing new actions

Configuring VTubeStudio

If you have never used a plugin for VTubeStudio before, you will need to enable the ability for a plugin to connect to VTubeStudio. To do this, we need to open the settings within VTubeStudio.

Once we are inside the settings, we need to scroll down the the "VTubeStudio Plugins" section, by default "Start API" is turned OFF we will need to have this turned, which will look like this:

VTubeStudio settings with plugins enabled

NOTE: Currently, it is required that VTubeStudio and the StreamDeck are running on the same machine, and the port is set to 8001.

Adding actions to your StreamDeck

Currently, the plugin supports 3 basic actions from VTubeStudio, and these should give you a lot of power during your streams and content creation:

  1. Changing Models
  2. Triggering a hotkey
  3. Moving a model

All of the actions require connecting directly to VTubeStudio, so the first time you use it, VTubeStudio will provide a prompt asking if you want to allow the StreamDeck to connect.

You will first see the prompt once you have added the first action in the StreamDeck interface:

VTubeStudio showing the plugin connection request

To allow the StreamDeck to connect, click Allow

Once the button is connected to the StreamDeck, you should see the warning icon on the StreamDeck disappear, showing just the VTubeStudio icon and any title you may have given it.

Once this is done, you can configure the actions as you would like.

More coming later on each action.