Web Items

⚠️ This is currently an unreleased/unannounced feature. ⚠️

Web Items are a new item type available in VTube Studio.

A Web Item is essentially a full web browser, available as an item in VTube Studio. They can be moved, rotated and pinned like normal items but display a website that you can interact with. Under the hood, Web Items use the Chromium Embedded Framework (CEF), so they have most of the functionality that Google Chrome has.

Web Items are basically like "OBS Browser Sources" (which also uses CEF), just directly in VTube Studio.

Some basic info:

• Any website that works in Google Chrome will also work in VTube Studio Web Items.
• Like OBS Browser Sources, Web Items also support transparent page backgrounds. That way, you can use chat widgets, sponsor widgets, etc. directly in VTS easily.
• Like with a regular browser, you can log into websites, store data using cookies, etc. Logins/Cookies and other data can be remembered or cleared every time you restart VTS, depending on your Web Item settings.
• Sound is also supported (can be muted), so you could load Twitch/YouTube videos directly as pinnable items in VTS.
• Web Items also works with Item Scenes, so you can use hotkeys to load Web Items with certain presets/URLs.
• Web Items are NOT synced via VNet Multiplayer. They are only displayed on your side when you are in a collab.
• You can also use hotkeys to do stuff like spawn new Web Items, delete them or mute/unmute them.

Quick access buttons

When you hover over the top right of the Web Item (see image above), a few buttons will be shown. Most should be self-explanatory. Some special buttons:

• Settings button: Opens the full settings page. This gives you access to all Web Item settings, such as item cropping, scroll sensitivity and more.
• Lock button: Lets you lock/unlock this Web Item. You should lock Web Items when interacting with their loaded web page, otherwise you'll also scroll/drag the item around.
• Interaction button: Turns web page interaction on/off for this Web Item. When you want to drag/move/scale a Web Item, you should turn interaction off because otherwise you'll also be interacting with the website at the same time.

Hotkeys & Item Scenes

You can use hotkeys of the type Trigger Web Item Action to do various things with Web Items, such as:

• Spawn a new Web Item.
• Delete all Web Items.
• Mute/Unmute all Web Items.
• ...and more!

Also, Web Items also work with "Item Scenes". That means you can set up Web Items and them save them into an Item Scene and then use hotkeys to load/unload these Web Items.

Web Items will be saved in Item Scenes including their URL, resolution, position, mute/unmute state, etc.

Background transparency

Like OBS browser sources, VTube Studio Web Items support pages with transparent backgrounds. You can use this to put widgets like chat boxes or donation widgets and more directly into VTube Studio. The setting to enable/disable transparent backgrounds for a certain Web Item can be found in the full web item config.

Loading local files

Like Google Chrome, you can use Web Items to load local files (text, images, HTML pages, ...) or even browse local folders.

By default, this is turned off, so you have to manually allow your loaded Web Item to be able to load local files. Once you have done that, you can just use a local file path as URL for the Web Item and it will load.

Examples formats:

• C:\Downloads\my_video.mp4 Will load the local video on the Web Item and play it.
• C:\ Will show the contents of that folder. Be VERY careful with opening local folders. There could be personal information in there.
• file://C: Same as above, just using the file:// prefix to open local files explicitly instead of implicitly.

Defaults

You can set defaults for some options like whether or not newly spawned Web Items should be muted or unmuted or whether or not new Web Items should be able to load local files.

These defaults can be set in the Web Item settings (scroll down a bit in the settings list).

Limitations

Web Items have various limitations:

• They are not synced via VNet Multiplayer. Syncing browser contexts would be extremely unsafe.
• Performance isn't optimal when playing high-resolution video in Web Items. It's recommended to keep the resolution of the Web Items at or below 1024 pixels if you experience performance issues or when playing multiple YouTube videos at the same time.
• Due to limitations imposed by CEF, zoom levels are shared per domain. That means that all Web Items that are on the same domain will have the same zoom level.

Security

Web Items use the Chromium Embedded Framework (CEF). That means they are essentially as safe as Google Chrome.

That means it's relatively safe, but you should never visit any suspicious sites or open random links sent by your chat.

VTube Studio plugins cannot spawn Web Items via the API. Any website shown by Web Items has to be manually opened by the user (or opened via a previously saved Item Scene).

If plugins ever get access to Web Item functionality, it will be hidden behind an additional permissions.

API access

One interesting aspect of Web Items is that they themselves could be VTube Studio plugins:

1. Load Web Item into the scene with URL https://website.com/my_vts_plugin_url.html
2. That website uses JavaScript to connect to the VTube Studio API.
3. The website is now an item in VTube Studio and connected to VTube Studio through the API at the same time.
4. The website can use the VTube Studio API to move, pin, unpin, delete, etc. its own item.
5. When the item is deleted, the browser process quits and the API connection is automatically disconnected.

Note: If the plugin wants to move, pin, etc. its own items, it needs to know the item instance UUID. Websites loaded in VTube Studio Web Items can receive that ID using JavaScript on page load like this: "Item UUID Listener".

In general, API access related to Web Items is very limited:

• VTS plugins cannot spawn Web Items.
• You can use the API to move, pin and delete Web Items like normal items.
• In the future, there may be more advanced functionality, such as letting plugins load URLs. If this is ever added, it will require an additional permission that has to be manually requested by the plugin and granted by the user.