diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 30 insertions, 4 deletions
@@ -1,16 +1,31 @@ -A virtual reality video player for Linux running X11, based on Valve's openvr `hellovr_opengl` sample code: https://github.com/ValveSoftware/openvr/tree/master/samples +A virtual reality video player for Linux, based on Valve's openvr `hellovr_opengl` sample code: https://github.com/ValveSoftware/openvr/tree/master/samples Currently only works with stereo video and equirectangular cube maps (youtube 360 videos) when used for vr videos, but if the vr video player is launched with the `--plane` option then you can view the video as a regular video in vr without depth (like a cinema). +You can view videos directly in the VR headset or as an overlay in the SteamVR menu if you use the --overlay option. + ## Note -Might now work when using a compositor such as picom when using the glx backend. +Might not work when using a compositor such as picom when using the glx backend (when capturing a window). # Building Run `./build.sh` or if you are running Arch Linux, then you can find it on aur under the name vr-video-player-git (`yay -S vr-video-player-git`).\ -Dependencies needed when building using `build.sh`: `glm, glew, sdl2, openvr, libx11, libxcomposite, libfixes`. +Dependencies needed when building using `build.sh`: `glm, glew, sdl2, openvr, libx11, libxcomposite, libxfixes, libmpv, libxdo (xdotool)`. # How to use +vr-video-player has two options. Either capture a window and view it in vr (works only on x11) or a work-in-progress built-in mpv option. +# Using the built-in video player +To play a video with the built-in mpv player, run vr-video-player like so: +``` +./vr-video-player --sphere --video <file-path> +``` +for example: +``` +./vr-video-player --sphere --video /home/adam/Videos/my-cool-vr-video.mp4 +``` +`--sphere` can be replaced with `--flat`, `plane` or `--sphere360` for different display modes. + +# Capturing a window Install xdotool and launch a video in a video player (I recommend mpv, because browsers, smplayer and vlc player remove the vr for 360 videos) and resize it to fit your monitor or larger for best quality and then, if you want to watch 180 degree stereoscopic videos then run: @@ -49,6 +64,13 @@ Alternatively, you can run: ``` and vr-video-player will automatically select the focused window (and update when the focused window changes). +To display a window as an overlay in SteamVR you can run: +``` +./vr-video-player --plane --overlay $(xdotool selectwindow) +``` +and click on the window you want to view in your VR headset. + +# Input options The video might not be in front of you, so to move the video in front of you, you can do any of the following: * Pull the trigger on the vr controller * Press "Alt + F1" @@ -56,7 +78,11 @@ The video might not be in front of you, so to move the video in front of you, yo * Press the select/back button on an xbox controller while the application is focused * Send a SIGUSR1 signal to the application, using the following command: `killall -USR1 vr-video-player` -You can zoom the view with alt + Q/E. +You can close the application by pressing Esc when the application is focused. + +You can zoom the view with Alt + Q/E. + +When using the built-in video player and the vr window is focused you can then use left/right arrow keys to move back/forward in the video and space to pause. In the future vr-video-player will show a graphical interface inside vr to manipulate the video. You can launch vr-video-player without any arguments to show a list of all arguments. |