From 957f1af8b02c2fdbeb26210859f4c632ef1676b6 Mon Sep 17 00:00:00 2001 From: Michael Verdi Date: Fri, 1 Aug 2025 10:31:52 -0500 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++---------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index f2429d6..428be18 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,37 @@ # VR180 Web Player A web-based video player for 180 degree, 3D video. -Got an immersive video you want people to see with the Apple Vision Pro or Meta Quest headsets? You could build an app and deal with app stores. You could jump through some hoops to put it on YouTube but it will be limited to Meta headsets. Or you can use this web player and put it on your website. +Got an immersive video you want people to see with the Apple Vision Pro or Meta Quest headsets? Now you can put it on your website just like any other video! People will see the immersive 3D video if they have a capable headset or they'll get a 2D version on other devices. ## How to use it -Add the player script `` before the closing body tag and use this HTML snippet: +1. Drop the `vr180player` directory in the root level of your website. +2. Add the player script `` before the closing body tag. +3. And use this HTML snippet to embed your video: ```
- ``` -This creates a button on your page. When VR is available, the button will be active and clicking it will begin the immersive experience. - +## How it works +When the webpage loads, the video file is embeded normally, with a play button positioned over the poster frame. When the user clicks play, the player script checks if `navigator.xr` exists. If it does, a VR experience is initiated. If not, it builds a rectilinear, 2D view of your video and plays it that way. -*Example Button* +**VR on Apple Vision Pro** +![vr](https://github.com/user-attachments/assets/c1097a4f-8712-4e6b-a233-a52d49cb261e) -Once the video is playing, you can bring up video controls. When the video is over, you'll automatically exit the experience. +**2D in Safari on Mac** -![vr180-web-player](https://github.com/user-attachments/assets/ac86dba9-add9-462e-9590-26abc5f20912) +You can drag the 2D video around to see things outside the frame. +2d ## Video Format -**The player only supports 2:1, side-by-side video using either H.264 or HEVC in an mp4 file.** It does not support over-under, MV-HEVC, or .aivu. +**The player only supports 2:1, side-by-side video using either H.264 or HEVC in an mp4 file.** It does not support over-under, MV-HEVC, APMP, or .aivu. -## Features -Tapping anywhere will bring up the controls. Without interaction they will go away in 10 seconds. Tapping outside of the controls will close them right away. -- Play/Pause -- Rewind 15 seconds -- Skip 15 seconds -- Mute/Unmute -- Seek -- Exit VR - -## Future -I'm not a developer. I used AI to help create this and give me the ability to post immersive videos on my website. I'm unlikely to be able to help you if you run into problems, want to customize this, or add new features. I'm releasing this with the [unlicense](https://unlicense.org/) so you're free to do anything at all with it. That said, if you have ideas or want to contribute code, I'd love to [hear](mailto:hello@michaelverdi.com) from you. +## Support +I'm not a developer and I might not be able to help you if you run into problems, want to customize this, or add new features (not that I won't try). I'm releasing this with the [unlicense](https://unlicense.org/) so you're free to do anything at all with it. That said, if you have ideas or want to contribute code, I'd love to [hear](mailto:hello@michaelverdi.com) from you. ## Demo -**Test it out in a headset!** -Open [https://verdi.github.io/VR180-Web-Player/](https://verdi.github.io/VR180-Web-Player/) in a browser on your headset and then click the Enter VR button. +**Test it out!** +Open [https://verdi.github.io/VR180-Web-Player/](https://verdi.github.io/VR180-Web-Player/) in a browser on your headset (or another device). Or check out this short film I made -> [Blandscape](https://michaelverdi.com/blandscape)