ALVR-IPv6/README.md

89 lines
5.1 KiB
Markdown
Raw Permalink Normal View History

2020-12-13 09:55:24 -06:00
<p align="center"> <img width="500" src="resources/alvr_combined_logo_hq.png"/> </p>
2020-05-25 08:29:58 -05:00
2018-05-24 07:52:32 -05:00
# ALVR - Air Light VR
2017-06-14 17:06:59 -05:00
2021-12-10 11:17:01 -06:00
[![badge-discord][]][link-discord] [![badge-matrix][]][link-matrix] [![badge-opencollective][]][link-opencollective]
2018-05-29 09:11:00 -05:00
2021-01-10 08:47:57 -06:00
Stream VR games from your PC to your headset via Wi-Fi.
ALVR uses technologies like [Asynchronous Timewarp](https://developer.oculus.com/documentation/native/android/mobile-timewarp-overview) and [Fixed Foveated Rendering](https://developer.oculus.com/documentation/native/android/mobile-ffr) for a smoother experience.
2023-01-07 07:46:37 -06:00
Most of the games that run on SteamVR or Oculus Software (using Revive) should work with ALVR.
2021-01-10 08:47:57 -06:00
This is a fork of [ALVR](https://github.com/polygraphene/ALVR).
2023-09-25 22:46:44 -05:00
| VR Headset | Support |
| :-------------------: | :--------------------------------------------------------------------: |
2023-10-12 00:10:06 -05:00
| Quest 1/2/3/Pro | :heavy_check_mark: |
2023-09-25 22:46:44 -05:00
| Pico 4/Neo 3 | :heavy_check_mark: |
| Vive Focus 3/XR Elite | :heavy_check_mark: |
| YVR 1/2 | :heavy_check_mark: |
| Lynx R1 | :heavy_check_mark: |
| Smartphone/Monado | :warning: * |
| Google Cardboard | :warning: * ([PhoneVR](https://github.com/PhoneVR-Developers/PhoneVR)) |
| GearVR | :construction: (maybe) |
| Oculus Go | :x: ** |
2023-06-02 04:14:24 -05:00
2023-09-25 22:46:44 -05:00
\* : Only works on some smartphones, not enough testing.
2023-06-02 04:14:24 -05:00
\** : Oculus Go support was dropped, the minimum supported OS is Android 8. Download the last compatible version [here](https://github.com/alvr-org/ALVR/releases/tag/v18.2.3).
| PC OS | Support |
| :-----------------: | :-----------------: |
| Windows 8/10/11 | :heavy_check_mark: |
| Windows 7/XP | :x: |
| Ubuntu/Arch | :warning: *** |
| Other linux distros | :grey_question: *** |
| macOS | :x: |
\*** : Linux support is still in beta. To be able to make audio work or run ALVR at all you may need advanced knowledge of your distro for debugging or building from source.
2020-05-25 09:52:50 -05:00
2018-05-24 07:52:32 -05:00
## Requirements
2023-01-07 07:46:37 -06:00
- A supported standalone VR headset (see compatibility table above)
2023-01-07 07:46:37 -06:00
- SteamVR
- High-end gaming PC
2023-01-07 07:46:37 -06:00
- See OS compatibility table above.
- NVIDIA GPU that supports NVENC (1000 GTX Series or higher) (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 5Ghz wireless or ethernet wired connection
- It is recommended to use 802.11ac 5Ghz for the headset and ethernet for PC
2023-01-23 10:10:29 -06:00
- You need to connect both the PC and the headset to same router (or use a routed connection as described [here](https://github.com/alvr-org/ALVR/wiki/ALVR-v14-and-Above))
2018-05-24 07:52:32 -05:00
2020-05-25 09:52:50 -05:00
## Install
2023-02-06 08:13:49 -06:00
Follow the installation guide [here](https://github.com/alvr-org/ALVR/wiki/Installation-guide).
2020-12-09 16:32:37 -06:00
2020-05-25 09:52:50 -05:00
## Troubleshooting
2020-05-25 08:29:58 -05:00
- Please check the [Troubleshooting](https://github.com/alvr-org/ALVR/wiki/Troubleshooting) page. The original repository [wiki](https://github.com/polygraphene/ALVR/wiki/Troubleshooting) can also help.
- Configuration recommendations and information may be found [here](https://github.com/alvr-org/ALVR/wiki/PC)
2018-05-27 09:18:32 -05:00
2020-05-25 09:52:50 -05:00
## Uninstall
2023-03-30 18:44:44 -05:00
Open `ALVR Dashboard.exe`, go to `Installation` tab then press `Remove firewall rules`. Close ALVR window and delete the ALVR folder.
2020-05-25 09:52:50 -05:00
## Build from source
2021-12-10 11:49:24 -06:00
You can follow the guide [here](https://github.com/alvr-org/ALVR/wiki/Building-From-Source).
2018-05-24 07:52:32 -05:00
## License
2020-05-25 09:52:50 -05:00
ALVR is licensed under the [MIT License](LICENSE).
2018-05-24 07:52:32 -05:00
2021-02-03 10:25:04 -06:00
## Privacy policy
ALVR apps do not directly collect any kind of data.
## Donate
If you want to support this project you can make a donation to our [Open Source Collective account](https://opencollective.com/alvr).
2018-05-28 01:12:54 -05:00
You can also donate to the original author of ALVR using Paypal (polygraphene@gmail.com) or with bitcoin (1FCbmFVSjsmpnAj6oLx2EhnzQzzhyxTLEv).
2020-06-16 09:41:01 -05:00
2021-12-10 11:17:01 -06:00
[badge-discord]: https://img.shields.io/discord/720612397580025886?style=for-the-badge&logo=discord&color=5865F2 "Join us on Discord"
[link-discord]: https://discord.gg/ALVR
2021-12-10 11:17:01 -06:00
[badge-matrix]: https://img.shields.io/static/v1?label=chat&message=%23alvr&style=for-the-badge&logo=matrix&color=blueviolet "Join us on Matrix"
[link-matrix]: https://matrix.to/#/#alvr:ckie.dev?via=ckie.dev
[badge-opencollective]: https://img.shields.io/opencollective/all/alvr?style=for-the-badge&logo=opencollective&color=79a3e6 "Donate"
[link-opencollective]: https://opencollective.com/alvr