diff --git a/README.md b/README.md index 118e37b..e2a46df 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file +## 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.