beatsaber-playlist-tool/README.md

49 lines
888 B
Markdown
Raw Normal View History

# playlist helper
2024-07-01 17:40:51 +00:00
## Usage
```sh
pipx install pleb-saberlist
player_scores_by_stars
leaderboard_songs_by_stars
2024-07-01 17:40:51 +00:00
```
### Example
```sh
Enter the playerid (Default: 76561199407393962):
Enter the minimum starlevel to include on the playlist (Default: 5): 6
Enter the maximum starlevel to include on the playlist (Default: 7.0):
Enter the filename for the playlist (Default: Replay SS 6.0★):
```
Creates a playlist called `Replay SS 6.0★.bplist`
## Development
Clone the repo and install dependencies into a local virtual environment:
```bash
pip install --upgrade pip
pip install --editable .
```
## Resources
* [Beatleader API](https://beatleader.xyz/developer)
* [ScoreSaber API](https://docs.scoresaber.com/)
## Tips
Count results
```shell
jq '.songs | length' < playlist.bplist
```
Avoid printing covers in console.
```shell
jq 'del(.image)' < playlist.bplist
```