Giter Club home page Giter Club logo

alvr's Introduction

ALVR - Air Light VR

Badge-Discord

Stream VR games from your PC to your Oculus Quest via Wi-FI.
ALVR uses technologies like Asynchronous Timewarp and Fixed Foveated Rendering for a smoother experience.
All games that work with an Oculus Rift (s) should work with ALVR.
This is a fork of ALVR that works only with Oculus Quest.

Requirements

  • Oculus Quest (Headset-Version 358570.6090.0 or later)
  • SteamVR
  • High-end gaming PC
    • Windows 10 May 2020 update is recommended. If you are on an older version, you need to install Chrome or another Chromium based browser.
    • Minimum supported OS version is Windows 8.
    • NVIDIA GPU that supports NVENC (Supported GPUs) (or with an AMD GPU that supports AMF VCE) with the latest driver.
    • Laptops with an onboard (Intel HD, AMD iGPU) and an additional dedicated GPU (NVidia GTX/RTX, AMD HD/R5/R7): you should assign the dedicated GPU or "high performance graphics adapter" to the applications ALVR, SteamVR for best performance and compatibility. (NVidia: Nvidia control panel->3d settings->application settings; AMD: similiar way)
  • 802.11ac wireless or ethernet wired connection
    • It is recommended to use 802.11ac for the headset and ethernet for PC
    • You need to connect both the PC and the headset to same router (or use a routed connection as described here)

Install

Please uninstall any other VR streaming software on your PC. This includes versions of ALVR prior to v12.0.

If you didn't already, install SteamVR, launch it and then close it (this is to make sure SteamVR executes its first time setup).

Install the latest Visual C++ Redistrubutable x64 package. Do this every time you install a new ALVR version!

To install ALVR download alvr_server_windows.zip from the releases page, unzip it and launch ALVR.exe (the folder path must contain only UTF-8 characters and must be editable with user privileges). The first time you open ALVR.exe you may have to allow it in the SmartScreen prompt and allow the network access to alvr_web_server in another popup window (it could be behind the actual ALVR window).
It's important not to move the folder after the first launch. To keep settings from a previous installation of ALVR (>=v12.0) you can unzip over the old installation folder.

Install the client on your headset through SideQuest.

To make the Oculus Quest microphone work you need to install the VB-CABLE Virtual Audio Device.

Usage

  • Launch ALVR.exe (ALVR dashboard). The first time a setup wizard will guide you through the installation.
  • Launch ALVR on your headset. While the headset screen is on, click Trust next to the client entry (on the PC) to start streaming.
  • If you trusted a client, you can start streaming by just launching ALVR on your headset, then SteamVR or the ALVR dashboard on PC.
  • To change settings, open the dashboard on the headset with a long press of the menu button (on the left controller), change what you want and then press Restart SteamVR. The current playing game could shutdown so any unsaved progress could be lost.
  • To shutdown ALVR you need to close both the ALVR dashboard on PC and SteamVR.

Notes

  • You can access ALVR dashboard from your smartphone. On the browser you need to type the local IP of your PC followed by :8082 (for example: 192.168.0.3:8082 ).

Troubleshooting

  • To reset ALVR, delete the file session.json from the installation folder.
  • Please check the Troubleshooting page. The original repository wiki can also help.
  • You can find some setup advice here.

Uninstall

Launch ALVR.exe, go to Installation tab, press Remove next to the current ALVR installation path, then Remove firewall rules. Close ALVR window and delete the ALVR folder.

If you have a version prior to v12.0 you need to launch remove_firewall_rules.bat and driver_uninstall.bat in the installation folder.

Build from source

Preferred IDE (optional): Visual Studio Code with rust-analyzer extension

Common requisites

  • Install LLVM
  • Install rustup
  • Download this repository

Build server

  • Install the MSVC compiler (for example installing C++ build tools with Visual Studio)

  • On the repository root execute:

    cargo xtask build-server --release
  • ALVR server will be built into /build/alvr_server_windows.

Note: The Visual Studio solution is left only for IDE support while coding. If compiled, the resulting binary will not be valid.

Build client

  • Install Python

  • Install Android Studio >=4.0, API Level 30. Requires latest LLDB and NDK packages.

  • Set the environment variable JAVA_HOME to C:\Program Files\Android\androidStudio\jre.

  • On the repository root execute:

    cargo xtask install-deps
    cargo xtask build-client --release
  • ALVR client will be built into /build.

Note: After doing the above steps, you can debug the client normally by opening the Android Studio project at alvr/client/android.

License

ALVR is licensed under the MIT License.

Donate to the original author

If you like this project, please donate to the original author!

Donate with PayPal

Donate

If you cannot use this link, please try the following.

  1. Login with your PayPal account
  2. Open "Send and request" tab
  3. Click "Pay for goods or services"
  4. Put "[email protected]" (it's the PayPal account of the original author) and click next

Donate with bitcoin

bitcoin:1FCbmFVSjsmpnAj6oLx2EhnzQzzhyxTLEv

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.