Merge branch 'feat/trailing_spaces_check' into 'main'

feat: check for trailing spaces in CI

See merge request lvra/lvra.gitlab.io!19
This commit is contained in:
GabMus 2024-04-16 05:34:55 +00:00
commit 1f23058004
9 changed files with 37 additions and 14 deletions

View file

@ -6,6 +6,10 @@ test-links:
script: script:
- python3 ./test_links.py - python3 ./test_links.py
test-trailing-spaces:
script:
- ./test_trailing_spaces.sh
test-build: test-build:
image: registry.gitlab.com/pages/hugo/hugo_extended image: registry.gitlab.com/pages/hugo/hugo_extended
script: script:

View file

@ -78,12 +78,11 @@ mode = "Stereo"
## possible values: ## possible values:
## (a smaller viewing range here means things too close to you will give you double vision). ## (a smaller viewing range here means things too close to you will give you double vision).
## ##
## - "FromCamera": in this mode, we assume your eyes are at the cameras' physical location. this mode ## - "FromCamera": in this mode, we assume your eyes are at the cameras' physical location. this mode
## has larger viewing range, but everything will look smaller to you. ## has larger viewing range, but everything will look smaller to you.
## - "FromEye": in this mode, we assume your cameras are at your eyes' physical location. everything will ## - "FromEye": in this mode, we assume your cameras are at your eyes' physical location. everything will
## have the right scale in this mode, but the viewing range is smaller. ## have the right scale in this mode, but the viewing range is smaller.
## ##
## only available if mode is "Stereo" ## only available if mode is "Stereo"
projection_mode = "FromEye" projection_mode = "FromEye"
``` ```

View file

@ -19,6 +19,7 @@ Disclaimer: There's probably a better way. I'm not good at Python. Or machine le
### Prerequisites: ### Prerequisites:
Install the following packages using your distro's package manager: Install the following packages using your distro's package manager:
- Python 3.10 - Python 3.10
- Pip for Python 3.10 - Pip for Python 3.10
- Virtualenv for Python 3.10 - Virtualenv for Python 3.10
@ -30,6 +31,7 @@ Please use 3.10 exactly, not newer or older.
In this example, we will create the virtualenv inside `~/.var/venv/`. Feel free to change the location, any folder will work. In this example, we will create the virtualenv inside `~/.var/venv/`. Feel free to change the location, any folder will work.
Create virtualenv: Create virtualenv:
```bash ```bash
mkdir -p ~/.var/venv/svc/ mkdir -p ~/.var/venv/svc/
cd ~/.var/venv/svc/ cd ~/.var/venv/svc/
@ -37,6 +39,7 @@ python3.10 -m venv .
``` ```
Activate virtualenv Activate virtualenv
- On fish: `. bin/activate.fish` - On fish: `. bin/activate.fish`
- On csh: `. bin/activate.csh` - On csh: `. bin/activate.csh`
- On bash/zsh: `. bin/activate` - On bash/zsh: `. bin/activate`
@ -51,21 +54,26 @@ To exit the virtualenv, run `deactivate`.
Do these while you have the virtualenv activated. Do these while you have the virtualenv activated.
Install required tools: Install required tools:
- `python -m pip install -U pip setuptools wheel` - `python -m pip install -U pip setuptools wheel`
PyTorch with CUDA support for NVIDIA GPUs: PyTorch with CUDA support for NVIDIA GPUs:
- Please install CUDA 11.8 using your system package manager. Newer versions may not work. - Please install CUDA 11.8 using your system package manager. Newer versions may not work.
- `pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu118` - `pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cu118`
PyTorch with ROCm support for AMD GPUs: PyTorch with ROCm support for AMD GPUs:
- Please install ROCm 5.7.1 via your system package manager. Newer versions may not work. - Please install ROCm 5.7.1 via your system package manager. Newer versions may not work.
- `pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/rocm5.7` - `pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/rocm5.7`
PyTorch for CPU only (you can also choose CPU mode with the options above): PyTorch for CPU only (you can also choose CPU mode with the options above):
- `pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cpu` - `pip install -U torch torchaudio --index-url https://download.pytorch.org/whl/cpu`
Finally, install SVC: Finally, install SVC:
- `pip install -U so-vits-svc-fork` - `pip install -U so-vits-svc-fork`
### Launch the GUI ### Launch the GUI
@ -81,10 +89,10 @@ svcg
### Models ### Models
Grab a model from HuggingFace (link on top of page). Models that work with this setup are the ones tagged with ` Grab a model from HuggingFace (link on top of page). Models that work with this setup are the ones tagged with `so-vits-svc-4.0` or `so-vits-svc-4.1`.
so-vits-svc-4.0` or `so-vits-svc-4.1`.
You will need 2 files for SVC to work: You will need 2 files for SVC to work:
- `G_0000.pth` where 0000 is some number. Usually a higher number means better, but only if you're comparing files within the same repository. - `G_0000.pth` where 0000 is some number. Usually a higher number means better, but only if you're comparing files within the same repository.
- `config.json` tells SVC how to use the pth file. - `config.json` tells SVC how to use the pth file.
@ -103,6 +111,7 @@ Click `(Re)Start Voice Changer` to do just that. You also need to click this aft
This is for ALVR-only right now. TODO the rest. This is for ALVR-only right now. TODO the rest.
Use `qpwgraph` or `helvum` to: Use `qpwgraph` or `helvum` to:
1. Disconnect `vrserver` from `ALVR-MIC-Sink`. 1. Disconnect `vrserver` from `ALVR-MIC-Sink`.
2. Pipe the output of `vrserver` to the input of `Python3.10`. 2. Pipe the output of `vrserver` to the input of `Python3.10`.
3. Pipe the output of `Python3.10` to the input of `ALVR-MIC-Sink`. 3. Pipe the output of `Python3.10` to the input of `ALVR-MIC-Sink`.

