Merge pull request #729 from GaetanGrd/master

Update BSManager wiki for actual release
2026-07-03 14:08:25 +02:00 · 2025-01-05 21:52:38 +01:00
parent a148ddaee2 80c555711f
commit c7d6bc54e4
35 changed files with 652 additions and 141 deletions
@@ -18,3 +18,4 @@ jobs:
      - uses: Andrew-Chen-Wang/github-wiki-action@v4
        with:
          path: docs/wiki/
+          strategy: init
@@ -0,0 +1,8 @@
+{
+    "MD007": { "indent": 4 },
+    "MD013": false,
+    "MD041": false,
+    "MD024": false,
+    "MD033": false,
+    "MD023": false
+}
@@ -1,3 +1,7 @@
 {
-    "recommendations": ["dbaeumer.vscode-eslint", "EditorConfig.EditorConfig"]
+    "recommendations": [
+        "dbaeumer.vscode-eslint",
+        "EditorConfig.EditorConfig",
+        "davidanson.vscode-markdownlint"
+    ]
 }
@@ -1,21 +0,0 @@
-If you encounter a keyboard shortcut conflict between AMD Software and Oculus Rift, you can either disable or modify the conflicting shortcut.
-
-_Special thanks to_ `𝔽𝕪𝕟𝕟 (fynn07)` _for its contribution with information and screenshots_
-### __Follow these steps to disable the shortcut in AMD Software:__
-# Step 1 - Access Settings:
- Open AMD Software and click on the gear icon in the top right corner to go to settings.
-
-![image](https://github.com/Zagrios/bs-manager/assets/40648115/2762f59c-f12a-46ba-80fa-9bf79beb64a9)
-# Step 2 - Modify Keyboard Shortcuts:
-  In the settings menu, select the "Hotkey" tab.
-
-![image](https://github.com/Zagrios/bs-manager/assets/40648115/262d4fcc-529f-4c4c-9b87-e2da21df1b95)
-# Step 3 -Disabling Shortcuts:
- Turn off the "Use Hotkeys" option to prevent any conflicts with Oculus Rift.
-
-![image](https://github.com/Zagrios/bs-manager/assets/40648115/756018ad-7de3-469c-9f40-0082be007805)
-# Step 3 alt - Modify the Shortcut:
- If you prefer to keep using keyboard shortcuts, consider changing the specific conflicting shortcut (e.g., "Ctrl + Shift + I") to another combination that is less likely to interfere.
-
-ℹ️ _**Keep in mind you can't change the full keybind!**_
-_**You can only Change the "i" to an different Button!**_ ℹ️
@@ -0,0 +1,28 @@
+## Table of Contents
+
+- [With BSManager](#with-bsmanager)
+- [Manual Installation](#manual-installation)
+- [One-Click Installation](#one-click-installation)
+
+## With BSManager
+
+(Coming with version 1.5.0)
+
+## Manual Installation
+
+1. Download your preferred custom playlists from trusted sources. Ensure that they are in __`.bplist`__ format.
+2. Open [BSManager](https://www.bsmanager.io) and select the version of Beat Saber in which you want to install the playlist.
+3. Click on the version options at the top-right corner of the BSM interface, then select __`Open Folder`__.
+4. In the folder for the Beat Saber version, locate the __`Playlists`__ folder. If this folder doesn't exist, create it.
+5. Copy and paste the downloaded __`.bplist`__ files of your custom playlists into this folder.
+6. Launch the game with BSM, navigate to your playlist, click on it, and download it.
+
+> [!WARNING]  
+> Exercise caution when downloading custom playlists for Beat Saber. Only use reliable sources to avoid any risks to your computer.
+
+## One-Click Installation
+
+1. Launch [BSManager](https://www.bsmanager.io) and make sure that the One-Click installation feature is enabled for playlists.
+2. Go to one of the supported websites and search for the playlist you want to install.
+3. Once you've found the playlist, click on the __`One-Click`__ or __`Install`__ button on the website.
+4. A pop-up window will appear, asking for confirmation. Click on __`Yes`__ to proceed with the installation.
@@ -0,0 +1,32 @@
+## Table of Contents
+
+- [With BSManager](#with-bsmanager)
+- [Manual Installation](#manual-installation)
+- [One-Click Installation](#one-click-installation)
+
+## With BSManager
+
+1. Download and install [BSManager](https://www.bsmanager.io) from [GitHub](https://github.com/Zagrios/bs-manager/releases/latest).
+2. Launch [BSManager](https://www.bsmanager.io) and select the Beat Saber version where you want to install maps from the list on the left of the interface.
+3. Go to maps by clicking on the __`Maps`__ tab.
+4. Click on the __`Add`__ button to access the list of online maps.
+5. Find the maps that you want to install from the provided list. You can use the search bar at the top of the interface to filter maps by __`name`__, __`type`__, __`mods`__, __`tags`__, __`notes per second`__, __`duration`__, and order the list by __`latest`__, __`relevance`__, __`rating`__, or __`curated`__.
+6. Double-click on the map or simply click on the download button to install the map.
+7. Wait for the installation to complete. Once it's finished, you can launch Beat Saber directly from [BSManager](https://www.bsmanager.io) to enjoy your new maps!
+
+## Manual Installation
+
+1. Find the map you want to install on a site like [BeatSaver](https://beatsaver.com).
+2. Download the map to your computer.
+3. Open [BSManager](https://www.bsmanager.io) and select the version of Beat Saber to which you want to install the map.
+4. Click on the version options at the top-right corner of the interface, then select __`Open Folder`__.
+5. Move the downloaded map `.zip` file into the __`CustomLevels`__ folder, which is located at `Beat Saber_Data\CustomLevels`.
+6. Right-click the `.zip` file, select __`Extract All`__, then press __`Extract`__ in the popup. You can then delete the `.zip` file.
+7. Launch Beat Saber, and the map should now be available to play.
+
+## One-Click Installation
+
+1. Launch [BSManager](https://www.bsmanager.io) and make sure that the One-Click installation feature is enabled for maps.
+2. Go to one of the supported websites and search for the map you want to install.
+3. Once you've found the map, click on the __`One-Click`__ or __`Install`__ button on the website.
+4. A pop-up window will appear, asking for confirmation. Click on __`Yes`__ to proceed with the installation.
@@ -0,0 +1,30 @@
+> [!WARNING]  
+>
+> __The models require mods to work properly! Don’t forget to download them!__
+>
+> - For custom sabers, use [CustomSabersLite](https://github.com/qqrz997/CustomSabersLite) or an equivalent mod.
+> - For custom avatars, use [Custom Avatars](https://github.com/nicoco007/BeatSaberCustomAvatars) or an equivalent mod.
+> - For custom blocks, use [Custom Notes](https://github.com/legoandmars/BeatSaberCustomNotes) or an equivalent mod.
+> - For custom platforms, use [Custom Platforms](https://github.com/affederaffe/CustomPlatforms) or an equivalent mod.
+
+## Table of Contents
+
+- [With BSManager](#with-bsmanager)
+- [One-Click Installation](#one-click-installation)
+
+# With BSManager
+
+1. Download and install [BSManager](https://www.bsmanager.io) from [GitHub](https://github.com/Zagrios/bs-manager/releases/latest), [Nexus Mods](https://www.nexusmods.com/beatsaber/mods/18?tab=files), or [Website](https://www.bsmanager.io).
+2. Launch [BSManager](https://www.bsmanager.io) and select the Beat Saber version where you want to install models from the list on the left of the interface.
+3. Go to models by clicking on the __`Models`__ tab.
+4. Click on the __`Add`__ button to access the list of online models.
+5. Find the models that you want to install from the provided list. You can use the search bar at the top of the interface to filter models by __`name`__, __`type`__, and order the list by __`date`__, __`name`__, or __`author`__.
+6. Double-click on the model or simply click on the download button to install the model.
+7. Wait for the installation to complete. Once it's finished, you can launch Beat Saber directly from [BSManager](https://www.bsmanager.io) to enjoy your new models!
+
+# One-Click Installation
+
+1. Launch [BSManager](https://www.bsmanager.io) and make sure that the One-Click installation feature is enabled for models.
+2. Go to one of the supported websites and search for the models you want to install.
+3. Once you've found the models, click on the __`One-Click`__ or __`Install`__ button on the website.
+4. A pop-up window will appear, asking for confirmation. Click on __`Yes`__ to proceed with the installation.
@@ -0,0 +1,38 @@
+## Table of Contents
+
+- [With BSManager](#with-bsmanager)
+- [Manual Installation](#manual-installation)
+
+## With BSManager
+
+1. Download and install [BSManager](https://www.bsmanager.io) from [GitHub](https://github.com/Zagrios/bs-manager/releases/latest), [Nexus Mods](https://www.nexusmods.com/beatsaber/mods/18?tab=files), or the [official website](https://www.bsmanager.io).
+2. Launch [BSManager](https://www.bsmanager.io) and select the version of Beat Saber that you want to use from the list on the left side of the interface.
+3. Go to mods by clicking on the __`Mods`__ tab.
+4. Find the mods that you want to install from the provided list. You can use the search bar at the top of the interface to filter mods by name.
+5. Check the box next to the name of each mod that you want to install.
+6. Click __`Install or Update`__ at the bottom-right corner of the interface.
+7. Wait for the installation to complete. Once it's finished, you can launch Beat Saber directly from [BSManager](https://www.bsmanager.io) to enjoy your new mods!
+
+## Manual Installation
+
+> [!IMPORTANT]
+> This guide assumes your game already has core mods installed
+>
+> If it doesn't: open [BSManager](https://www.bsmanager.io), select the game version you want to mod, go to the Mods tab, and click __`Install or Update`__. Then, run your game once, go to the main menu, and close it. ℹ️*
+
+1. Open [BSManager](https://www.bsmanager.io) and select the version of Beat Saber you want to install the mod to.
+2. Click on the version options button at the top-right corner, then select __`Open Folder`__.
+3. Download the desired mod from a trusted source, often found on community GitHub repositories. Search for the mod's name followed by "GitHub" in your search engine.
+4. Installing Different Types of Mods:
+    - __For mods that come as a single `.dll` file:__ If the mod consists of a single __`.dll`__ file, copy this file into the __`Plugins`__ folder in the directory you opened in step 2.
+
+        > [!NOTE]
+        >
+        > Do __not__ place files in __`Beat Saber_Data\Plugins`__. If you do not see a __`Plugins`__ folder directly in the folder you opened in step 2, make sure you have core mods installed and have run your game at least once after installing mods.
+
+    - __For mods that come as a `.zip` file:__ If the mod includes multiple files or folders, you need to maintain the provided folder structure. Double-click the zip file to open it, press __`CTRL+A`__ and then __`CTRL+C`__ to copy all files/folders inside the zip, go to the directory you opened in step 2, and press __`CTRL+V`__ to paste them there. Do __not__ paste them in any subfolder, such as __`Plugins`__ or __`Beat Saber_Data`__. If you are prompted to merge folders or overwrite files, click "Yes."
+
+5. The mod should now be installed. Run Beat Saber to check if the mod functions correctly. If it doesn't, double-check that you:
+    - Have all required dependencies installed. These are typically listed somewhere on the mod's release page.
+    - Placed the mod in the correct install folder.
+    - Downloaded a mod intended for your game version.
@@ -0,0 +1,58 @@
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Prerequisites](#prerequisites)
+- [Steps to Contribute](#steps-to-contribute)
+    - [1. Create a Fork on GitHub](#1-create-a-fork-on-github)
+    - [2. Clone Your Fork](#2-clone-your-fork)
+    - [3. Make Your Changes](#3-make-your-changes)
+    - [4. Submit a Pull Request](#4-submit-a-pull-request)
+
+## Introduction
+
+Thank you for your interest in improving the wiki! This guide will help you through the process of contributing, whether you’re adding new pages, fixing errors, or enhancing existing content.
+
+## Prerequisites
+
+Before contributing, make sure you have:
+
+1. A GitHub account.
+2. Basic knowledge of Markdown.
+
+## Steps to Contribute
+
+### 1. Create a Fork on GitHub
+
+To contribute, start by creating a fork of the repository:
+
+1. Go to the [GitHub page of the repository](https://github.com/Zagrios/bs-manager).
+2. Click on the __`Fork`__ button in the top-right corner of the page.
+3. Once the fork is created, it will appear under your GitHub account.
+
+### 2. Clone Your Fork
+
+Now, clone your fork to your local machine for editing:
+
+```bash
+git clone https://github.com/[your-username]/[repository-name].git
+cd [repository-name]
+```
+
+### 3. Make Your Changes
+
+Make edits, add new pages, or update content as needed. Then commit and push your changes to your fork:
+
+```bash
+git add .
+git commit -m "Describe your changes here"
+git push origin master
+```
+
+### 4. Submit a Pull Request
+
+Once your changes are ready:
+
+1. Go to the __[original repository](https://github.com/Zagrios/bs-manager)__ on GitHub.
+2. Click the __`Pull Requests`__ tab, then __`New Pull Request`__.
+3. Compare changes between your fork and the original repository.
+4. Add a clear description of your changes and submit the pull request.
@@ -0,0 +1,55 @@
+## Table of Contents
+
+- [How to create a shortcut on Windows](#how-to-create-a-shortcut-on-windows)
+    - [On desktop](#on-desktop)
+    - [On taskbar](#on-taskbar)
+- [How to create a shortcut on Steam](#how-to-create-a-shortcut-on-steam)
+
+## How to create a shortcut on Windows
+
+### On Desktop
+
+1. Launch [BSManager](https://www.bsmanager.io) and select your version.
+2. Click on the gear icon at the top-right corner of the version.
+3. Click on the __`Create a Shortcut`__ button.
+4. Choose your launch options.
+5. Click on __`Create a Shortcut`__. It should now appear on your desktop.
+
+### On Taskbar
+
+1. Open Notepad and drag & drop the version shortcut you need.
+2. Grab the version link (e.g., `bsmanager://launch/?version=1.34.2&versionIno=19140298416807704`) - More info [here](#how-to-create-a-shortcut-on-steam).
+3. Open a new Notepad window and type the following:
+
+```bat
+@echo off
+start <version link>
+```
+
+4. Save the file with a `.bat` extension.
+5. Create a shortcut to this `.bat` file. Edit the shortcut path to: `cmd.exe /C <shortcut path>`.
+
+## How to create a shortcut on Steam
+
+1. In [BSManager](https://www.bsmanager.io), select the version you want to open in Steam from the list on the left side.
+2. Click the gear icon at the top-right corner and select __`Create a Shortcut`__. This will create a shortcut on your desktop for launching the game.
+3. Open Notepad (or any other text editor) and drag & drop the shortcut file into the text editor. You will see a string of text similar to this:
+
+    ```yaml
+    bsmanager://launch/?version=1.29.1&versionIno=3940649674381032
+    ```
+
+4. Copy this text and remove any spaces.
+
+    <div align="center">
+        <img src="../wiki/Guides/Installation-and-updates/Create-a-shortcut/SeeTxtFile.png" alt="SeeTxtFile.png" />
+    </div>
+
+5. Open Steam and add [BSManager](https://www.bsmanager.io) as a non-Steam game.
+6. In your Steam library, right-click on [BSManager](https://www.bsmanager.io), select __`Properties`__, and add the link from step 4 as a launch parameter.
+7. Disable "Desktop Game Theatre" and scroll down to enable "Include in VR Library" so you can launch it from your VR headset.
+8. Rename this entry to whatever you want and customize the name and the icon of the shortcut if desired.
+
+<div align="center">
+    <img src="../wiki/Guides/Installation-and-updates/Create-a-shortcut/SteamShortcut.png" alt="SteamShortcut.png" />
+</div>
@@ -0,0 +1,53 @@
+> [!WARNING]  
+>
+> [BSManager](https://www.bsmanager.io) does not store your login information. It uses the open-source tool [`DepotDownloader`](https://github.com/SteamRE/DepotDownloader) to download versions of Beat Saber.
+
+## Table of Contents
+
+- [Install a Version with Steam](#install-a-version-with-steam)
+- [Install a Version with Oculus Store (PCVR)](#install-a-version-with-oculus-store-pcvr)
+- [Import a Version](#how-to-import-a-version)
+
+## Install a Version with Steam
+
+1. Download and install [BSManager](https://www.bsmanager.io) from [GitHub](https://github.com/Zagrios/bs-manager/releases/latest), [Nexus Mods](https://www.nexusmods.com/beatsaber/mods/18?tab=files), or the [official website](https://www.bsmanager.io).
+2. Open the __`Add Versions`__ interface and select the version you wish to download.
+3. Choose __`Steam`__ as your platform.
+4. Enter your Steam credentials (ID and password) or scan the QR code using the Steam app on your phone.
+5. Once logged into Steam, the download will start automatically. Please wait for it to complete.
+6. When the download is finished, select the downloaded version and click the __`Launch`__ button to verify that the game launches correctly.
+
+<div align="center">
+    <img src="../wiki/Guides/Installation-and-updates/Install-or-import-a-version/SteamLogin.png" alt="SteamLogin.png" />
+</div>
+
+## Install a Version with Oculus Store (PCVR)
+
+> [!IMPORTANT]  
+>
+> - Ensure that Beat Saber is in your __Oculus PCVR__ library to enable downgrading.
+> - You must run Beat Saber at least once on your computer before attempting to launch retrograde Oculus versions from [BSManager](https://www.bsmanager.io).
+
+1. Download and install [BSManager](https://www.bsmanager.io) from [GitHub](https://github.com/Zagrios/bs-manager/releases/latest), [Nexus Mods](https://www.nexusmods.com/beatsaber/mods/18?tab=files), or the [official website](https://www.bsmanager.io).
+2. Open the __`Add Versions`__ interface and select the version you wish to download.
+3. Choose __`Oculus Store`__ as your platform.
+4. Follow [this guide](How-to-obtain-your-Oculus-Token) to obtain your Oculus token.
+5. Once logged into Oculus, the download will start automatically. Please wait for it to complete.
+6. When the download is finished, select the downloaded version and click the __`Launch`__ button to verify that the game launches correctly.
+
+<div align="center">
+    <img src="../wiki/Guides/Installation-and-updates/Install-or-import-a-version/OculusLogin.png" alt="OculusLogin.png" />
+</div>
+
+## How to Import a Version
+
+> [!IMPORTANT]  
+>
+> - You will need to download a version of Beat Saber yourself before you can import it.
+> - The [BSManager](https://www.bsmanager.io) team provides tutorials like [this one](https://steamcommunity.com/sharedfiles/filedetails/?id=1805934840) to help you download official versions of Beat Saber. However, no team member will offer assistance for cracked versions.
+
+1. Launch [BSManager](https://www.bsmanager.io).
+2. Click the gear icon in the top-right corner of the interface.
+3. Select the __`Import a Version`__ option.
+4. Choose the file containing the version to be imported.
+5. Wait a few moments. The imported version should appear alongside the others in the version list.
@@ -1,4 +1,12 @@
-# Linux Guide
+## Table of Contents
+
+- [Installation](#installation)
+    - [Ubuntu, Debian (deb)](#ubuntu-debian-deb)
+        - [PPA Repository](#ppa-repository)
+        - [dpkg Install](#dpkg-install)
+    - [Arch (AUR)](#arch-aur)
+    - [Universal (flatpak)](#universal-flatpak)
+- [Proton Setup](#proton-setup)

 ## Installation

@@ -19,6 +27,7 @@ sudo apt update
 ```

 Install the `bs-manager` package using `apt`.
+
 ```bash
 sudo apt install bs-manager
 ```
@@ -26,13 +35,15 @@ 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`.
+
+- 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)

@@ -67,55 +78,3 @@ Flatpak also supports sandboxing which gives the minimal access to your machine.
 [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.
-
@@ -0,0 +1,61 @@
+> [!WARNING]  
+>
+> Your token is a confidential piece of information. Possession of this token allows individuals to download applications, send messages, among other actions, under your identity.
+>
+>However, you might wonder why it is necessary to provide this token to BSManager. The reason is that BSManager requires the token to continue the download with Oculus. Once you've input the token, it is used exclusively to communicate with Oculus servers to verify that you are the rightful owner of the game.
+
+## Table of Contents
+
+- [Step 1 - Install and log into the Oculus Rift app](#step-1---install-and-log-into-the-oculus-rift-app)
+- [Step 2 - Open developer tools](#step-2---open-developer-tools)
+- [Step 3 - Copy your Token](#step-3---copy-your-token)
+
+# Solution 1 - Using the Oculus app
+
+## Step 1 - Install and log into the Oculus Rift app
+
+1. Download the Oculus Rift app setup from the [Meta website](https://www.oculus.com/rift/setup/).
+2. Install the Oculus Rift app on your computer.
+
+> [!NOTE]  
+>__If you bought Beat Saber from the Quest store, it won't appear in your Rift library by default. To download it with [BSManager](https://www.bsmanager.io), first claim it from its store page.__
+
+## Step 2 - Open developer tools
+
+1. Open the Oculus app.
+2. Open the developer tools by pressing `Ctrl` + `Shift` + `i`.
+
+## Step 3 - Copy your Token
+
+In the developer tools:
+
+1. Open the __`Network`__ tab.
+2. Filter for __`graph`__.
+3. Click on the first request that appears.
+4. Open the __`Payload`__ tab.
+5. Scroll to the bottom to locate your token. It should start with __`FRL`__.
+6. Select the token using your mouse and press `Ctrl` + `C` to copy it.
+
+<div align="center">
+    <img src="../wiki/Guides/Login/How-to-obtain-your-Oculus-Token/GetYourOculusToken.png" alt="GetYourOculusToken.png" />
+</div>
+
+# Solution 2 - Using the Oculus website
+
+## Steps
+
+1. Log in to your Meta account at https://secure.oculus.com 
+2. Open the developer tools in your web browser:
+   - Chrome/Edge/Firefox: Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> or <kbd>F12</kbd>
+   - Safari: Press <kbd>Option</kbd>+<kbd>Command</kbd>+<kbd>I</kbd>
+3. Go to the "Application" tab
+4. Expand "Cookies" in the left sidebar 
+5. Click on `https://secure.oculus.com`
+6. Find the cookie named `oc_ac_at` (value starts with `OC`)
+7. Copy the entire `oc_ac_at` cookie value - this is your token
+
+<div align="center">
+    <img src="../wiki/Guides/Login/How-to-obtain-your-Oculus-Token/GetYourOculusTokenBrowser.png" alt="GetYourOculusTokenBrowser.png" />
+</div>
+
+Paste the token into BSManager or other trusted apps to manage your Beat Saber game and mods. Keep it confidential.
@@ -1,14 +1,73 @@
-Welcome to the bs-manager wiki! (wip c:)
+# Welcome to the BSManager Wiki

-to get you oculus token check here : https://github.com/Zagrios/bs-manager/wiki/How-to-obtain-your-Oculus-Token
+BSManager is your all-in-one tool designed to simplify and enhance your Beat Saber experience. With BSManager, you can effortlessly manage game versions, mods, maps, and more, ensuring a seamless and enjoyable gameplay journey.

---
+## 📚 Guides

-This Wiki accepts contributions!
+Our comprehensive guides are crafted to assist you in maximizing BSManager's capabilities:

-To contribute to the wiki:
+### 🛠️ Installation and Updates

- Fork the project
- Add/Edit `.md` files in the `docs/wiki/` folder
- Create a Pull Request
- Once the PR is merged (after review), it will be present in the repository's wiki
+Step-by-step instructions to install BSManager on your system and keep it up to date
+
+- [Install BSManager on Linux](install-bsmanager-on-linux)
+- [Install or import a version](install-or-import-a-version)
+- [Create a shortcut](create-a-shortcut)
+
+### 🔑 Login
+
+Guidance on logging into BSManager to access all features
+
+- [How to obtain your Oculus Token](How-to-obtain-your-Oculus-Token)
+
+### 🎮 Content Management
+
+- __🗺️ Maps__: Learn how to download and organize custom maps for endless entertainment.
+    - [Install any map](install-any-map)
+    - [Install all playlists you want](install-all-playlists-you-want)
+- __🧩 Mods__: Discover how to install, update, and manage mods to enhance your gameplay.
+    - [Install mods on your version](install-mods-on-your-version)
+- __🖼️ Models__: Find out how to integrate custom models into your Beat Saber experience.
+    - [Modify models in your Beat Saber](modify-models-in-your-beat-saber)
+
+### 🤝 Contribution
+
+Information on how to contribute to the development and improvement of BSManager
+
+- [Help us update the wiki](help-us-update-the-wiki)
+- [Contribute to the project](https://github.com/Zagrios/bs-manager/blob/master/CONTRIBUTING.md)
+
+## 🐞 Troubleshooting
+
+Our troubleshooting section is here to help you resolve common issues quickly and efficiently:
+
+<!-- ### ⚙️ Connection Issues: Solutions for problems related to connecting BSManager to required services. -->
+
+### 💾 Installation Problems
+
+Guidance on fixing errors during setup or version updates
+
+- __🐧Linux__:
+    - [Missing Icons in Game]([Linux]-Missing-Icons-in-Game)
+    - [Permission Denied on "bs-versions.json"]([Linux]-Permission-Denied-on-bs-version.json)
+    - [[Deb] The SUID Sandbox Helper Binary Was Found]([Linux]-[deb]-The-SUID-Sandbox-Helper-Binary-Was-Found)
+    - [[Flatpak] Steam Beat Saber Version Not Showing / Proton Not Detected]([Linux]-[Flatpak]-Steam-Beat-Saber-Version-Not-Showing-Proton-Not-Detected)
+    - [[Flatpak] Changing Installation Folder]([Linux]-[Flatpak]-Changing-Installation-Folder)
+
+<!-- ### 🎮 Gameplay Issues: Fixes for issues impacting Beat Saber performance. -->
+
+### 🔍 Debugging Tips
+
+Steps to gather logs and identify specific issues
+
+- [Activate Oculus Sideloading](Activate-Oculus-sideloading)
+- [How to find your logs](how-to-find-your-logs)
+- [Submitting a bug report](https://github.com/Zagrios/bs-manager/issues/new?assignees=Zagrios&labels=bug&projects=&template=1-bug-report.yaml&title=%5BBUG%5D+%3A+)
+
+***
+
+We are committed to keeping this wiki up to date with the latest information and best practices. Your contributions are welcome; please refer to our [Help us update the wiki](help-us-update-the-wiki) to get started.
+
+For additional support and community interaction, join our [Discord server](https://discord.gg/uSqbHVpKdV).
+
+Thank you for using BSManager!
@@ -1,50 +0,0 @@
-### Important
-
-Your token is a confidential piece of information. Possession of this token allows individuals to download applications, send messages, among other actions, under your identity.
-
-However, you might wonder why it is necessary to provide this token to BSManager. The reason is that BSManager requires the token to continue the download with Oculus. Once you've input the token, it is used exclusively to communicate with Oculus servers to verify that you are the rightful owner of the game.
-
-# Solution 1 - Using the Oculus app
-
-## Step 1 - Install and log into the Oculus Rift app
- Get the Oculus Rift app setup from the [Meta website](https://www.oculus.com/rift/setup/)
- Install the Oculus Rift app
-
-ℹ️ **If you bought Beat Saber from the Quest store, it won't appear in your Rift library by default. To download it with BSManager, first claim it from its store page** ℹ️ 
-
-## Step 2 - Open developer tools
-
- Open Oculus app
- Open the developer tools by pressing <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>i</kbd>.
-
-## Step 3 - Copy your Token
-In the developer tools : 
- Open the `Network` tab
- Filter for `graph`
- Click on the first request
- Open the `Payload` tab
- Locate your token, it should start with `FRL`
- Select the token using your mouse and press <kbd>Ctrl</kbd> + <kbd>c</kbd> to copy it
-
-![image](https://raw.githubusercontent.com/Zagrios/bs-manager/refs/heads/master/docs/assets/oculus-token.png)
-
-# Solution 2 - Using the Oculus website
-
-## Steps
-
-1. Log in to your Meta account at https://secure.oculus.com 
-2. Open the developer tools in your web browser:
-   - Chrome/Edge/Firefox: Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> or <kbd>F12</kbd>
-   - Safari: Press <kbd>Option</kbd>+<kbd>Command</kbd>+<kbd>I</kbd>
-3. Go to the "Application" tab
-4. Expand "Cookies" in the left sidebar 
-5. Click on `https://secure.oculus.com`
-6. Find the cookie named `oc_ac_at` (value starts with `OC`)
-7. Copy the entire `oc_ac_at` cookie value - this is your token
-
-<img width="500" src="https://github.com/user-attachments/assets/8499035c-4e7c-423d-914d-f35b6a3d77af">
-
-Paste the token into BSManager or other trusted apps to manage your Beat Saber game and mods. Keep it confidential.
-
-# Known bugs
- ⁠[Nothing opens when I press `Ctrl`+`Shift`+`i`.](https://github.com/Zagrios/bs-manager/wiki/Nothing-opens-when-I-press-%60Ctrl%60%E2%80%90%60Shift%60%E2%80%90%60i%60.)
@@ -1,4 +0,0 @@
-If nothing opens when you press `Ctrl` + `Shift` + `I`, it's possible that the keyboard shortcut to open the development tools is being used by another application. 
-
-Here's a non-exhaustive list of applications that have caused a problem and their suggested solutions:
-  ⁠[AMD software](https://github.com/Zagrios/bs-manager/wiki/AMD-Sofware-%E2%80%90-Nothing-opens-when-I-press-%60Ctrl%60%E2%80%90%60Shift%60%E2%80%90%60I%60)
@@ -6,6 +6,9 @@ Enabling Oculus sideloading allows games located outside if your Oculus library
 - **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)
+
+<div align="center">
+    <img src="../wiki/Troubleshoots/Debugging-tips/Activate-Oculus-sideloading/enable-oculus-sideloading.png" alt="enable-oculus-sideloading.png" />
+</div>

 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,37 @@
+## Summary
+
+- [BSManager Log Files](#bsmanager-log-files)
+- [Beat Saber (BSIPA) Log Files](#beat-saber-bsipa-log-files)
+- [Player.log (Unity) Log File](#playerlog-unity-log-file)
+
+## BSManager Log Files
+
+1. Launch BSManager and go to __Settings__.
+2. Scroll to the bottom of the page.
+3. Click on the __`Open Logs`__ button.
+4. Right-click on the log file to be sent and select __`Copy`__.
+    > [!NOTE]  
+    > The requested file is usually the most recent log file, located at the bottom of the list.
+5. __`Paste`__ your file in the channel where log files are requested.
+
+<div align="center">
+    <img src="../wiki/Troubleshoots/Debugging-tips/How-to-find-your-logs/BSMLogs.png" alt="BSMLogs.png" />
+</div>
+
+## Beat Saber (BSIPA) Log Files
+
+1. Launch BSManager and select the version with which you are experiencing the problem.
+2. Click the version options button at the top-right corner of the interface, then select __`Open Folder`__.
+3. Double-click the __`Logs`__ folder to open it.
+4. Right-click the log file named __`_latest.log`__ (or just __`_latest`__) and select __`Copy`__.
+    > [!NOTE]  
+    > This file will usually be at the top of the list.
+5. __`Paste`__ the file in the channel where log files are requested using __`Ctrl+V`__.
+
+## Player.log (Unity) Log File
+
+1. Press __`Win+R`__ simultaneously on your keyboard.
+2. Type or copy-paste the following path into the window that pops up, then press __Enter__:  
+   `%appdata%\..\LocalLow\Hyperbolic Magnetism\Beat Saber`
+3. Right-click the log file named __`Player.log`__ (or just __`Player`__) and select __`Copy`__.
+4. __`Paste`__ the file in the channel where log files are requested using __`Ctrl+V`__.
@@ -0,0 +1,4 @@
+If nothing opens when you press `Ctrl` + `Shift` + `I`, it’s possible that the keyboard shortcut to open the developer tools is being used by another application.
+
+Here’s a non-exhaustive list of applications that may cause this problem and their suggested solutions:
+- [AMD Software](https://github.com/Zagrios/bs-manager/wiki/AMD-Software-%E2%80%90-Nothing-opens-when-I-press-%60Ctrl%60%E2%80%90%60Shift%60%E2%80%90%60I%60)
@@ -0,0 +1,30 @@
+If you encounter a keyboard shortcut conflict between AMD Software and Oculus Rift, you can either disable or modify the conflicting shortcut.
+
+_Special thanks to_ `𝔽𝕪𝕟𝕟 (fynn07)` _for their contribution with information and screenshots._
+
+### __Follow these steps to disable or modify the shortcut in AMD Software:__
+
+## Step 1 - Access Settings
+
+1. Open AMD Software and click on the gear icon in the top-right corner to access the settings.
+
+![image](https://github.com/Zagrios/bs-manager/assets/40648115/2762f59c-f12a-46ba-80fa-9bf79beb64a9)
+
+## Step 2 - Modify Keyboard Shortcuts
+
+1. In the settings menu, select the __"Hotkey"__ tab.
+
+![image](https://github.com/Zagrios/bs-manager/assets/40648115/262d4fcc-529f-4c4c-9b87-e2da21df1b95)
+
+## Step 3 - Disable Shortcuts
+
+1. Turn off the __"Use Hotkeys"__ option to prevent any conflicts with Oculus Rift.
+
+![image](https://github.com/Zagrios/bs-manager/assets/40648115/756018ad-7de3-469c-9f40-0082be007805)
+
+## Step 3 (Alternative) - Modify the Shortcut
+
+1. If you prefer to keep using keyboard shortcuts, consider changing the specific conflicting shortcut (e.g., __"Ctrl + Shift + I"__) to another combination that is less likely to interfere.
+
+> ℹ️ __Note:__ You can't change the full keybind!  
+> You can only modify the __"I"__ to a different key. ℹ️
@@ -0,0 +1,9 @@
+<p align="center">
+    <img src="../wiki/Troubleshoots/Installation-Problems/Linux/%5BLinux%5D-Missing-Icons-in-Game/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`.
@@ -0,0 +1,13 @@
+<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
+```
@@ -0,0 +1,5 @@
+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.
@@ -0,0 +1 @@
+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.
@@ -0,0 +1,7 @@
+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
@@ -0,0 +1,91 @@
+# 🌐 Navigation
+
+<ul>
+    <li><a href="Home">Home</a></li>
+</ul>
+
+## 📚 Guides
+
+<details>
+    <summary>🛠️ Installation and Updates</summary>
+    <ul>
+        <li><a href="install-bsmanager-on-linux">Install BSManager on Linux</a></li>
+        <li><a href="install-or-import-a-version">Install or Import a Version</a></li>
+        <li><a href="create-a-shortcut">Create a Shortcut</a></li>
+    </ul>
+</details>
+
+<details>
+    <summary>🔑 Login</summary>
+    <ul>
+        <li><a href="How-to-obtain-your-Oculus-Token">How to obtain your Oculus Token</a></li>
+    </ul>
+</details>
+
+<details>
+    <summary>🎮 Content Management</summary>
+    <ul>
+        <li>
+            <details>
+                <summary>🗺️ Maps</summary>
+                <ul>
+                    <li><a href="install-any-map">Install Any Map</a></li>
+                    <li><a href="install-all-playlists-you-want">Install All Playlists You Want</a></li>
+                </ul>
+            </details>
+        </li>
+        <li>
+            <details>
+                <summary>🧩 Mods</summary>
+                <ul>
+                    <li><a href="install-mods-on-your-version">Install Mods on Your Version</a></li>
+                </ul>
+            </details>
+        </li>
+        <li>
+            <details>
+                <summary>🖼️ Models</summary>
+                <ul>
+                    <li><a href="modify-models-in-your-beat-saber">Modify Models in Your Beat Saber</a></li>
+                </ul>
+            </details>
+        </li>
+    </ul>
+</details>
+
+<details>
+    <summary>🤝 Contribution</summary>
+    <ul>
+        <li><a href="help-us-update-the-wiki">Help Us Update the Wiki</a></li>
+        <li><a href="https://github.com/Zagrios/bs-manager/blob/master/CONTRIBUTING.md">Contribute to the Project</a></li>
+    </ul>
+</details>
+
+## 🐞 Troubleshooting
+
+<details>
+    <summary>💾 Installation Problems</summary>
+    <ul>
+        <li>
+            <details>
+            <summary>🐧 Linux</summary>
+                <ul>
+                    <li><a href="[Linux]-Missing-Icons-in-Game">Missing Icons in Game</a></li>
+                    <li><a href="[Linux]-Permission-Denied-on-bs-version.json">Permission Denied on "bs-versions.json"</a></li>
+                    <li><a href="[Linux]-[deb]-The-SUID-Sandbox-Helper-Binary-Was-Found">[Deb] The SUID Sandbox Helper Binary Was Found</a></li>
+                    <li><a href="[Linux]-[Flatpak]-Steam-Beat-Saber-Version-Not-Showing-Proton-Not-Detected">[Flatpak] Steam Beat Saber Version Not Showing / Proton Not Detected</a></li>
+                    <li><a href="[Linux]-[Flatpak]-Changing-Installation-Folder">[Flatpak] Changing Installation Folder</a></li>
+                </ul>
+            </details>
+        </li>
+    </ul>
+</details>
+
+<details>
+    <summary>🔍 Debugging Tips</summary>
+    <ul>
+        <li><a href="Activate-Oculus-sideloading">Activate Oculus Sideloading</a></li>
+        <li><a href="how-to-find-your-logs">How to Find Your Logs</a></li>
+        <li><a href="https://github.com/Zagrios/bs-manager/issues/new?assignees=Zagrios&labels=bug&projects=&template=1-bug-report.yaml&title=%5BBUG%5D+%3A+">Submitting a Bug Report</a></li>
+    </ul>
+</details>
				`@@ -0,0 +1 @@`
				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.