Scripting Assistant – For vMix

A strongly-typed development environment for writing VB.NET scripts compatible with vMix, built as a Visual Studio Code extension.

Disclaimer: This is an unofficial community extension. It is not affiliated with, endorsed by, or supported by StudioCoast Pty Ltd. "vMix" is a registered trademark of StudioCoast Pty Ltd.

⚠️ Beta

This extension is currently in beta. If you encounter any issues — whether it's a bug, an incorrect function signature, missing parameters, or unexpected behavior — please open an issue on this repository. Reports about specific vMix API functions (wrong parameter types, missing overloads, incorrect ranges) are especially valuable.

We are actively working on a community editing tool that will allow contributors to review and correct the function database directly.

Supported vMix version: 29

Features

Contextual IntelliSense

Full autocompletion for all functions in the vMix API, organized by category. The extension suggests parameters based on type, filters Inputs by compatibility, and shows valid value ranges inline.

SetText with two overloads (required-only vs all params)

Smart Object Filtering

When a project is linked, the extension reads .gtzip title files and populates ObjectsList with TextBlock and Image elements. Objects are filtered by parent input and by kind — SetText only shows text objects, SetImage only shows image objects.

Real-Time Diagnostics

Catches errors as you type: invalid parameter types, out-of-range values, missing required arguments, and structural issues like Sub/Function declarations (which vMix does not allow).

Signature Help

Displays the full function signature with parameter names, types, and valid ranges while typing inside parentheses.

Bidirectional Transpiler

Write in the typed syntax and export to native VB.NET that vMix understands. Import existing scripts from a linked project and they are automatically converted to the typed format.

Typed syntax (what you write):

'My Score Script
Dim score As String = "3"
API.Title.SetText(InputsList.Score_vMix, ObjectsList.txtHome, score)
API.Title.SetText(InputsList.Score_vMix, ObjectsList.txtAway, "1")

Native VB.NET (what vMix receives after export):

'My Score Script
Dim score As String = "3"
API.Function("SetText", Input:="Score vMix", SelectedName:="txtHome.Text", Value:=score)
API.Function("SetText", Input:="Score vMix", SelectedName:="txtAway.Text", Value:="1")

Project Integration

Link a .vmix project file and the extension automatically reads all Inputs and GT Title objects. Changes to the project are detected and reloaded.

Import & Export

Export: Converts the current .vmixscript file to native VB.NET and opens it in a new tab, ready to paste into vMix. Optionally updates the script directly in the linked project (with automatic backup).

Import: Lists all scripts in the linked project. Select one and the transpiler converts native API.Function() calls back to the typed format with InputsList and ObjectsList references.

Additional Features

• Auto-closing blocks: Press Enter after If, For, While, Do, or Select Case and the extension generates the closing block with cursor positioned inside.
• Automatic casing correction: Keywords, API functions, and variables are corrected to proper casing in real time.
• DataSource support: First-class autocompletion for DataSource types (GoogleSheets, Excel/CSV, RSS, XML, JSON, etc.) in data-related functions.
• Internationalization: Full UI in English and Spanish, detected automatically from VS Code language settings.

Getting Started

1. Install the Extension

Clone this repository and open it in VS Code:

git clone https://github.com/sysprofile/scripting-assistant-for-vmix.git
cd scripting-assistant-for-vmix
npm install
npm run compile

Then press F5 to launch the Extension Development Host.

2. Link a Project

Open the Command Palette (Ctrl+Shift+P) and run:

Scripting Assistant: Open project...

Select your .vmix project file. The extension reads all Inputs and extracts objects from GT Title (.gtzip) files.

3. Create a Script

Create a new file with the .vmixscript extension. The first line must be a comment with the script name:

'My Script Name

Start typing API. to see categories, then continue with the function name and parameters.

4. Export

When ready, open the Command Palette and run:

Scripting Assistant: Export Script (VB.NET)

The transpiled code opens in a new tab. Copy and paste it into vMix, or let the extension update the project file directly.

Typed Syntax Reference

Requirements

• Visual Studio Code 1.80+
• A vMix installation with .vmix project files (for project integration features)

API Sources

The function database was built from the following references:

License

MIT

Acknowledgments

Built for the vMix community. vMix is a registered trademark of StudioCoast Pty Ltd.