download the apps! the docs

introduction installation usage

using veadotube mini using veadotube with OBS with Stream Deck with user add-ons

troubleshooting technical stuff

the data folder the add-ons the API

instance channel nodes channel

the file formats

metadata images properties nodes scenes mini avatars dynamic avatars

community branding terms of use privacy policy

integrating with OBS

this guide walks you through using veadotube with OBS (Open Broadcast Software), in order to stream it, record it, or use it as a virtual webcam.

this guide might also apply to other streaming programs, such as Streamlabs, as the process is similar.

there are lots of ways to capture veadotube with OBS:

Windows: use Spout2 Capture for transparency, and if you don’t feel like installing plugins, then Game Capture second and Window Capture if that doesn’t work.
Linux: use the Game Capture plugin for transparency, and Window Capture if that doesn’t work.
macOS: use a Syphon Client for transparency, and if that doesn’t work then either macOS Screen Capture or Window Capture.

capture methods

Spout2 on Windows

if you’re on Windows, you can use Spout, which completely hides the UI at all times and it’s perfectly transparent without any weird borders.

for OBS you gotta download and install the Spout2 plugin – make sure OBS is closed during all that.

then reopen OBS and in the Sources panel, press + and select Spout2 Capture:

change SpoutSenders to be the veadotube instance you want.
Composite Mode works best with Default.

additional notes for veadotube:

you must enable Spout server in the scene panel – ensure it’s active through .

additional notes for veadotube mini:

you must enable spout stream in .
if the image resolution seems too low, resize the window to a larger size!

Game Capture on Windows

in the Sources panel, press + and select Game Capture:

Mode has to be set to Capture specific window, which will prompt you to select which window – select your veadotube window.
some laptops or newer versions of OBS require you to check SLI/Crossfire Capture Mode (Slow) for the capture to work!

additional notes for veadotube:

to make the scene fullscreen, press in the scene panel or press F11 in your keyboard.
if you have your scene background set to a transparent color, you can check Allow Transparency in the OBS source and it should make the capture transparent! don’t worry if transparency looks weird in the app – it’ll look good in OBS.

additional notes for veadotube mini:

if you don’t wanna accidentally show the veadotube UI, select hide UI… in .
if you have your background on mini set to transparent in , you can check Allow Transparency in the OBS source and it should make the capture transparent! don’t worry if transparency looks weird in the app – it’ll look good in OBS.
if the image resolution seems too low, resize the window to a larger size!

Window Capture on Windows

in the Sources panel, press + and select Window Capture:

Capture Method usually works best with the option Windows 10 (1903 and up), but you can test what works best.
Capture Cursor is better left off!
if you’re using Capture BitBlt (Windows 7 and up), some laptops require you to check Multi-adapter Compatibility for the capture to work!
if you’re using Windows 10 (1903 and up), Client Area should be checked!
no transparency support here, meaning you’ll have to do chroma keying to remove the background.

additional notes for veadotube:

to make the scene fullscreen, press in the scene panel or press F11 in your keyboard.

additional notes for veadotube mini:

if you don’t wanna accidentally show the veadotube UI, select hide UI… in .
if the image resolution seems too low, resize the window to a larger size!

Syphon Capture on macOS

Syphon is probably the only way to capture veadotube on macOS with transparency and good performance, and support for it is built-in on OBS.

in the Sources panel, press + and select Syphon Client:

make sure Allow Transparency is checked.

additional notes for veadotube:

you must enable Syphon server in the scene panel – ensure it’s active through .

additional notes for veadotube mini:

you must enable syphon stream in .
if the image resolution seems too low, resize the window to a larger size!

macOS Screen Capture

in the Sources panel, press + and select macOS Screen Capture:

Method has to be set to Window Capture, which will prompt you to select which window – select your veadotube window.
no transparency support here, meaning you’ll have to do chroma keying to remove the background.

additional notes for veadotube:

