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

Try fixing wiki bug

This commit is contained in:
Riccardo Zaglia 2023-02-06 14:51:32 +01:00
parent 2dab06b1cf
commit 1e0f587e76
10 changed files with 37 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -50,7 +50,7 @@ This is a fork of [ALVR](https://github.com/polygraphene/ALVR).
## Install
Follow the Basic-installation guide [here](https://github.com/alvr-org/ALVR/wiki/Basic-Basic-installation).
Follow the installation guide [here](https://github.com/alvr-org/ALVR/wiki/Installation).
## Troubleshooting
@ -59,9 +59,9 @@ Follow the Basic-installation guide [here](https://github.com/alvr-org/ALVR/wiki
## Uninstall
Open `ALVR Launcher.exe`, go to `Basic-installation` tab then press `Remove firewall rules`. Close ALVR window and delete the ALVR folder.
Open `ALVR Launcher.exe`, go to `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 Basic-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 installation folder.
## Build from source

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 Basic-installation of ALVR (Private/Public/Work)
* [ ] I did not move the Basic-installation folder of ALVR since the setup
* [ ] 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
* [ ] 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
### Basic-installation
### 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
### Basic-installation
### 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).

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 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/`.
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/`.
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 Basic-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 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 Basic-installation. It works as follows:
The launcher has the button `Reset drivers and retry` that attempts to fix the current ALVR 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`).

38
wiki/Installation.md
View File

@ -1,11 +1,13 @@
# Basic Basic-installation
# Installation
## 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 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.
* 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.
**If you have problems launching ALVR, follow the guide below to use the portable version**
@ -21,16 +23,16 @@ Headset side:
For any problem visit the [troubleshooting page](https://github.com/alvr-org/ALVR/wiki/Troubleshooting).
# Advanced Basic-installation
## Advanced installation
## Portable version
### Portable version
There is also a portable version for the PC that requires more manual steps to make it work.
* Install SteamVR and launch it once.
* Download `alvr_server_windows.zip` from the latest release [download page](https://github.com/alvr-org/ALVR/releases/latest).
* Unzip into a path that contains only ASCII characters and has edit permissions without administrator rights.
## Nightly
### Nightly
If you want to get new features early or you want to help with testing you can install a nightly version.
@ -38,42 +40,42 @@ Download the latest nightly server [here](https://github.com/alvr-org/ALVR-night
Since nightly releases can be unstable, for maximum compatibility always use matching versions for PC and headset. They are updated once a day.
## Microphone streaming
### Microphone streaming
To use the microphone you need to install the [VB-CABLE driver](https://vb-audio.com/Cable/). Set "CABLE Output" as the default microphone. Then you can enable the microphone in the ALVR setting, leave "Virtual microphone input" to Default.
## Connect headset and PC on separate networks
### Connect headset and PC 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
### 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 `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.
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.
## Launch ALVR together with SteamVR
### Launch ALVR together with SteamVR
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`.
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`.
## Use a browser different than Chrome
### 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
### Connect headset and PC via a USB Cable
Check out the guide [here](https://github.com/alvr-org/ALVR/wiki/Using-ALVR-through-a-USB-connection).
# Linux
## Linux
Unless you are using a nightly version, make sure all audio streaming options are disabled.
## Arch Linux
### Arch Linux
* Install `rustup` and a rust toolchain, if you don't have it: <https://wiki.archlinux.org/title/Rust#Arch_Linux_package>.
* Install [alvr](https://aur.archlinux.org/packages/alvr)<sup>AUR</sup> (recommended), [alvr-nightly](https://aur.archlinux.org/packages/alvr-nightly)<sup>AUR</sup>, or [alvr-git](https://aur.archlinux.org/packages/alvr-git)<sup>AUR</sup>
* Install SteamVR, **launch it once** then close it.
* Run `alvr_launcher` or ALVR from your DE's application launcher.
## Other
### Other
* Install FFmpeg with VAAPI/NVENC + DRM + Vulkan + x264/x265 support. You can use this [ppa:savoury1/ffmpeg5](https://launchpad.net/~savoury1/+archive/ubuntu/ffmpeg5) under Ubuntu, or download `alvr_server_portable.tar.gz` which has ffmpeg bundled.
* Install SteamVR, **launch it once** then close it.
@ -82,7 +84,7 @@ Unless you are using a nightly version, make sure all audio streaming options ar
If you do not install the correct version of FFmpeg systemwide, a common problem is the server crashing or failing to show images on the headset because SteamVR loads the wrong version of FFmpeg.
## Audio Setup
### Audio Setup
* If you are on PipeWire, install `pipewire-alsa` and `pipewire-pulse`
* `pavucontrol` and `pactl` (PulseAudio tools used as an example)

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 Basic-installation on your system is out of scope here, but you
AMF requires proprietary Vulkan driver amd-pro. Troubleshooting AMF 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/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 Basic-installation folder.
* Save the file `session.txt` at the root of the ALVR 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

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

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

8
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 [Basic-installation](https://github.com/alvr-org/ALVR/wiki/Basic-installation) and [usage](https://github.com/alvr-org/ALVR/wiki/Usage) instructions.
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.
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.
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.
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 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).
`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).
`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 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 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.

2
wiki/_Sidebar.md
View File

@ -1,6 +1,6 @@
**Start here**
* [Basic-installation](https://github.com/alvr-org/ALVR/wiki/Basic-installation)
* [Installation](https://github.com/alvr-org/ALVR/wiki/Installation)
* [Settings guide](https://github.com/alvr-org/ALVR/wiki/Settings-guide)