Skip to content

KivalEvan/BeatSaber-MapCheck

Repository files navigation

Beat Saber Map Check

A small project to bring extensive overview of maps, aimed to reduce error before modding & release.

by @kivalevan

Usage

Visit the github.io page, more information in the GitHub Wiki.

Development

Installing

Clone or fork the project and install dependencies with npm or yarn.

Deploying

Run the development server with npm run dev, the URL will be given in the CLI.

To run the app locally, npm run build for the first time setup, then npm run serve to run the server.

Contributing

If you wish to contribute, do follow the guidelines. Make pull request for feature addition/enhancement/fix or create an issue if you encounter error/problem or want an improvement.

Guidelines

  • File names shall use camel case.
  • Use formatting standard given in prettier config.
  • Top-level function must use regular function.
  • Use dev branch as base for new development/branch.
  • No other third-dependencies unless absolutely necessary.
  • Avoid circular imports.

Any beatmap related has to be done in Beat Saber JS Map repository instead.

Planned

  • Pre-render page for higher performance
  • Rewrite swing detection
  • Localization

Note

Since this is my first ever (web) project, I'm open to feedback to further improve skill and develop better stuff in the future. If you have any suggestion or feedback, let me know on Discord@kivalevan

Credits

  • Uninstaller and Qwasyx (improving it) for note swing detection algorithm
  • Top_Cat for math guidance
  • BSMG Team for CORS proxy service
  • Others for helpful feedback & indirect contribution

About

Web application for extensive overview for Beat Saber beatmap.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project