to make the scene fullscreen, press in the scene panel or press F11 in your keyboard.

additional notes for veadotube mini:

if you don’t wanna accidentally show the veadotube UI, select hide UI… in .
if the image resolution seems too low, resize the window to a larger size!

Deprecated Window Capture on macOS

if you’re using an older version of either macOS or OBS, you might have to use the old Window Capture option.

in the Sources panel, press +, select Deprecated and then Window Capture:

you might want Show window shadow turned off!
no transparency support here, meaning you’ll have to do chroma keying to remove the background.

additional notes for veadotube:

to make the scene fullscreen, press in the scene panel or press F11 in your keyboard.

additional notes for veadotube mini:

if you don’t wanna accidentally show the veadotube UI, select hide UI… in .
if the image resolution seems too low, resize the window to a larger size!

Game Capture on Linux

OBS on Linux doesn’t support Game Capture built-in, but you can install a plugin that does just that!

to install the plugin, refer to its repository! in order to get veadotube to work with it, you have to run it with the obs-gamecapture prefix in Terminal, for example: obs-gamecapture ./veadotube-mini for veadotube mini.

back in OBS, in the Sources panel, press + and select Game Capture:

additional notes for veadotube:

to make the scene fullscreen, press in the scene panel or press F11 in your keyboard.
if you have your scene background set to a transparent color, you can check Allow Transparency in the OBS source and it should make the capture transparent! don’t worry if transparency looks weird in the app – it’ll look good in OBS.

additional notes for veadotube mini:

if you don’t wanna accidentally show the veadotube UI, select hide UI… in .
if you have your background on mini set to transparent in , you can check Allow Transparency in the OBS source and it should make the capture transparent!
if the image resolution seems too low, resize the window to a larger size!

Window Capture on Linux

in the Sources panel, press + and select your preferred Window Capture method (depending on whether you’re on X11 or Wayland):

no transparency support here, meaning you’ll have to do chroma keying to remove the background.

additional notes for veadotube:

to make the scene fullscreen, press in the scene panel or press F11 in your keyboard.

additional notes for veadotube mini:

if you don’t wanna accidentally show the veadotube UI, select hide UI… in .
if the image resolution seems too low, resize the window to a larger size!

miscellaneous

getting rid of the window border

using Window Capture in some platforms sometimes leaves the window border in the capture alongside with the content. you might wanna crop that out! to do that, right-click the capture on OBS and select Filters. in the Effect Filters panel, press + and select Crop/Pad.

mess with the values a bit until things look right!

making it transparent

if your capture isn’t transparent by default, you might wanna remove the background color by using filters! to do so, right-click the capture on OBS and select Filters. in the Effect Filters panel, press + and select Colour Key.

select the background color you’re using in mini, and mess with the values a bit until things look right!

if you can’t seem to get a good result because the background color is too similar to the colors of your avatar, try changing the background color in mini through the display settings button.

getting rid of image borders in transparency capture

you might see a weird border around your transparent avatar! in order to get rid of it, you might wanna configure the capture by right-clicking on it and selecting the Scale Filtering to be Bilinear.

if you have a pixel avatar, Point might also be a good scale filter!

using your avatar as a webcam

you can make OBS output to a virtual webcam! which means that after you’ve added veadotube to OBS, you can use your mini avatar as your camera on Discord, Google Meet, whatnot.

to do that, in the Controls panel in OBS, select Start Virtual Camera; this should let you select the OBS-Camera webcam during video calls :]

streaming two or more veadotube mini windows

you can stream multiple avatars in one scene in veadotube! we only recommend this approach if you’re limited to using veadotube mini.

you can open veadotube mini twice (or thrice and so on), and they’ll run independently. this might however mess with the app’s settings a bit, since one instance can try and overwrite the other one.

so to do this, make sure you’re manually saving your avatars, or try using portable save files instead.

each window can have a different title – you can edit that in the program settings menu ! this way it’s easier to select which window to capture.