beatleader/beatsaber-web-replays

Beat Saber web replay viewer

Beat Saber Web Replays

Web-based viewer for Beat Saber replays, built with A-Frame and JavaScript.

CLICK TO VIEW

Community

• BeatLeader Discord

The Beat Saber Web Replays is an unofficial community project and not officially affiliated with Beat Saber.

Usage

Go to the BeatLeader and click on dancing pepe icon in the leaderboard.

Or if you have a site, you can I-Frame the viewer and pass a query parameter containing the BeatLeader's score ID:

https://replay.beatleader.xyz/?scoreId=9280912

To directly link to a sought time, use the ?time parameter in the URL (milliseconds, int, 0 to song duration):

https://replay.beatleader.xyz/?scoreId=9280912&time=15000 - 15 sec

To specify replay speed use the ?speed parameter in the URL (percent, int, 0 to 200):

https://replay.beatleader.xyz/?scoreId=9280912&speed=50 - 50% speed

To specify notes jump distance use the ?jd parameter in the URL (meters, float, 5 to 50):

https://replay.beatleader.xyz/?scoreId=9280912&jd=18.6 - 18.6 JD

To specify replay download link use the ?link parameter in the URL. Make sure the link(name of the file) contains playerID:

https://replay.beatleader.xyz/?link=https://cdn.replays.beatleader.xyz/9280912-76561198059961776-ExpertPlus-Standard-13400F5FB2FD19F52E8C7AC48815D12E72FA3B4A.bsor

Development

Download repository. The best way to download it is to use the "Clone" button in SourceTree app

Go to the project directory in the terminal and type.

npm install

If you don't have NodeJS - download it here first: https://nodejs.org/en/
Version 16 or greater (LTS) is recommended; some developers have experienced issues with older Node versions.

Starting local build

Install netlify-cli(one time setup):

npm install netlify-cli -g

Start Netlify dev environment(every time):

netlify dev

Navigate to localhost:9999. You should see the app running. Website will reload automatically after you save your changes.

Contributing

• Create a fork ("Fork" button on top) or ask me in Discord to add you to this repository as a developer if you plan to contribute often.
• Create work branch ("nsgolova/lightImprovements" for example). You can push to the master in your fork, but not in the main repository.
• Commit and push your changes.
• Open a pull request. Netlify will deploy a stage website for your fork and you can test it out.
• Your pull request would be merged and changes will deploy to the website!

A-Frame build (optional)

This project uses a custom A-Frame fork: https://github.com/nsgolova/ngoframe It's prebuilt and can be found in the \vendor folder.

To build it

npm install
npm run dist

Copy files from \dist folder of A-Frame to \vendor folder here.

Replay Format

Uses Open Replay Format

Building and running in production mode

By default, Netlify builds the app after every change to this branch in the repository, so all you need is push to git.

Roadmap

• Settings UI improvement
• A-Frame update to the latest version
• Custom saber support

beatsaber-web-replays's Issues

[Question/Suggestion] Why use annoying "click" hitsounds?

First of all, why does it use the (arguably very annoying and distracting) click sound as a hitsound by defsult, rather thsn the real one from the game? Is it to avoid copyright/licensing issues (does Beat Studios and/or Oculus own that sound?) and, if so, is there a guide for how to extract the official sound from the game files? If there aren't any legal issues surrounding this, then consider this entire GitHub Issue a suggestion instead: to either use the offical sound by default, or to add a checkbox or button to select that.

[Suggestion] Option to turn off Environment for the replays

I thought of this while using one of my computers that isn't really powerful as it lagged pretty badly on the replays. But a toggle to disable the environment except for the UI and PlayerPlace would be pretty useful.

[Bug] Replays currently not working

Hi, I recently noticed that (seemingly) no replays are working correctly. The notes, sabers and headset are not moving.

In the javascript console, I see these errors:

I have tried it in Chrome, Firefox and Edge, but all have this issue.

Could this be fixed? I'd really appreciate it! I really like the web replays.

Replay Frozen On Some Plays

When i load up the replay from the website or straight up from the files on the quest, some plays are frozen.
sabers and blocks dont move
lights and song still play and work

[Suggestion] Add Custom Bad Cut/Bomb Sounds

I know recently the hitsounds got yeeted with custom ones with the Osu! ones being used by default. I'm wondering if there could be an implementation for bad cut sounds.