Skip to content

Commit 4bb49e4

Browse files
committed
Update README.md
1 parent f3cc102 commit 4bb49e4

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@ This is a custom app for the Spotify desktop client (with Spicetify installed).
2323

2424
[spicetify-beat-saber-backend](https://github.com/kuba2k2/spicetify-beat-saber-backend) is required to bookmark maps on BeastSaber (due to CORS issues) and to download maps to Beat Saber directory. After installing, the backend can be configured in the popup menu in bottom-right corner of the Spotify client.
2525

26-
Refer to the backend's README for instructions on how to configure everything.
27-
2826
## Installation
2927

28+
**NOTE:** [install spicetify-beat-saber-backend](https://github.com/kuba2k2/spicetify-beat-saber-backend) first.
29+
30+
After installing the extension, you only need to set the Beat Saber game path to use the downloading feature. Refer to `Configuration` below.
31+
3032
### Modern clients (v1.2.x+)
3133

3234
**Make sure you're using Spicetify v2.20.0 or newer**
@@ -56,6 +58,17 @@ A custom [fork of Spicetify](https://github.com/kuba2k2/spicetify-legacy) is nee
5658
8. `spicetify apply`
5759
9. The app should now be available in your Spotify client.
5860

61+
## Configuration
62+
63+
A few configuration options are available in the Beat Saber popup window (bottom-right of the Spotify window):
64+
- BeastSaber login data - required to use the bookmarking feature
65+
- `Username` is your BeastSaber public profile name (as in https://bsaber.com/members/profile-name-goes-here/)
66+
- `Login` is your e-mail address or login name that allows to login to BeastSaber
67+
- `Password` is pretty self-explanatory
68+
- backend access info - required to use either bookmarking or downloading
69+
- `Hostname` - leave the default, which is `localhost:23287`
70+
- `Beat Saber directory` is the path to the Beat Saber game directory (i.e. the one with `Beat Saber.exe` in it, NOT `CustomLevels`)
71+
5972
## License
6073

6174
MIT

0 commit comments

Comments
 (0)