motzel / replay-analyzer

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Beat Leader Replay Analyzer

Notice

The project is in early stage. I didn't plan to release it in this state, but currently I don't have free time to work on it. However, I believe that even in its current state, it may prove useful to someone.

About

Beat Leader mod saves a replay of every map played on the local disk, including those that were no better than PB and failed ones and were not sent to the BL server for that reason. This program allows you to analyze them. In addition, if it is run during a BS session, it automatically renames the replays, so they are not overwritten (by default, BL overwrites replays so that only the most recent replay of each map is stored locally) and you can analyze each of your attempts.

Below you will find some screenshots if you're curious if it's even worth installing.

System requirements

The program requires Microsoft WebView2 installed. It is installed by default in Windows 11 and in Windows 10 updated to the latest version. If you have problems running it download and install WebView2 from Microsoft website.

Installation

Download the latest version from Releases page and copy it to the <Beat Saber installation dir>\UserData\BeatLeader. If BS is installed in the default location it is: C:\Program Files (x86)\Steam\steamapps\common\Beat Saber\UserData\BeatLeader

Known bugs

  • The map list is not automatically refreshed in the production build when a new replay appears. A restart of the program is required.
  • UI, especially with large window sizes

Planned features

If I can find the time for it at all 😉

  • Beat Leader web replays integration
  • the ability to set a directory containing replays so that the program does not have to be installed in a specific location
  • grouping and filtering of maps
  • downloading replays of other players from the BL server for analysis
  • BL API integration (?)
  • more stats (everyone loves them, right? ;-)

If you have any suggestions then please submit them via Issues. If I find time to work on the project I will certainly consider them.

PRs are, of course, very welcome 😁

Screenshots

Maps view

Map view

Map Acc Chart

Hit Acc Chart

Detailed note cut info

Custom Hit Acc groups

Filtering by hit values

Filtering by note direction

Filtering by note position

Devs

This project uses great Wails project with Svelte frontend to build the executable. Building a project requires golang 1.18+ and node 16+ installed on the computer.

First, go to the frontend directory and install the dependencies using the command:

cd frontend
npm install

and then:

Live Development

To run in live development mode, run wails dev in the project directory. This will run a Vite development server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect to this in your browser, and you can call your Go code from devtools.

Building

To build a redistributable, production mode package, use wails build. You can find the resulting executable file in the build\bin directory.

About

License:GNU General Public License v3.0


Languages

Language:Svelte 47.4%Language:JavaScript 20.6%Language:CSS 13.8%Language:TypeScript 8.0%Language:Go 6.6%Language:NSIS 3.4%Language:HTML 0.2%