Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BSManager wiki for actual release #729

Merged
merged 130 commits into from
Jan 5, 2025
Merged
Show file tree
Hide file tree
Changes from 119 commits
Commits
Show all changes
130 commits
Select commit Hold shift + click to select a range
4b4bdbb
Update Home.md
GaetanGrd Nov 20, 2024
a4fef9f
Update Home.md
GaetanGrd Nov 20, 2024
9ed769d
move files
GaetanGrd Nov 20, 2024
7f0f273
update home.md and add mardownlint.json
GaetanGrd Nov 20, 2024
7662f93
add Troubleshooting section
GaetanGrd Nov 20, 2024
b555318
Add new pages
GaetanGrd Nov 20, 2024
3d721d9
try anything
GaetanGrd Nov 20, 2024
3dd254a
Update installation guide and home page links; add video placeholder
GaetanGrd Nov 20, 2024
b297593
Recreate the "How to install or import a version" guide with updated …
GaetanGrd Nov 20, 2024
b0a4a27
Fix link format for "Install or import a version" in Home.md
GaetanGrd Nov 20, 2024
7e85387
Update markdownlint configuration and enhance installation guide with…
GaetanGrd Nov 20, 2024
f5d48ea
Fix link format for "Install or import a version" in Home.md
GaetanGrd Nov 20, 2024
2232222
Fix link format for "Install or import a version" in Home.md
GaetanGrd Nov 20, 2024
276c5bf
Fix link format for "Install or import a version" in Home.md
GaetanGrd Nov 20, 2024
c91c1ca
Reorganize and enhance installation guide with detailed instructions …
GaetanGrd Nov 20, 2024
e4fdf8f
Add images for Steam and Oculus Store installation steps in the guide
GaetanGrd Nov 20, 2024
418fc7e
try path
GaetanGrd Nov 29, 2024
d322178
Add links for wiki development and contribution in Home.md
GaetanGrd Nov 29, 2024
95a9571
add strategy: init
GaetanGrd Nov 29, 2024
e6071c7
test path
GaetanGrd Nov 29, 2024
3a4672f
Merge branch 'master' of https://github.com/GaetanGrd/bs-manager
GaetanGrd Nov 29, 2024
556477a
Fix image path in installation guide for correct display
GaetanGrd Nov 29, 2024
4d16b21
Fix image path in installation guide for correct display
GaetanGrd Nov 29, 2024
6c868bf
test
GaetanGrd Nov 29, 2024
7f4fe63
test
GaetanGrd Nov 29, 2024
6e4a796
prout
GaetanGrd Nov 29, 2024
0033b89
teest
GaetanGrd Nov 29, 2024
6d83096
grd
GaetanGrd Nov 29, 2024
e8118e8
hft
GaetanGrd Nov 29, 2024
29689ce
Update installation guide and restructure documentation
GaetanGrd Nov 29, 2024
f0f0512
Update installation guide to use HTML tags for images and videos
GaetanGrd Nov 29, 2024
7d80cc5
Fix image paths and update video embed in installation guide
GaetanGrd Nov 30, 2024
362912b
Update installation guide to replace video embed with a placeholder f…
GaetanGrd Nov 30, 2024
d030108
Disable MD033 rule in markdownlint configuration
GaetanGrd Nov 30, 2024
93906f8
Update installation guide to include links for BSManager and improve …
GaetanGrd Nov 30, 2024
71ab4b5
Update Home.md to add links for shortcuts, tokens, maps, mods, and co…
GaetanGrd Nov 30, 2024
0c87bfd
remove useless video
GaetanGrd Nov 30, 2024
1e12f7e
Update installation guide to replace video placeholder with actual vi…
GaetanGrd Nov 30, 2024
a2df9d3
Update Home.md to include links to BSManager for improved navigation
GaetanGrd Nov 30, 2024
08be619
Add installation guide for creating shortcuts on Windows and Steam
GaetanGrd Nov 30, 2024
d9318b6
Add placeholder text to troubleshooting section in Home.md
GaetanGrd Nov 30, 2024
d44f9f9
Remove placeholder text from troubleshooting section in Home.md
GaetanGrd Nov 30, 2024
c7722df
Refactor Home.md to remove unnecessary links and improve readability
GaetanGrd Nov 30, 2024
4636f46
Recreate Create-a-shortcut.md with detailed instructions for Windows …
GaetanGrd Nov 30, 2024
4dece59
Fix formatting of version link in Create-a-shortcut.md for clarity
GaetanGrd Nov 30, 2024
5771aed
Refactor Oculus token guidance: update link format and consolidate in…
GaetanGrd Nov 30, 2024
488da1c
Add blank line for improved readability in Get-your-Oculus-token.md
GaetanGrd Nov 30, 2024
fadf087
Update img to get token
GaetanGrd Nov 30, 2024
b128de6
Update instructions in Get-your-Oculus-token.md: correct 'Playload' t…
GaetanGrd Nov 30, 2024
2561a34
Mark uncreated links as strikethrough in Home.md for clarity
GaetanGrd Nov 30, 2024
98fba32
Correct 'Playload' tab reference to 'Payload' in Get-your-Oculus-toke…
GaetanGrd Nov 30, 2024
a2e2136
Normalize link casing for uncreated links in Home.md
GaetanGrd Nov 30, 2024
80863df
Enhance Get-your-Oculus-token.md with links to BSManager and clarify …
GaetanGrd Nov 30, 2024
01c7e54
Enhance Install-any-maps.md with detailed installation steps for BSMa…
GaetanGrd Nov 30, 2024
5a87d91
Update headings in installation guides from 'Summary' to '## Summary'…
GaetanGrd Nov 30, 2024
2c166e9
Add installation guide for custom playlists and restore link in Home.md
GaetanGrd Dec 1, 2024
4d42dfb
Add installation guide for mods and update links in Home.md
GaetanGrd Dec 1, 2024
cb4666e
Fix formatting in Install-mods-on-your-version.md by updating step nu…
GaetanGrd Dec 1, 2024
575d9c2
Update note heading in installation guide for mods to improve clarity
GaetanGrd Dec 1, 2024
989c317
Refactor headings in Home.md for improved clarity and consistency
GaetanGrd Dec 1, 2024
99d3f6d
Refactor section headings in Home.md for improved readability and str…
GaetanGrd Dec 1, 2024
23ec61e
Refactor section headings in Home.md for consistency and clarity
GaetanGrd Dec 1, 2024
941b10a
Fix formatting in Home.md by removing unnecessary line break in Login…
GaetanGrd Dec 1, 2024
ad03a50
Update links in installation guide for mods to use internal anchors f…
GaetanGrd Dec 1, 2024
547054a
Update version link reference in Create-a-shortcut.md for improved na…
GaetanGrd Dec 1, 2024
c48c08d
Add detailed guide for modifying models in Beat Saber and restore lin…
GaetanGrd Dec 1, 2024
44b6979
Update section headings from "Summary" to "Table of content" for cons…
GaetanGrd Dec 1, 2024
faf8431
Fix code formatting in Create-a-shortcut.md for improved readability
GaetanGrd Dec 1, 2024
d615efb
Disable MD023 rule in markdownlint configuration for improved linting…
GaetanGrd Dec 1, 2024
5654f65
Update Home.md with active links and add Help us to update the wiki g…
GaetanGrd Dec 1, 2024
250b41c
Update Discord server link in Home.md for direct access
GaetanGrd Dec 1, 2024
513dba8
Add detailed instructions for finding logs in new How-to-find-your-lo…
GaetanGrd Dec 1, 2024
52f3bbb
Fix link in Home.md for Help us to update the wiki section
GaetanGrd Dec 1, 2024
2f87222
Add detailed instructions for finding logs in new How-to-find-your-lo…
GaetanGrd Dec 1, 2024
5824166
Grammar and spelling fixes
GaetanGrd Jan 4, 2025
5926a72
Fix formatting and capitalization in installation guides for consistency
GaetanGrd Jan 4, 2025
3463a63
test
GaetanGrd Jan 4, 2025
4dff8f5
Improve formatting and consistency in Modify-models-in-your-beat-sabe…
GaetanGrd Jan 4, 2025
03cacc7
Fix formatting and capitalization in installation guide for consistency
GaetanGrd Jan 4, 2025
d7e1e0d
Fix punctuation in installation guide for clarity
GaetanGrd Jan 4, 2025
9984780
Fix formatting in Modify-models-in-your-beat-saber.md for consistency
GaetanGrd Jan 4, 2025
b61d540
Fix formatting in help-us-update-the-wiki.md for consistency
GaetanGrd Jan 4, 2025
3f2147b
Fix formatting and capitalization in Create-a-shortcut.md for consist…
GaetanGrd Jan 4, 2025
f92b621
Fix formatting and capitalization in Install-or-import-a-version.md f…
GaetanGrd Jan 4, 2025
7b1ae37
Fix formatting and punctuation in Get-your-Oculus-token.md for consis…
GaetanGrd Jan 4, 2025
6949622
Fix formatting and capitalization in How-to-find-your-logs.md for con…
GaetanGrd Jan 4, 2025
025d6f8
Add troubleshooting guide for keyboard shortcut conflicts with AMD So…
GaetanGrd Jan 4, 2025
67f1027
Fix formatting and capitalization in multiple documentation files for…
GaetanGrd Jan 4, 2025
9cfcf28
Replace caution and important emojis with warning and note callouts f…
GaetanGrd Jan 4, 2025
379e7cf
test
GaetanGrd Jan 4, 2025
b8fb178
test
GaetanGrd Jan 4, 2025
62abe32
Remove unnecessary detail tags and improve the structure of the insta…
GaetanGrd Jan 4, 2025
7ea75bd
Update links in README and modal component for consistency in token r…
GaetanGrd Jan 4, 2025
6708071
Merge branch 'master' of https://github.com/Zagrios/bs-manager into Z…
GaetanGrd Jan 4, 2025
79693e2
Merge branch 'Zagrios-master'
GaetanGrd Jan 4, 2025
6beb675
Add Oculus sideloading activation guide and restructure documentation
GaetanGrd Jan 4, 2025
97fbeb0
test
GaetanGrd Jan 4, 2025
5a4df35
Update installation guide headings for consistency and clarity
GaetanGrd Jan 4, 2025
b12e90a
Enhance installation guide by updating section headings for improved …
GaetanGrd Jan 4, 2025
149e6bb
Refactor installation guide to improve heading structure and consistency
GaetanGrd Jan 4, 2025
b0c2a7c
Add table of contents and restructure installation guide for clarity
GaetanGrd Jan 4, 2025
4d90102
Update installation guide to improve heading structure and consistency
GaetanGrd Jan 4, 2025
c8ec5db
Add warning about login information and clarify use of DepotDownloade…
GaetanGrd Jan 4, 2025
1f07c35
Remove unnecessary line breaks in installation guide for improved rea…
GaetanGrd Jan 4, 2025
32d6043
Add missing line breaks in installation guide for improved readability
GaetanGrd Jan 4, 2025
7815e35
Update installation guide to improve heading hierarchy and consistency
GaetanGrd Jan 4, 2025
f0b7294
Update installation guide to improve heading level for Arch (AUR) sec…
GaetanGrd Jan 4, 2025
88f8dc7
Remove outdated installation guide for importing versions
GaetanGrd Jan 4, 2025
bc220e6
Add troubleshooting guides for Linux installation issues
GaetanGrd Jan 4, 2025
b20f632
Update installation problems section to enhance Linux heading formatting
GaetanGrd Jan 4, 2025
c76e585
Refactor installation problems section to improve heading formatting …
GaetanGrd Jan 4, 2025
6345e91
Capitalize heading for Linux installation guide in Home.md
GaetanGrd Jan 4, 2025
6c4acec
Remove troubleshooting section for Linux installation guide
GaetanGrd Jan 4, 2025
87a7e08
Update image paths in Linux missing icons and Oculus sideloading trou…
GaetanGrd Jan 4, 2025
661a908
Fix image path for Linux missing icons troubleshooting guide
GaetanGrd Jan 4, 2025
ba26f3a
Recreate and restore the installation guide for importing versions of…
GaetanGrd Jan 4, 2025
4f58df6
Fix video source path in installation guide for importing versions
GaetanGrd Jan 4, 2025
ed4b395
Update video source path in installation guide for importing versions
GaetanGrd Jan 4, 2025
38ef619
Remove video elements from shortcut creation and version import guides
GaetanGrd Jan 4, 2025
8ac1683
delete useless file
GaetanGrd Jan 4, 2025
ea04073
fix nexusmods links
GaetanGrd Jan 4, 2025
74ed168
Reorder "Activate Oculus Sideloading" link in Home.md for better visi…
GaetanGrd Jan 4, 2025
1f02551
Add browser methode to get oculus token
GaetanGrd Jan 4, 2025
c69b110
Fix image alt text in Oculus token guide for clarity
GaetanGrd Jan 4, 2025
1985f5e
Merge pull request #2 from Zagrios/master
GaetanGrd Jan 4, 2025
4381bb4
Add markdownlint extension to VSCode recommendations
GaetanGrd Jan 5, 2025
ec8b411
Correct capitalization in Linux installation instructions and error g…
GaetanGrd Jan 5, 2025
14a7f5f
restore orignal name and original link for How-to-obtain-your-Oculus-…
GaetanGrd Jan 5, 2025
023f8d3
Add sidebar navigation and troubleshooting sections to the wiki
GaetanGrd Jan 5, 2025
80c5557
fix forget element to restore orignal name for oculus token page
GaetanGrd Jan 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ jobs:
- uses: Andrew-Chen-Wang/github-wiki-action@v4
with:
path: docs/wiki/
strategy: init
Zagrios marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 8 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
GaetanGrd marked this conversation as resolved.
Show resolved Hide resolved
"MD007": { "indent": 4 },
"MD013": false,
"MD041": false,
"MD024": false,
"MD033": false,
"MD023": false
}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@
<div>
<ul>
<li><strong>via Oculus</strong>: For Oculus users, <a href="https://github.com/Zagrios/bs-manager">BSManager</a>
requires you to retrieve a connection token by following the instructions in this guide: <a href="https://github.com/Zagrios/bs-manager/wiki/How-to-obtain-your-Oculus-Token">How to obtain your Oculus Token</a>. Once obtained, please insert it into the form.</li>
requires you to retrieve a connection token by following the instructions in this guide: <a href="https://github.com/Zagrios/bs-manager/wiki/get-your-oculus-token">How to obtain your Oculus Token</a>. Once obtained, please insert it into the form.</li>
GaetanGrd marked this conversation as resolved.
Show resolved Hide resolved
</ul>
</div>

Expand Down
GaetanGrd marked this conversation as resolved.
Show resolved Hide resolved

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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=images), 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.
Original file line number Diff line number Diff line change
@@ -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=images), 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.
Zagrios marked this conversation as resolved.
Show resolved Hide resolved

> [!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.
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -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=images), or the [official website](https://www.bsmanager.io).
GaetanGrd marked this conversation as resolved.
Show resolved Hide resolved
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=images), 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](Get-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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
Loading
Loading