acc-is-sponge / beat-speedrun-mod

A Beat Saber Plugin that provides local leaderboard UI and score aggregator for speedrunning!
Other
3 stars 1 forks source link

Beat Speedrun MOD

Beat Speedrun is a Beat Saber MOD that provides Leaderboard UI and score aggregator. Its primary usage is for simulating speedrunning under the scoring system like ScoreSaber, but it can also be used to see the daily play record.

How to speedrun

1. Install this MOD

See Releases for download link, supported versions, and dependencies.

2. Select the regulation ant the target segment on the BEAT SPEEDRUN tab

3. Press START!

Your can see your speedrun progress (current pp, time, segment, and top/recent scores) on the leaderboard tab (press > to navigate).

Your speedrun will continue even after exiting the app. The timer stops when the target segment is successfully achieved, or the time expires (set at 48 hours in the scoresaber regulation).

How this works

Beat Speedrun does not communicate with the leaderboard system (e.g. ScoreSaber) at all. It calculates and displays pp based on its own regulations. Regulation definitions are maintained in the beat-speedrun-regulations repository and are updated regularly.

In additions to regulations, a set of difficulty rating for each map is defined as a map set. Map set definitions are maintained in the beat-speedrun-mapsets repository, which is also regularly updated.

By default, this MOD fetches the current, up-to-date regulations from these repositories and lists them on the BEAT SPEEDRUN tab.

How to use custom regulations

Use custom regulation files

Put your regulation files into $(BeatSaberDir)/UserData/BeatSpeedrun/CustomRegulations/

Use online custom regulations

Add URIs to RegulationUris in $(BeatSaberDir)/UserData/BeatSpeedrun.json

Credits