Skip to content

Tool to stream anything (e.g. Emby/Plex/Jellyfin etc.) to VRChat

License

Notifications You must be signed in to change notification settings

jameskitt616/vrchat_streaming

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

VRChat streaming

Tool to stream anything (e.g. Emby/Plex/Jellyfin etc.) to VRChat without hustle


Project description

n.eko is a virtual-shared Browser which allows multiple people viewing the exact same stream of the virtual Browser in your local Browser. One person has the control and can input/open any website they want, just like you would operate your local Browser. The control can be passed on. Read more about it, on the n.eko website.
Taking advantage of that, n.eko brings functionality to also stream that output e.g. via RTMP anywhere you like ( in this case to a self-hosted real-time media server called MediaMTX).
So the general workflow would be:

  • One Person operating n.eko in their local Browser e.g. starting a Video on their self-hosted Emby/Plex/Jellyfin Server
  • n.eko must be set up to stream the output of n.eko (is configured that it happens automatically on n.eko startup in this case)
  • The person puts in a link to the live stream into any VRChat video player where everyone can view the stream

General infos

  • This guide was written for Linux Servers. (Maybe I will investigate for Windows(WSL) use in the future)
  • Use a Server with a fairly modern CPU (+4 threads) because this will live encode two 1080p streams which is resource intensive. Check out Recommended Specs. I would absolutely recommend using an iGPU for encoding, pure CPU encoding mostly results in poor performance like low frame live streams.
  • Use RTSP to Streams due to better stability. Use HLS (despite it having higher latency ~7s -> which should not matter much when just streaming a video anyway) if you need to stream to Quest Users due Bugs in Android's media codec.
  • Use H.264 Codec for maximum compatibility, e.g. H.265 or VP9 might not work on some PC's or standalone VR-Headsets.
  • I'd recommend a fixed Bitrate of minimum 4000kbps for decent video quality, especially when watching dark/hectic video scenes to prevent the video to look mushy. (I will include an example for variable Bitrate, but commented out. In case video quality is less important, or you want to save on Bandwidth. (NEKO_BROADCAST_PIPELINE parameter in the docker-compose file))
  • Depending on your CPU's power you can play with the encoding presets, currently it's set to speed-preset=veryfast
  • CHANGE THE PASSWORDS in the docker-compose file for normal users (NEKO_PASSWORD) and admins ( NEKO_PASSWORD_ADMIN) who can operate n.eko. In general i recommend reading through the n.eko docs and configure n.eko to your liking.

Install instructions

Single Room Installation: This option allows for the installation and setup of a single room and stream at a time.

Multi-Room Installation: With this option, you can create multiple virtual rooms and streams, enabling several users to operate different virtual browsers simultaneously.

Transcode Type Single Room (Linux) Multi Room (Linux) Single Room (Windows) Multi Room (Windows)
CPU (not recommended) docs no docs or not supported yet no docs or not supported yet no docs or not supported yet
iGPU Intel docs docs no docs or not supported yet no docs or not supported yet
iGPU AMD no docs or not supported yet no docs or not supported yet no docs or not supported yet no docs or not supported yet
dGPU Nvidia no docs or not supported yet no docs or not supported yet no docs or not supported yet no docs or not supported yet
dGPU AMD no docs or not supported yet no docs or not supported yet no docs or not supported yet no docs or not supported yet
dGPU Intel Arc no docs or not supported yet no docs or not supported yet no docs or not supported yet no docs or not supported yet

Updating

  1. Run docker compose pull && docker compose up -d && docker image prune -f

Closing words

Feel free to open an issue or contact me for suggestions/questions/help.

Thanks to tenten8401!

About

Tool to stream anything (e.g. Emby/Plex/Jellyfin etc.) to VRChat

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published