View file

@ -43,4 +43,4 @@ In the second terminal window, run the following command. This command will perf
LD_LIBRARY_PATH=$(pwd) ./vrcmd --resetroomsetup LD_LIBRARY_PATH=$(pwd) ./vrcmd --resetroomsetup
``` ```
Use `Ctrl+C` in the first terminal window to stop the SteamVR server. Use `Ctrl+C` in the first terminal window to stop the SteamVR server.

View file

@ -14,7 +14,7 @@ title: Quick Start
- AMD+AMD laptop or desktop: Amazing choice, you have nothing to do. - AMD+AMD laptop or desktop: Amazing choice, you have nothing to do.
- Desktop with iGPU and dGPU of different brands: Disable your iGPU in BIOS. - Desktop with iGPU and dGPU of different brands: Disable your iGPU in BIOS.
- Laptop with Nvidia dGPU: - Laptop with Nvidia dGPU:
- **Option 1 (Ubuntu-only)**: Try the official Ubuntu solution `prime-select nvidia`. - **Option 1 (Ubuntu-only)**: Try the official Ubuntu solution `prime-select nvidia`.
- **Option 2**: Use `optimus-manager-qt` and switch to Nvidia. - **Option 2**: Use `optimus-manager-qt` and switch to Nvidia.
- **Option 3**: Launch steam, steamvr and all games with `prime-run` (Launch options: `prime-run %command%`) - **Option 3**: Launch steam, steamvr and all games with `prime-run` (Launch options: `prime-run %command%`)
@ -66,6 +66,7 @@ The `startvr` script [here](https://gist.github.com/galister/a85135f4a3aca5208ba
It can be used with both ALVR and wired headsets. It can be used with both ALVR and wired headsets.
What it does: What it does:
- Whitelist drivers for SpaceCal and ALVR so these will never get blocked - Whitelist drivers for SpaceCal and ALVR so these will never get blocked
- Apply bindings spam patch by Plyshka - Apply bindings spam patch by Plyshka
- Setcap the compositor after a SteamVR update - Setcap the compositor after a SteamVR update
@ -73,6 +74,7 @@ What it does:
- Prevent SteamVR processes from getting stuck and putting SteamVR in an inconsistent state - Prevent SteamVR processes from getting stuck and putting SteamVR in an inconsistent state
Extra steps when using with ALVR: Extra steps when using with ALVR:
- Under `Installation` tab, register the ALVR driver - Under `Installation` tab, register the ALVR driver
- Under `Settings`, `Steamvr Launcher` section, set `Driver launch action` to `No action`. - Under `Settings`, `Steamvr Launcher` section, set `Driver launch action` to `No action`.
@ -80,7 +82,7 @@ None: Cloud sync can get stuck and prevent SteamVR from launching. I recommend d
If you've installed Steam in a non-standard location, change the variable on the top of the script. If you've installed Steam in a non-standard location, change the variable on the top of the script.
To use the script, simply launch it from a terminal. It will ask for sudo password in case your SteamVR has been freshly installed or updated and it needs to `setcap` the compositor. To use the script, simply launch it from a terminal. It will ask for sudo password in case your SteamVR has been freshly installed or updated and it needs to `setcap` the compositor.
ALVR-only: If you get a SteamVR error after this, Ctrl-C the script, open ALVR dashboard and launch SteamVR from there once. You then don't have to open ALVR until there's a SteamVR update. ALVR-only: If you get a SteamVR error after this, Ctrl-C the script, open ALVR dashboard and launch SteamVR from there once. You then don't have to open ALVR until there's a SteamVR update.

View file

@ -11,7 +11,7 @@ It supports a vast variety of desktop environments, and comes with a fully custo
There are currently two editions of WlxOverlay. There are currently two editions of WlxOverlay.
## WlxOverlay-S ## WlxOverlay-S
- [WlxOverlay-S GitHub repository](https://github.com/galister/wlx-overlay-s) - [WlxOverlay-S GitHub repository](https://github.com/galister/wlx-overlay-s)
@ -25,12 +25,12 @@ The S edition supports both Monado and SteamVR, and avoids many of the pitfalls
- [Getting Started Wiki](https://github.com/galister/WlxOverlay/wiki/Getting-Started) - [Getting Started Wiki](https://github.com/galister/WlxOverlay/wiki/Getting-Started)
- [Troubleshooting Wiki](https://github.com/galister/WlxOverlay/wiki/Troubleshooting) - [Troubleshooting Wiki](https://github.com/galister/WlxOverlay/wiki/Troubleshooting)
WlxOverlay Classic is recommended if WlxOverlay-S is not working for you. WlxOverlay Classic is recommended if WlxOverlay-S is not working for you.
It works well once you get it working, but the lengthy troubleshooting page speaks for itself. It works well once you get it working, but the lengthy troubleshooting page speaks for itself.
It is prone to run into issues with NVidia's EGL driver, as well as GLFW specifically. It is prone to run into issues with NVidia's EGL driver, as well as GLFW specifically.
## Support ## Support
Reach out in the `wlxoverlay` room in Discord or Matrix. Reach out in the `wlxoverlay` room in Discord or Matrix.

View file

@ -93,7 +93,7 @@ For tundra tracker:
In which you replace `LHR-SERIAL` with your own serial number that you got from previous steps. In which you replace `LHR-SERIAL` with your own serial number that you got from previous steps.
`"steamvr"` section should be merged with yours and will allow to activate both lighthouse and monado driver (while monado being primary display). `"steamvr"` section should be merged with yours and will allow to activate both lighthouse and monado driver (while monado being primary display).
Be careful with commas in JSON: trailing commas are not allowed but commas are required between entries. If your JSON is invalid, SteamVR will reset it. It's also a good idea to keep backups. Be careful with commas in JSON: trailing commas are not allowed but commas are required between entries. If your JSON is invalid, SteamVR will reset it. It's also a good idea to keep backups.

View file

@ -24,7 +24,7 @@ First, take a look at this page from [the official VRChat docs](https://creators
1. Install **2022.3.6f1** (the current supported Unity version, at the time of writing) by running `xdg-open unityhub://2022.3.6f1/b9e6e7e9fa2d`. 1. Install **2022.3.6f1** (the current supported Unity version, at the time of writing) by running `xdg-open unityhub://2022.3.6f1/b9e6e7e9fa2d`.
1. When prompted, select *Android Build Support* and *Windows Build Support (Mono)*. 1. When prompted, select *Android Build Support* and *Windows Build Support (Mono)*.
1. Create a new project with the **3D Core template**, making sure to name it and give it a better location than `$HOME`. 1. Create a new project with the **3D Core template**, making sure to name it and give it a better location than `$HOME`.
1. It may open windows partially offscreen. If this happens, see the 1. It may open windows partially offscreen. If this happens, see the
1. Close the Unity project (will probably crash later if you don't, no big deal but still). 1. Close the Unity project (will probably crash later if you don't, no big deal but still).
1. Open terminal and `cd` to the project dir. 1. Open terminal and `cd` to the project dir.
1. Run either `vrc-get install com.vrchat.avatars` or `vrc-get install com.vrchat.worlds` depending on what you will be making. 1. Run either `vrc-get install com.vrchat.avatars` or `vrc-get install com.vrchat.worlds` depending on what you will be making.

9
test_trailing_spaces.sh Executable file
View file

@ -0,0 +1,9 @@
#!/bin/bash
TRAILING_SPACES=$(find content -name '*.md' -exec grep -EHn ' +$' {} \;)
if [[ -n "$TRAILING_SPACES" ]]; then
echo "Error: these files have trailing spaces!"
echo "$TRAILING_SPACES"
exit 1
fi