Merge branch 'master' into patch-1

2026-07-03 14:08:25 +02:00 · 2025-01-03 16:14:52 +01:00
parent 8766809fb8 a424651f9d
commit 7c185b9d2c
137 changed files with 5278 additions and 2765 deletions
@@ -0,0 +1,11 @@
+Enabling Oculus sideloading allows games located outside if your Oculus library to be played on your Oculus Quest.
+
+- **Step 1:** Start the regedit application by pressing `Win + R` and typing `regedit` in the dialog box.
+- **Step 2:** Navigate to `HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Oculus VR, LLC\Oculus`.
+- **Step 3:** Right-click on the right panel and select `New > DWORD (32-bit) Value`.
+- **Step 4:** Name the new value `AllowDevSideloaded` and set the value to `1`.
+
+You should end up with something like this:
+![image](https://raw.githubusercontent.com/Zagrios/bs-manager/refs/heads/master/docs/assets/enable-oculus-sideloading.png)
+
+After completing these steps, you should be able to start Beat Saber from BSManager and play it on your Oculus Quest. If you are still having issues, please join our [Discord](https://discord.gg/uSqbHVpKdV) server for further assistance.
@@ -0,0 +1,121 @@
+# Linux Guide
+
+## Installation
+
+Go to [Releases](https://github.com/Zagrios/bs-manager/releases) page and go to the latest alpha release (version 1.5.0-alpha.5 or higher). Download the necessary build installer for your distro (see below).
+
+### Ubuntu, Debian (deb)
+
+#### PPA Repository
+
+Refer to [bs-manager-deb](https://github.com/silentrald/bs-manager-deb).
+
+Add the BSManager PPA repository into your system with the following commands.
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/silentrald/bs-manager-deb/refs/heads/main/KEY.gpg | sudo gpg --dearmor -o /usr/share/keyrings/bs-manager.gpg
+echo "deb [signed-by=/usr/share/keyrings/bs-manager.gpg] https://raw.githubusercontent.com/silentrald/bs-manager-deb/refs/heads/main ./" | sudo tee /etc/apt/sources.list.d/bs-manager.list
+sudo apt update
+```
+
+Install the `bs-manager` package using `apt`.
+```bash
+sudo apt install bs-manager
+```
+
+#### dpkg install
+
+Download the `.deb` file in the releases and run the following command:
+```bash
+dpkg -i ./bsmanager.deb
+```
+
+**NOTE:** When installed using dpkg, BSManager will not automatically update to the latest version. You have to either:
+* Download the latest `.deb` file on the Releases page; or
+* Install thru PPA repository to automatically update with `sudo apt update & sudo apt upgrade`.
+
+### Arch (AUR)
+
+Refer to [bs-manager-git](https://aur.archlinux.org/packages/bs-manager-git).
+
+To install AUR packages, you need to install [yay](https://github.com/Jguer/yay).
+
+### Universal (flatpak)
+
+This should work on any linux distribution. You are only required to have `flatpak` installed in your system. If it is not installed, then go to [flatpak](https://flatpak.org/setup/) to look for a guide on how to install it on your distro.
+
+After installing, download the `.flatpak` file in the releases and run the following command:
+
+```bash
+flatpak install --user ./bsmanager.flatpak
+```
+
+If you are getting errors like packages not existing, run the command below so that it finds the correct packages.
+
+```bash
+sudo flatpak remote-add --if-not-exists --system flathub https://flathub.org/repo/flathub.flatpakrepo
+
+# or
+
+flatpak remote-add --if-not-exists --user flathub https://flathub.org/repo/flathub.flatpakrepo
+```
+
+Flatpak also supports sandboxing which gives the minimal access to your machine. To configure this, you can download [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal) which has a GUI to edit your permissions. You can also this with the `flatpak` executable but it will not be discussed here.
+
+## Proton Setup
+
+[Proton](https://github.com/ValveSoftware/Proton) is needed to run the Beat Saber executable under Linux. You need to download this from either from Steam or building it from their GitHub repo.
+
+Once Proton is installed, when you open your BSManager application for the first time, it will ask you to link the _Proton Folder_. The _Proton Folder_ also verifies if the `proton` and `files/bin/wine64` binaries exists. Once set, you should be able to launch the Beat Saber (using `proton`) and install mods (using `files/bin/wine64`). You can still change the _Proton Folder_ in the **settings page** if any new version of Steam Proton is downloaded.
+
+# Troubleshooting
+
+## Missing Icons in game
+
+<p align="center">
+    <img src="../assets/linux-missing-icons.png" alt="Linux Missing Icons" width="300"/>
+    <br>
+    NOTE: "?" are missing unicode icons
+</p>
+
+This is due to [BSML](https://github.com/monkeymanboy/BeatSaberMarkupLanguage) using a missing font (`Segoe UI Symbols`) for unicode emojis.
+
+To fix the issue, you need to get a copy of `seguisym.ttf` from the fonts folder an official copy Windows. Once you have a copy, add the font file to `~/.steam/steam/steamapps/compatdata/620980/pfx/drive_c/windows/Fonts`.
+
+## Permission denied on "bs-versions.json"
+
+<pre>
+Unhandled Exception UnhandledRejection Error: EACCES: permission denied, open '/opt/BSManager/resources/assets/jsons/bs-versions.json'
+</pre>
+
+To fix this issue, the current user must have write permissions to the "bs-versions.json". To correct the permissions do command below:
+
+```bash
+chmod +002 /opt/BSManager/resources/assets/jsons/bs-versions.json
+
+# or
+
+chown $(whoami) /opt/BSManager/resources/assets/jsons/bs-versions.json
+```
+
+## [deb] The SUID sandbox helper binary was found.
+
+This is encountered when running the app file or executing the app in the terminal. This is due to a change to Ubuntu 24.04. In order to fix the issue, take a look into the path of "chrome-sandbox" described in the error log and give the correct permissions within the terminal, for example:
+
+```bash
+chmod 4755 /opt/BSManager/chrome-sandbox
+```
+
+ref: https://github.com/electron/electron/issues/42510
+
+## [Flatpak] Steam Beat Saber version not showing / Proton not detected
+
+Flatpak should have permissions with the steam games folder. By default, the minimum permissions are `~/.steam/steam/steamapps/common:ro` and `~/.steam/steam/steamapps/common:ro`. If you changed the steam installation path, add that path instead into the permissions.
+
+## [Flatpak] Changing installation folder
+
+To change the installation path of the **BSManager** folder, you have to edit the flatpak permissions to destination folder.
+- In flatpak or Flatseal, add the destination folder with `:create` permissions.
+- In BSM, move the folder to the destination folder.
+- [Optional] In flatpak or Flatseal, remove the original folder permissions.
+