Skip to content

Off-World-Live-Collaborative/VTuberStudio

Repository files navigation

Off World Live VTuber Studio

Scene Preview

Welcome to the OWL VTuber Studio open repository! VTuber Studio features the vast capabilities of the Off World Live Live-Streaming Toolkit for VTubers, game streamers, and content creators.

VTS provides streaming and capture functionalities in-game and in-editor, providing an open-source project template for users to quickly customize and package their own VTuber Studio.

VTuber Studio

Scene Preview

VTS provides useful blueprints and example assets for you to easily package your UE project into a standalone VTuber Streaming Studio.

Using persistent levels, you can seamlessly import your own environments and avatars to recreate and customize your own VTuber application with preconfigured capabilities for streaming.

This project uses Git LFS (Large File Storage), please clone VTuber Studio with 'git lfs pull' to receive all assets.

Features

Scene Preview

  • OWL Capture Systems: Viewport Capture, CineCam Capture, 360 Capture
  • Streaming and Media Output: Virtual Webcam, Spout Output, NDI Output, Streaming to RTMP, Save to File
  • Media Input: Screen Capture, Spout Input, NDI Input
  • LiveLink and VMC support
  • Face tracking and pose tracking via Mediapipe & VMC for sending ARKit data to MetaHumans
  • Twitch Integration for sending and receiving chat messages, as well as event subscription
  • Actor Blueprint to select desired capture systems, their respective render targets, and display materials
  • Example assets such as avatars (VRM & Metahuman), environment meshes, materials, Animation Retargetters, and MoCap blueprints

Dependencies

  • To explore all features in VTS and package your own application, you will need to download:
  1. Unreal Engine 5.2 (https://www.unrealengine.com/en-US/download)
  2. Visual Studio 2022 (https://visualstudio.microsoft.com/vs/)
  3. OBS Studio (https://obsproject.com/download)
  4. Spout Plugin for OBS Studio (https://github.com/Off-World-Live/obs-spout2-plugin/releases)
  5. NDI Tools (https://ndi.video/type/ndi-tools/)
  6. DLSS Unreal Engine Plugin (https://developer.nvidia.com/rtx/dlss/get-started)

How to use the VTuber Studio?

Download from GitHub or Download Center

  • Download project from GitHub Releases or Download Center
  • Unzip the folder
  • Right-click VTuberStudio.uproject and select 'Generate Visual Studio project files'
  • In Visual Studio 2022, open the VTuberStudio.sln file, select Solution 'VTuberStudio' in Solution Explorer, and right-click to Build Solution
  • Double-click VTuberStudio.uproject and open project in UE 5.2

Full-Body Tracking for MetaHumans

Scene Preview

  • Use XR Animator (Mediapipe full-body tracking solution) to stream bone data and blendshape data via VMC
  • Use VMC Receiver inside level to listen to OSC Server
  • Apply data in Animation Blueprints

Twitch Integration (OWLInteractiveStreamer)

Scene Preview

  • Use MyTwitchChatListener, MyTwitchChatSender, and MyTwitchEventSubManager inside OWLINteractiveStreamer plugins folder
  • Drag and Drop into level and configure in blueprints

How can I access VTS?

VTS is available on our Download Center and GitHub repository. We will be releasing updates regularly to provide new assets and blueprint for VTuber application development.

Licensing

The OWL VTuber Studio is an Apache-licensed open-source Unreal project file repository on GitHub.

It allows users to use the software for any purpose, to distribute it, to modify it, and to distribute modified versions of the software under the terms of the license, without concern for royalties.

FAQ

How can I get LiveLink to work in packaged game?

You may use Command Prompt and cd into the appropriate file path, such as ../VTuberStudio/Builds/Windows/, and use the following command line:

 VTuberStudio.exe -messaging

Contributions

VTS is a community-led and orientated project, encouraging collaboration and contribution among content creators with or without experience in game development.

To contribute to VTuber Studio, it is recommended that you submit changes in one blueprint at a time.

After you initiate a pull request, the OWL team will review/ approve each request individually to ensure that proposed changes are aligned with our style requirements.

Acknowledgement

VTS relies on the VRM4U plugin created by @ruyo_h. VRM4U plugin can be found here (https://github.com/ruyo/VRM4U). The plugin is licensed under the MIT license.

OWLStreamingToolkit is Copyright © 2021 Off World Live Limited. All rights reserved.

Contributors

VTuber Studio is created by @jennnital and @wesleyyuen with the support of the Off World Live team. Key visual assets and environment design by @jennnital,@enpe23 and @HardcoreRick. Special thanks to @campbellwmorgan @fdomw for the development of VTuber Studio.

Scene Preview

Off World Live is a creator-focused engineering and research group democratizing media content creation in Unreal Engine.

To learn more about our products and relevant licenses, please join our community on Discord.