BeatSaber_SongDetails

A C# library which provides access to the ScoreSaber and BeatSaver information of all Songs using a cached local database which is provided by Andruzzzhka, thanks a lot!

Can be used Standalone or as a BeatSaber Library. Aims to be highly optimized by allocating as little reference types as possible and passing value types by reference wherever possible.

Requires Protobuf.

Usage

Everything is exposed in the SongDetailsCache.SongDetails class.

To use this library you aquire an Instance of the SongDetails class by calling SongDetails.Init() and awaiting the result. This will handle possibly downloading / parsing the database if it is not cached in memory yet, otherwise it will reuse what is already there.

The downloaded Databases get cached for a while, by default they are stored in "Environment.CurrentDirectory/UserData" - You can override the Folder to store them in using SongDetails.SetCacheDirectory(string path). Keep in mind this is a global override.

1. songs => Custom, readonly array of all songs. Has exposed methods for finding songs based off their Map ID or Hash
2. difficulties => Custom, readonly array of all difficulties of all songs. Due to how this library is built you should ideally not access <Song>.difficulties for iteration purposes but instead iterate over difficulties and access <SongDifficulty>.song. Alternatively you can use the exposed convenience methods of SongDetails like FindSongs to find all Songs based off certain difficulty criteria.

While not advised, you can use Linq to filter through these two arrays.

There are also two statically available events on SongDetailsContainer, dataAvailableOrUpdated and dataLoadFailed

WHENEVER dataAvailableOrUpdated IS CALLED YOU SHOULD INVALIDATE ANY REFERENCE YOU HAVE TO ANY SongDetails STRUCT (You can keep using the same SongDetails instance). Almost all properties are resolved dynamically using indexes and the order of items is very likely to change after the dataset is updated.

Available information

Songs

• General Information
  • Bpm
  • Song Duration (Seconds)
  • Song Hash
  • Song Name
  • Song Author
  • Level Author
• BeatSaver Information
  • Map ID (Numeric and Hexadecimal)
  • Uploader name
  • Song cover URL
  • Download Count (While Exposed - BeatSaver does not really track this at the moment)
  • Upvotes
  • Downvotes
  • Rating
  • Upload timestamp
• Ranked Information (ScoreSaber & BeatLeader)
  • If any of the diffs are ranked or qualified
  • Unix Timestamp of when the Ranked state changed (Combined)

Song Difficulties

• General Information
  • Njs
  • Bombs / Notes / Obstacles count
  • Characteristic
  • Mods (Noodle Extensions / Mapping Extensions / Chroma / Cinema)
• Ranked Information (ScoreSaber & BeatLeader)
  • Star rating (0 if not ranked)