kohrokho
/
ALVR-IPv6
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sync Files

This commit is contained in:
GitHub Action 2023-01-23 16:10:29 +00:00
parent f593910d3a
commit 6e7d54cc6e
17 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -45,11 +45,11 @@ This is a fork of [ALVR](https://github.com/polygraphene/ALVR).
- 802.11ac 5Ghz wireless or ethernet wired connection
- It is recommended to use 802.11ac 5Ghz 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](https://github.com/alvr-org/ALVR/wiki/ALVR-client-and-server-on-separate-networks))
- 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))
## Install
Follow the installation guide [here](https://github.com/alvr-org/ALVR/wiki/Basic-installation).
Follow the Basic-installation guide [here](https://github.com/alvr-org/ALVR/wiki/Basic-Basic-installation).
## Troubleshooting
@ -58,9 +58,9 @@ Follow the installation guide [here](https://github.com/alvr-org/ALVR/wiki/Basic
## Uninstall
Open `ALVR Launcher.exe`, go to `Installation` tab then press `Remove firewall rules`. Close ALVR window and delete the ALVR folder.
Open `ALVR Launcher.exe`, go to `Basic-installation` tab then press `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.
If you have a version prior to v12.0 you need to launch `remove_firewall_rules.bat` and `driver_uninstall.bat` in the Basic-installation folder.
## Build from source

2
alvr/common/README.md
View File

@ -1,3 +1,3 @@
# alvr_common
This crate contains some basic functionality shared across all crates in the workspace. In particular it contains constants, logging front-end, and re-exports frequently-used external dependencies.
This crate contains some basic functionality shared across all crates in the workspace. In particular it contains constants, logging front-end, and re-exports frequently-used external dependencies.

4
wiki/ALVR-Checklist.md
View File

@ -19,6 +19,6 @@
## Troubleshooting
* [ ] The firewall settings where successfully applied with the setup of ALVR
* [ ] I did not change the network settings since the installation of ALVR (Private/Public/Work)
* [ ] I did not move the installation folder of ALVR since the setup
* [ ] I did not change the network settings since the Basic-installation of ALVR (Private/Public/Work)
* [ ] I did not move the Basic-installation folder of ALVR since the setup
* [ ] The path to the folder of ALVR does not contain any non latin characters or accents (ツ Л Ö ...)

4
wiki/ALVR-client-and-server-on-separate-networks.md
View File

@ -34,7 +34,7 @@ Cons:
- ZeroTier APK for your Quest (you can find it online)
- SideQuest or some other method to install the ZeroTier APK onto your headset
### Installation
### Basic-installation
Use the "Install APK" function of SideQuest to install the ZeroTier APK to your Quest, and also download and install ZeroTier on your PC. After you've installed ZeroTier, follow Zerotier's official [Getting Started](https://zerotier.atlassian.net/wiki/spaces/SD/pages/8454145/Getting+Started+with+ZeroTier) guide to setup a network for ALVR. Join the network on both the Quest and the PC. On the Quest, make sure that the network is enabled by switching on the slider on the network in the list in the ZeroTier app (you may be prompted to allow ZeroTier to create a VPN connection).
After both your PC and your Quest are connected to the same ZeroTier network, we'll need to manually add your quest to the ALVR dashboard. To do so, we'll need to find your Quest's ZeroTier IP. There are two ways to do this.
@ -70,7 +70,7 @@ Its pros and cons are similar to ZeroTier, but it's self-hosted and open-source
- A server with public IP and allow public ports
- SideQuest or some other method to install the hin2n APK onto your headset
### Installation
### Basic-installation
We're going to use n2n v3, and set the port of _supernode_ to `1234` as the example. You can change `1234` to any port, but below `1024` requires root.
- Open port `1234` on your server's firewall (usually `iptables`, if you don't know what to do, ask Google).

2
wiki/Fixed-Foveated-Rendering-(FFR).md
View File

@ -43,4 +43,4 @@ For the slice method, you can also set a center offset. This moves the high res
[wikipedia](https://en.wikipedia.org/wiki/Foveated_rendering)
[wikipedia](https://en.wikipedia.org/wiki/Foveated_rendering)

2
wiki/Home.md
View File

@ -1,3 +1,3 @@
ALVR is a piece of software to stream SteamVR games to your standalone VR headset.
Use the sidebar to navigate the wiki.
Use the sidebar to navigate the wiki.

6
wiki/How-ALVR-works.md
View File

@ -10,7 +10,7 @@ If you have any doubt about what is (or isn't) written in here you can contact @
### The built application
ALVR is made of two applications: the server and client. The server is installed on the PC and the client is installed on the headset. While the client is a single APK, the server is made of three parts: the launcher, the driver and the dashboard. The launcher (`ALVR Launcher.exe`) is the single executable found at the root of the server app installation. The driver is located in `bin/win64/` and named `driver_alvr_server.dll`. The dashboard is a collection of files located in `dashboard/`.
ALVR is made of two applications: the server and client. The server is installed on the PC and the client is installed on the headset. While the client is a single APK, the server is made of three parts: the launcher, the driver and the dashboard. The launcher (`ALVR Launcher.exe`) is the single executable found at the root of the server app Basic-installation. The driver is located in `bin/win64/` and named `driver_alvr_server.dll`. The dashboard is a collection of files located in `dashboard/`.
The launcher sets up the PC environment and then opens SteamVR, which loads the ALVR driver. The driver is responsible for loading the dashboard and connecting to the client.
@ -56,7 +56,7 @@ While log IDs can contain any (serializable) type of data, it is preferred to us
## The launcher
The launcher is the entry point for the server application. It first checks that SteamVR is installed and setup properly and then launches it.
The launcher requires `%LOCALAPPDATA%/openvr/` to contain a valid UTF-8 formatted file `openvrpaths.vrpath`. This file is crucial because it contains the path of the installation folder of SteamVR, the paths of the current registered drivers and the path of the Steam `config/` folder.
The launcher requires `%LOCALAPPDATA%/openvr/` to contain a valid UTF-8 formatted file `openvrpaths.vrpath`. This file is crucial because it contains the path of the Basic-installation folder of SteamVR, the paths of the current registered drivers and the path of the Steam `config/` folder.
### The bootstrap lifecycle
@ -69,7 +69,7 @@ The launcher requires `%LOCALAPPDATA%/openvr/` to contain a valid UTF-8 formatte
### Other launcher functions
The launcher has the button `Reset drivers and retry` that attempts to fix the current ALVR installation. It works as follows:
The launcher has the button `Reset drivers and retry` that attempts to fix the current ALVR Basic-installation. It works as follows:
1. SteamVR is killed.
2. `openvrpaths.vrpath` is deleted and ALVR add-on is unblocked (in `steam/config/steamvr.vrsettings`).

16
wiki/Installation.md
View File

@ -1,11 +1,11 @@
# Basic installation
# Basic Basic-installation
PC side:
* Install SteamVR, **launch it once** then close it. This is to make sure it sets the environment correctly for ALVR.
* Go to the latest release [download page](https://github.com/alvr-org/ALVR/releases/latest). In the "Assets" section at the bottom download the ALVR Installer.
* Run the installer. If prompted, allow the execution in the SmartScreen popup. You need to give administrator permissions to install ALVR. For best compatibility do not change the installation folder.
* Once the installation finished, launch ALVR. You are greeted with a setup wizard. Follow the setup to set the firewall rules and presets.
* Run the installer. If prompted, allow the execution in the SmartScreen popup. You need to give administrator permissions to install ALVR. For best compatibility do not change the Basic-installation folder.
* Once the Basic-installation finished, launch ALVR. You are greeted with a setup wizard. Follow the setup to set the firewall rules and presets.
**If you have problems launching ALVR, follow the guide below to use the portable version**
@ -21,7 +21,7 @@ Headset side:
For any problem visit the [troubleshooting page](https://github.com/alvr-org/ALVR/wiki/Troubleshooting).
# Advanced installation
# Advanced Basic-installation
## Portable version
There is also a portable version for the PC that requires more manual steps to make it work.
@ -44,22 +44,22 @@ To use the microphone you need to install the [VB-CABLE driver](https://vb-audio
## Connect headset and PC on separate networks
Check out the guide [here](https://github.com/alvr-org/ALVR/wiki/ALVR-client-and-server-on-separate-networks).
Check out the guide [here](https://github.com/alvr-org/ALVR/wiki/ALVR-v14-and-Above).
## Use ALVR together with third-party drivers
By default ALVR disables other SteamVR drivers before starting. Among these drivers there is [Driver4VR](https://www.driver4vr.com/) for full body tracking. ALVR disables these drivers to maximize compatibility with every PC setup. You can disable this behavior by manually registering the ALVR driver. Go to the `Installation` tab and click on `Register ALVR driver`. The next time you launch ALVR you will be able to use the other drivers concurrently.
By default ALVR disables other SteamVR drivers before starting. Among these drivers there is [Driver4VR](https://www.driver4vr.com/) for full body tracking. ALVR disables these drivers to maximize compatibility with every PC setup. You can disable this behavior by manually registering the ALVR driver. Go to the `Basic-installation` tab and click on `Register ALVR driver`. The next time you launch ALVR you will be able to use the other drivers concurrently.
## Launch ALVR together with SteamVR
You can skip the ALVR Launcher and open ALVR automatically together with SteamVR. Open ALVR, go to the `Installation` tab and click on `Register ALVR driver`.
You can skip the ALVR Launcher and open ALVR automatically together with SteamVR. Open ALVR, go to the `Basic-installation` tab and click on `Register ALVR driver`.
## Use a browser different than Chrome
ALVR requires a Chromium based browser to correctly display the dashboard. Chrome and Edge work out of the box, but Edge has a few bugs that make ALVR behave weirdly. If you want to use other Chromium based browsers like Brave or Vivaldi you have to add an environment variable `ALCRO_BROWSER_PATH` pointing to the path of the browser executable (for example `C:\Program Files\Vivaldi\Application\vivaldi.exe`). Unfortunately Firefox is not supported.
## Connect headset and PC via a USB Cable
Check out the guide [here](https://github.com/alvr-org/ALVR/wiki/Use-ALVR-through-a-USB-connection).
Check out the guide [here](https://github.com/alvr-org/ALVR/wiki/Using-ALVR-through-a-USB-connection).
# Linux

2
wiki/Linux-Support-development-progress.md
View File

@ -78,4 +78,4 @@ References:
* OpenVR driver header: https://github.com/ValveSoftware/openvr/blob/master/headers/openvr_driver.h
* Main OpenVR issue tracker: https://github.com/ValveSoftware/openvr/issues
* Virtual display sample issue tracker: https://github.com/ValveSoftware/virtual_display/issues
* Linux SteamVR issue tracker: https://github.com/ValveSoftware/steam-for-linux/issues
* Linux SteamVR issue tracker: https://github.com/ValveSoftware/steam-for-linux/issues

2
wiki/Linux-encoders-requirements.md
View File

@ -45,7 +45,7 @@ ffmpeg -vaapi_device /dev/dri/renderD128 -f lavfi -i testsrc -t 30 -vf 'format=n
## AMF (AMD GPUs)
AMF requires proprietary Vulkan driver amd-pro. Troubleshooting AMF installation on your system is out of scope here, but you
AMF requires proprietary Vulkan driver amd-pro. Troubleshooting AMF Basic-installation on your system is out of scope here, but you
can use [amf-test](https://github.com/nowrep/amf-test-linux). HEVC is only supported on RDNA and newer GPUs.
Make sure amf-test succeeds before you try to get it working with ALVR.

2
wiki/Other-resources.md
View File

@ -1 +1 @@
* Hand tracking OSC for VRChat with ALVR support: https://github.com/A3yuu/FingerTruckerOSC
* Hand tracking OSC for VRChat with ALVR support: https://github.com/A3yuu/FingerTruckerOSC

2
wiki/Real-time-video-upscaling-experiments.md
View File

@ -35,4 +35,4 @@ A well established real-time upscaler is [Anime4K](https://github.com/bloc97/Ani
For an upscaler that has a better PSNR there are many options but very few that can run real-time. The smallest neural net that I could find is [SubPixel-BackProjection](https://github.com/supratikbanerjee/SubPixel-BackProjection_SuperResolution). Tt gets nice results but in my testing took 3 seconds to upscale from 720p to 1080p with CUDA acceleration. Way out of the ballpark for XR2 the chip.
So in conclusion, it does not seem like there is enough performance to squeeze out of the XR2 to do do real-time NN upscaling at such high resolutions. We will more likely get better results out of classical techniques.
So in conclusion, it does not seem like there is enough performance to squeeze out of the XR2 to do do real-time NN upscaling at such high resolutions. We will more likely get better results out of classical techniques.

4
wiki/Settings-guide.md
View File

@ -341,7 +341,7 @@ In this document, settings in **Basic Settings** describe settings that are visi
### Log to disk
* Save the file `session.txt` at the root of the ALVR installation folder.
* Save the file `session.txt` at the root of the ALVR Basic-installation folder.
* This is useful to get get debug information when a crash happens. By default this is disabled because this file continues to grow as long as ALVR is kept open and it keeps growing until the whole hard-drive is filled.
## Advanced Extras
@ -352,4 +352,4 @@ In this document, settings in **Basic Settings** describe settings that are visi
### Exclude notifications without ID
* This is a legacy setting. It should be set to false for now.
* This is a legacy setting. It should be set to false for now.

2
wiki/Troubleshooting-(for-ALVR-12.0.0-and-later).md
View File

@ -1 +1 @@
This page has been moved [here](https://github.com/alvr-org/ALVR/wiki/Troubleshooting).
This page has been moved [here](https://github.com/alvr-org/ALVR/wiki/Troubleshooting).

10
wiki/Troubleshooting.md
View File

@ -1,9 +1,9 @@
Troubleshooting (for ALVR 14.0.0 and later)
===
First off, please make sure to carefully read the [installation](https://github.com/alvr-org/ALVR/wiki/Installation) and [usage](https://github.com/alvr-org/ALVR/wiki/Usage) instructions.
First off, please make sure to carefully read the [Basic-installation](https://github.com/alvr-org/ALVR/wiki/Basic-installation) and [usage](https://github.com/alvr-org/ALVR/wiki/Usage) instructions.
The first thing to try is to delete the file `settings.json` located in the ALVR installation folder on the PC. This resets everything to default. If it doesn't work, try reinstalling ALVR.
The first thing to try is to delete the file `settings.json` located in the ALVR Basic-installation folder on the PC. This resets everything to default. If it doesn't work, try reinstalling ALVR.
Keep in mind that sometimes a restart of ALVR/SteamVR/PC/Headset will be enough to solve some problems.
@ -105,9 +105,9 @@ If you're still getting this message (or otherwise not getting a headset icon in
#### Some lines to look for and tips for them:
`Unable to load driver alvr_server because of error VRInitError_Init_FileNotFound(103). Skipping.` - This usually means a library that ALVR needs is missing. Make sure you followed installation instructions carefully, installed the latest Visual C++ Redistributable x64 package and no files are missing where you extracted ALVR (especially in the bin\win64 directory).
`Unable to load driver alvr_server because of error VRInitError_Init_FileNotFound(103). Skipping.` - This usually means a library that ALVR needs is missing. Make sure you followed Basic-installation instructions carefully, installed the latest Visual C++ Redistributable x64 package and no files are missing where you extracted ALVR (especially in the bin\win64 directory).
`Skipping duplicate external driver alvr_server` - This line means another ALVR driver is registered. Go to the installation tab in ALVR and remove all drivers.
`Skipping duplicate external driver alvr_server` - This line means another ALVR driver is registered. Go to the Basic-installation tab in ALVR and remove all drivers.
`Skipping external driver X:\path\to\your\alvr_server_windows because it is not a directory` - This can happen if you put ALVR in a OneDrive (or a similar service) directory or the path to ALVR contains characters not in UTF-8. Try putting ALVR elsewhere, preferably so that the path to ALVR contains only ASCII characters.
@ -122,4 +122,4 @@ This is a situation where you have ALVR open on both headset and PC, you can see
First make sure that SteamVR (more specifically, vrserver.exe) is allowed incoming connections (UDP, port 9944) in your firewall. You can also try disabling your firewall for testing, but you keep it disabled to use ALVR.
You can try restarting ALVR on both the headset and the PC. On the headset, when connecting, you should see the view lagging behind when you turn your head (it drops below 1 fps), this means the headset is getting a response from the server when connecting and is waiting for the video stream to start. If you get no lag in the headset, response from the PC isn't reaching the headset.
You can try restarting ALVR on both the headset and the PC. On the headset, when connecting, you should see the view lagging behind when you turn your head (it drops below 1 fps), this means the headset is getting a response from the server when connecting and is waiting for the video stream to start. If you get no lag in the headset, response from the PC isn't reaching the headset.

2
wiki/Use-ALVR-through-a-USB-connection.md
View File

@ -53,4 +53,4 @@ The following programs serve to wrap and simplify the process of doing manual AD
***
Once you are finished, the headset should now establish a connection over USB.
Once you are finished, the headset should now establish a connection over USB.

10
wiki/_Sidebar.md
View File

@ -1,6 +1,6 @@
**Start here**
* [Installation](https://github.com/alvr-org/ALVR/wiki/Installation)
* [Basic-installation](https://github.com/alvr-org/ALVR/wiki/Basic-installation)
* [Settings guide](https://github.com/alvr-org/ALVR/wiki/Settings-guide)
@ -12,13 +12,13 @@
**Configuration**
* [Information and Recommendations](https://github.com/alvr-org/ALVR/wiki/Configuration-Information-and-Recommendations)
* [Information and Recommendations](https://github.com/alvr-org/ALVR/wiki/PC)
* [ALVR client and server on separate networks](https://github.com/alvr-org/ALVR/wiki/ALVR-client-and-server-on-separate-networks)
* [ALVR client and server on separate networks](https://github.com/alvr-org/ALVR/wiki/ALVR-v14-and-Above)
* [Fixed Foveated Rendering (FFR)](https://github.com/alvr-org/ALVR/wiki/Fixed-Foveated-Rendering-(FFR))
* [ALVR wired setup (ALVR over USB)](https://github.com/alvr-org/ALVR/wiki/Use-ALVR-through-a-USB-connection)
* [ALVR wired setup (ALVR over USB)](https://github.com/alvr-org/ALVR/wiki/Using-ALVR-through-a-USB-connection)
* [Linux encoders requirements](https://github.com/alvr-org/ALVR/wiki/Linux-encoders-requirements)
@ -46,4 +46,4 @@
* [Linux support](https://github.com/alvr-org/ALVR/wiki/Linux-Support-development-progress)
* [Real time video upscaling experiments](https://github.com/alvr-org/ALVR/wiki/Real-time-video-upscaling-experiments)
* [Real time video upscaling experiments](https://github.com/alvr-org/ALVR/wiki/Why?)