Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
qe201020335 authored Jul 15, 2023
1 parent 174ec15 commit 0181aaf
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

[![release](https://img.shields.io/github/v/release/qe201020335/SongPlayHistory?color=Green&style=for-the-badge)](https://github.com/qe201020335/SongPlayHistory/releases/latest)

Track all your scores. This is a fork of the fork of the currently unmaintained [SongPlayHistory](https://github.com/swift-kim/SongPlayHistory) mod.
Track all your scores and song votes. This is the actively maintained fork of the [fork](https://github.com/Shadnix-was-taken/BeatSaber-SongPlayHistoryContinued) of the currently unmaintained [SongPlayHistory](https://github.com/swift-kim/SongPlayHistory) mod.

![Screenshot](Screenshot.png)

## Features
- Keep detailed track of your plays
- Show how many times you've played a single beatmap
- Visualize your song preferences (πŸ‘/πŸ‘Ž)
- Interop with BeatSaverVoting and DiTails to track your vote
- Visualize your song preferences (πŸ‘/πŸ‘Ž) (if you don't have BeatSaverVoting installed)

## Requirements
- BSIPA
Expand All @@ -23,7 +24,11 @@ Available in [ModAssistant](https://github.com/Assistant/ModAssistant) or on [Be
- Recording play data begins when you first install this plugin. (This doesn't apply to play counts.)
- The data file `SongPlayData.json` is created in Beat Saber's `UserData` directory. You can delete individual records from there if you want.
- The data are not uploaded anywhere so you have to **backup** the file when re-installing the game.
- If you run into any problem, please contact me either via Discord _(Search me in the BSMG discord server)_ or by open an issue.
- If you run into any problems, please contact me either via Discord _(Search me in the BSMG discord server)_ or by open an issue.

## For Modders
- To access the vote data, use `Zenject` and inject `IVoteTracker`.
- `IVoteTracker` is installed into `PCAppInit`, using `SiraUtil`'s `Location.App`.

## Credits
- [swift-kim](https://github.com/swift-kim)
Expand Down

0 comments on commit 0181aaf

Please sign in to comment.