VTube Studio sub-actions¶
Color tint¶
Tints your model with a color, for example red when someone is angry. Can tint all of it or only some parts.
| Setting | What to put in |
|---|---|
| Color | The color as a hex code like #FF8080, or as numbers like "255,128,128" (red, green, blue, and optional see-through). Starts as: #FF8080. |
| Art mesh names containing | Only tint parts whose names contain these words. Separate several with commas. Leave both boxes empty to tint everything. |
| Art mesh tags containing | Only tint parts whose tags contain these words. Separate several with commas. |
| Mix with scene lighting (0-1) | How much the tint mixes with the scene lighting, from 0 to 1. Starts as: 1. |
Variables it adds
| Variable | What it holds |
|---|---|
%vtsMatchedArtMeshes% |
How many parts of the model were tinted |
Type id: vtubestudio.colorTint
Get available models¶
Reads the list of models you have in VTube Studio and keeps it for later steps.
Variables it adds
| Variable | What it holds |
|---|---|
%vtsModels% |
All model names, separated by commas |
%vtsModelCount% |
How many models there are |
%vtsModelsJson% |
The full list as raw text |
Type id: vtubestudio.getModels
Get current model¶
Reads which model is loaded and where it is, and keeps the details for later steps.
Variables it adds
| Variable | What it holds |
|---|---|
%vtsModelLoaded% |
True if a model is loaded |
%vtsModelName% |
The model's name |
%vtsModelId% |
The model's id |
%vtsPositionX% |
Left to right position |
%vtsPositionY% |
Bottom to top position |
%vtsRotation% |
Rotation in degrees |
%vtsSize% |
How big it is |
Type id: vtubestudio.getCurrentModel
Get expressions¶
Reads the expressions of the loaded model and which ones are on, and keeps them for later steps.
Variables it adds
| Variable | What it holds |
|---|---|
%vtsExpressions% |
All expression names, separated by commas |
%vtsActiveExpressions% |
The names of the expressions that are on now |
%vtsExpressionCount% |
How many expressions there are |
%vtsExpressionsJson% |
The full list as raw text |
Type id: vtubestudio.getExpressions
Get hotkeys¶
Reads the hotkeys of the loaded model and keeps them for later steps.
Variables it adds
| Variable | What it holds |
|---|---|
%vtsHotkeys% |
All hotkey names, separated by commas |
%vtsHotkeyCount% |
How many hotkeys there are |
%vtsHotkeysJson% |
The full list as raw text |
Type id: vtubestudio.getHotkeys
Load item¶
Puts an item (a prop or picture) into your VTube Studio scene.
| Setting | What to put in |
|---|---|
| Item file | The item's file name as VTube Studio shows it, like "star.png". |
| Position X | Left to right position (-1 is the left edge, 1 is the right edge). Starts as: 0. |
| Position Y | Bottom to top position (-1 is the bottom, 1 is the top). Starts as: 0. |
| Size (0-1) | How big it is, from 0 to 1. Starts as: 0.32. |
| Rotation (degrees) | How far to turn it, in degrees. Starts as: 0. |
| Fade time (seconds) | How long it takes to fade in, in seconds. Starts as: 0.5. |
| Order | Which layer it sits on, from -30 to 30. Leave empty to let VTube Studio pick a free one. |
| Unload when Cuebot disconnects | Tick to remove the item automatically if Cuebot disconnects from VTube Studio. Starts as: false. |
| Save the answer in variable | The name of the variable that will hold the item's id, so you can move or remove it later. The default is vtsItemInstanceId. Starts as: vtsItemInstanceId. |
Variables it adds
| Variable | What it holds |
|---|---|
%vtsItemInstanceId% |
The id of the new item (or the name you chose above) |
Type id: vtubestudio.loadItem
Load model¶
Switches VTube Studio to another model (avatar).
| Setting | What to put in |
|---|---|
| Model (name or id) | The model name (or id) as VTube Studio shows it. |
Variables it adds
| Variable | What it holds |
|---|---|
%vtsModelId% |
The id of the model that was loaded |
Type id: vtubestudio.loadModel
Move item¶
Moves, turns or resizes an item in your scene, smoothly.
| Setting | What to put in |
|---|---|
| Item (instance id or file name) | The item to move: its id (from Load item) or its file name. |
| Time (seconds) | How long the move takes, in seconds. Starts as: 1. |
| Motion | How the motion feels: linear is steady, easeIn starts slow, easeOut ends slow, easeBoth does both, overshoot goes past and bounces back, zip is a quick snap. Options: linear, easeIn, easeOut, easeBoth, overshoot, zip. Starts as: easeBoth. |
| Position X | Left to right position (-1 is the left edge, 1 is the right edge). Leave empty to keep it. |
| Position Y | Bottom to top position (-1 is the bottom, 1 is the top). Leave empty to keep it. |
| Size | How big it is, from 0 to 1. Leave empty to keep it. |
| Rotation | How far to turn it, in degrees. Leave empty to keep it. |
Type id: vtubestudio.moveItem
Move model¶
Moves, turns or resizes your model on screen, smoothly.
| Setting | What to put in |
|---|---|
| Time (seconds, 0-2) | How long the move takes, in seconds (0 to 2). Starts as: 0.5. |
| Relative to the current position | Tick to move from where the model is now. Untick to put it at exactly the numbers below. Starts as: false. |
| Position X | Left to right: -1 is the left edge, 1 is the right edge. Leave empty to keep it. |
| Position Y | Bottom to top: -1 is the bottom, 1 is the top. Leave empty to keep it. |
| Rotation (degrees) | How far to turn it, in degrees (-360 to 360). Leave empty to keep it. |
| Size | How big it is (-100 to 100). Leave empty to keep it. |
Type id: vtubestudio.moveModel
Move model parts (advanced)¶
Moves parts of your model yourself, like head angle or mouth opening, as if your face did it. Handy for scripted reactions.
| Setting | What to put in |
|---|---|
| Parameters | What to move, as name=value, separated by commas or new lines, like "FaceAngleX=20, MouthOpen=1". Add @ and a number for how strongly, like "MouthOpen=1@0.5". |
| Mode | set replaces the value, add adds to what your face tracking is doing. Options: set, add. Starts as: set. |
| Hold for (seconds) | How long to keep the values applied, in seconds. Cuebot keeps re-sending them until the time is over. Starts as: 1. |
| Report the face as found | Tick to tell VTube Studio a face was found, so it does not show "tracking lost" while Cuebot controls the model. Starts as: false. |
Type id: vtubestudio.injectParameters
Remove all expressions¶
Turns off every expression that is currently on.
| Setting | What to put in |
|---|---|
| Fade time (seconds) | How long the change takes, in seconds. Starts as: 0.25. |
Type id: vtubestudio.removeAllExpressions
Reset all color tints¶
Removes all color tints from your model.
Type id: vtubestudio.resetColorTint
Send VTube Studio request (advanced)¶
Sends VTube Studio one request of your own and keeps the answer. For advanced users who know the VTube Studio plugin commands.
| Setting | What to put in |
|---|---|
| Message type | The VTube Studio request name, like "SceneColorOverlayInfoRequest". |
| Data (JSON) | Extra details for the request, written as a JSON object. Leave empty if it needs none. |
| Save the reply in variable | The name of the variable that will hold the answer as text. The default is vtsResult. Starts as: vtsResult. |
| Variable prefix | Also keeps each part of the answer as its own variable starting with this word, like %vtsRaw.data.modelName%. Leave empty to skip. Starts as: vtsRaw. |
Variables it adds
| Variable | What it holds |
|---|---|
%vtsResult% |
The whole answer as raw text (or the name you chose above) |
Type id: vtubestudio.rawRequest
Set expression state¶
Turns an expression (a face or pose preset) on or off.
| Setting | What to put in |
|---|---|
| Expression (name or file) | The expression name or file as VTube Studio shows it. |
| State | On turns it on, Off turns it off, Toggle flips it. Options: Switch (on if off, off if on), Turn on, Turn off. Starts as: Turn on. |
| Fade time (seconds) | How long the change takes, in seconds. Starts as: 0.25. |
Variables it adds
| Variable | What it holds |
|---|---|
%vtsExpressionActive% |
True if the expression is on afterwards |
Type id: vtubestudio.setExpression
Trigger hotkey¶
Presses a VTube Studio hotkey for you, for example to play an animation or change an expression.
| Setting | What to put in |
|---|---|
| Hotkey (name or id) | The hotkey name (or id) as VTube Studio shows it. |
| Live2D item instance id | Only for hotkeys that belong to a Live2D item you loaded: the id of that item. Most people can leave this empty. |
Variables it adds
| Variable | What it holds |
|---|---|
%vtsHotkeyId% |
The id of the hotkey that was triggered |
Type id: vtubestudio.triggerHotkey
Unload item¶
Removes items (props or pictures) from your VTube Studio scene.
| Setting | What to put in |
|---|---|
| Item (instance id or file name) | The items to remove, by id or file name. Separate several with commas. |
| Unload every item in the scene | Tick to remove every item in the scene. Starts as: false. |
Variables it adds
| Variable | What it holds |
|---|---|
%vtsUnloadedItems% |
How many items were removed |
Type id: vtubestudio.unloadItem