Skip to content

Latest commit

 

History

History
107 lines (82 loc) · 3 KB

README.md

File metadata and controls

107 lines (82 loc) · 3 KB
Raw

vrchat-jellyfin

Docker

a Jellyfin client designed for VRChat

Important

Incomplete Project

While this project is functional, it is not yet complete. The end goal is to have a link that can be pasted into the vrchat client, then use the jellyfin cast feature to control the player like a chromecast. This is not yet implemented, and the current implementation is a workaround.

handles requesting media from jellyfin in a format that can be played in vrchat, as well as proxying urls to bypass the risk of sharing a jellyfin api key

Tips

  • If the player has a switch between Video and Stream, use Stream
  • I've personally had better luck with the Unity video player over the AVPro one, but both should work
  • If you change the video encoding settings, 720p (the default) works best for most devices. I wouldn't go above 1080p unless you have a smaller group or high upload bandwitdh.

Supported Platforms

  • VRChat
  • Chillout VR
  • Resonite (crashes)

These are just platforms that have been tested, feel free to PR with other platforms if you've tested on them

Docker

A docker image is provided for easy deployment:

Running

Docker Compose (recommended):

version: '3'
services:
  vrchat-jellyfin:
    image: ghcr.io/gurrrrrrett3/vrchat-jellyfin:master
    container_name: vrchat-jellyfin
    restart: unless-stopped
    ports:
      - 4000:4000
    environment:
      JELLYFIN_HOST: <http[s]://URL>
      JELLYFIN_USERNAME: <USERNAME>
      JELLYFIN_PASSWORD: <PASSWORD>
      AUDIO_BITRATE: 128000
      VIDEO_BITRATE: 3000000
      MAX_AUDIO_CHANNELS: 2
      MAX_HEIGHT: 720
      MAX_WIDTH: 1280

Docker CLI:

docker run -d \
--name vrchat-jellyfin \
--restart unless-stopped \
-p 4000:4000 \
-e JELLYFIN_HOST=<http[s]://URL> \
-e JELLYFIN_USERNAME=<USERNAME> \
-e JELLYFIN_PASSWORD=<PASSWORD> \
-e AUDIO_BITRATE: 128000 \
-e VIDEO_BITRATE: 3000000 \
-e MAX_HEIGHT: 720 \
-e MAX_WIDTH: 1280 \
ghcr.io/gurrrrrrett3/vrchat-jellyfin:master

Installation (No Docker)

Install Node.js and npm

npm install
npm run build

Rename the .env.example file to .env and fill in the required fields.

It's reccommended to use a process manager like pm2 to keep it running:

pm2 start dist/index.js --name vrc-jellyfin
pm2 save

Make sure to do pm2 startup if you haven't already so it autostarts

Usage

Go to the web interface (default port is 4000), select media, and copy the link. Paste the link into the vrchat client to play the media.

Progress

  • Jellyfin proxy
  • Transcoding
  • Subtitle Baking
  • Audio track selection
  • Subtitle track selection
  • Temp Web interface
  • Support for the jellyfin cast api
  • Video Stream generation (splash screen with instructions, etc)
  • Docker
  • Seeking (not sure if this is possible)