Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
rithik-b committed Nov 2, 2021
1 parent 3aac796 commit 591a4ff
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,23 @@ An ingame leaderboard for Hitbloq. To learn more about Hitbloq, visit [https://h
## Features
- View leaderboards for Hitbloq ranked maps
- Switch between pools
- Open the playlist of the selected pool (requires PlaylistManager)
- Automatically refresh your score after setting a new PB
- View profiles of other users
- Add other users to your friends list for score comparison
- Automatically register for a Hitbloq account if one does not exist
- View event information ingame

Trailer: https://youtu.be/wG4_4I9-4yA

## Download
Download the latest version of the mod (v1.0.0) [here](https://github.com/PauseChampions/Hitbloq/releases/tag/1.0.0 "here").
Download the latest version of the mod (v1.1.0) [here](https://github.com/PauseChampions/Hitbloq/releases/tag/1.0.0 "here").

**ScoreSaber**, **BeatSaberMarkupLanguage (BSML)** and **SiraUtil** are required for this mod, so please download the latest version from ModAssistant.
**LeaderboardCore** (bundled in zip) is also required so make sure you extract the zip properly.
**Beat Saber 1.18.0+** is required.

**Note**:
- Manual registration for hitbloq is required at this time. Visit https://hitbloq.com/add_user to sign up if you haven't!
- The leaderboard will only appear for hitbloq ranked maps. Select a hitbloq map and click the arrow to the right of ScoreSaber to use it.
**Note**: The leaderboard will only appear for hitbloq ranked maps. Select a hitbloq map and click the arrow to the right of ScoreSaber to use it.

## Issues and Support
If you encounter any issues with this mod, DM me on Discord PixelBoom#0001 or file an Issue on GitHub and I'll fix it as soon as I can For support with the mod, DM me or ask a question on the #mod-support channel on the [Hitbloq Discord](https://discord.com/invite/pxWwtWJ)
Expand Down

0 comments on commit 591a4ff

Please sign in to comment.