Skip to content

Commit 74c2d17

Browse files
committed
[docs] added linux documentation
1 parent 4ec19f6 commit 74c2d17

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

docs/wiki/Linux.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Linux Guide
2+
3+
## Installation
4+
5+
Go to [Releases](https://github.com/Zagrios/bs-manager/releases) page and go to the latest release. Download the necessary build installer for your distro (see below).
6+
7+
### Ubuntu, Debian
8+
9+
Install the `.deb` build and run the following command:
10+
```bash
11+
apt install bsmanager.deb
12+
```
13+
14+
### CentOS, Fedora
15+
16+
Install the `.rpm` build and run the following command:
17+
```bash
18+
rpm -i bsmanager.rpm
19+
```
20+
21+
### Arch, Manjaro
22+
23+
Install the `.pacman` build and run the following command:
24+
```bash
25+
pacman -U bsmanager.pacman
26+
```
27+
28+
## Proton Setup
29+
30+
[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.
31+
32+
Once Proton is installed, when you open your BSManager application for the first time, it will ask you to link the _Proton Folder_ so that it can access the `proton` binary inside it. This will also check if the folder you've selected is valid or not. You can also change this in the future by going to the **settings page** and search for the _Proton Folder_.
33+
34+
## Wine Install [Optional]
35+
36+
[Wine](https://www.winehq.org/) is a tool to run windows application under Linux. BSManager uses to run [BSIPA](https://nike4613.github.io/BeatSaber-IPA-Reloaded/) so that you can play Beat Saber with mods. You can install `wine` depending on your package manager. If you don't install it, this will just fallback to using the `wine` executable found in your _Proton Folder_.
37+
38+
# Troubleshooting
39+
40+
## Permission denied on "bs-version.json"
41+
42+
<pre>
43+
Unhandled Exception UnhandledRejection Error: EACCES: permission denied, open '/opt/BSManager/resources/assets/jsons/bs-versions.json'
44+
</pre>
45+
46+
To fix this issue, the current user must have write permissions to the "bs-versions.json". To correct the permissions do command below:
47+
48+
```bash
49+
chmod +002 /opt/BSManager/resources/assets/jsons/bs-versions.json
50+
51+
# or
52+
53+
chown $(whoami) /opt/BSManager/resources/assets/jsons/bs-versions.json
54+
```
55+

0 commit comments

Comments
 (0)