deadcade/beatsaber-ntfy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
deadcade 2024-12-13 13:58:47 +01:00
parent 4d122f7114
commit 6f9e7a5a02
1 changed files with 21 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,3 +1,23 @@
# beatsaber-ntfy
A bash script to post ScoreSaber/BeatLeader statistics changes to a ntfy.sh server.
A bash script to push notifications to a ntfy.sh server on beatsaber leaderboard changes
## How to use
- You need `jq`, `curl`, and `bc` installed.
- Set the `SCORESABER_DIR` and `BEATLEADER_DIR` variables at the top of `beatsaber-ntfy.sh` to a persistent directory (or `mkdir ./{scoresaber,beatleader}-players`)
- Create a file for each profile you want to track, named as the ID of the player
- Run the script
## Example player file
The following file located at `./scoresaber-players/2169974796454690`:
```
NTFY_URL=https://ntfy.sh/my-beatsaber-profile
COUNTRY_THRESHOLD=1
RANK_THRESHOLD=1
PP_THRESHOLD=0.01
```
Will configure the script to post updates about ScoreSaber user `2169974796454690` to `https://ntfy.sh/my-beatsaber-profile`.
The `COUNTRY_THRESHOLD`, `RANK_THRESHOLD`, and `PP_THRESHOLD` variables indicate by how much these values need to change before sending a notification.
The IDs that each platform is able to use differs, you can find them in the URL of your profile.
For example, `https://scoresaber.com/u/2169974796454690` or `https://beatleader.xyz/u/bytesy` both lead to Bytesy's profile, but only BeatLeader accepts the vanity ID.