BeatSaber-version-changer/doc/setup.md

[Readme.md](../README.md)

# Setup

## Contains
![./img/contains.png](./img/contains.png)

## Run for the first time

If you running the `BeatSaber-Versions.exe` you have to run it with admin rights, cause the normal user is unable to create symbolic links. 

>This is the window if you doesn't run it as admin, you can close the window or press `reopen as Admin`. This will restart the programm as Admin.
>
>![./img/running_as_nonAdmin.png](./img/running_as_nonAdmin.png)

The first thing you will see is, that there is already a `1.21.0` in the list. This is the default one in the freshly generated configuration file. 

![./img/firstView.png](./img/firstView.png)

To setup the normal BeatSaber folders you hit the `Set BeatSaber Folder` button at the top left. Then a new window will open. There you can set the normal BS folder or let the programm detect itsef where BS is installed. (This is only working if Steam is installed on C:\\ drive)

![./img/setBeatSaberFolders1.png](./img/setBeatSaberFolders1.png)

I also recommend to relocate your custom songs folder to use the songs in every version of BS. This cleans up some space that you don't have your song lib multiple times on your drive. 

![](img/setBeatSaberFolders2.png)

## Adding your current version of BeatSaber to it

Currently is the newest version of BeatSaber the `1.22.0` therfore rename the BeatSaber folder to `Beat Saber-1.22.0` on your harddrive. After that edit the values `Name`, `Version` and `Folder`. With the `Set Folder` button you can set the Folder over a dialog window.

![](img/setupYourBeatSaberVersion.png)
![](img/setupYourBeatSaberVersion2.png)

After the editing hit "Save" and all will be written in your `config.yaml` file.

![](img/setupYourBeatSaberVersion3.png)

Then if you wanna select your BeatSaber version hit `Play Selected` then the programm will create a symbolic link in your `steamapps` folder with the name `Beat Saber` and will link it to your version folder. If you don't have a custom songs folder or removed it from your `Beat Saber_Data` folder, it will ask if you wanna create a symbolic link to your secified song folder under `Set BeatSaber Folder` which you may have previusly set. 

![](img/setupYourBeatSaberVersion4.png)

After all that you are good to go, play BeatSaber or change versions if you have another on your drive. 

## Preventing your BeatSaber version from updates

To completly prevent your custom BeatSaber from updates, I recommend to create one version which is normally set as symbolic link, this is the version steam will update. The second one is your custom one, only set this version if you wanna play BeatSaber.