aplomBomb / BeatSaberCompanion

Companion App for the VR Rhythm Game Beat Saber

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Beat Saber Companion

A companion app for the VR rhythym game Beat Saber. Allows users to browse the Beat Saver database for custom beatmaps made by the community. Provides easy access to the latest news for Beat Saber straight from the developers. Shows all Twitch channels that are currently live-streaming Beat Saber in descending order of viewership.

Getting Started

You can clone this repository if you'd like to run it on your local machine.

  • You must ensure that you have Node installed, for installing Node, follow these instructions. Target the clone via your preferred terminal and run this command:
npm install

Once dependencies have successfully installed, run the command:

npm start
  • Note that due to the Oauth2 handshake process, only the local machine hosting the development server can access the Twitch Streams page due to redirect URL issues. You must also have a Twitch account that you can use to login to view the Twitch Stream page successfully.

Alternatively....

You can view a working demonstration of the Beat Saber Companion online at: https://beatsabercompanion.herokuapp.com/

Built With

Authors

  • Christian Baldwin - Initial work - Aplombomb

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

About

Companion App for the VR Rhythm Game Beat Saber

License:MIT License


Languages

Language:JavaScript 89.0%Language:HTML 8.4%Language:CSS 2.7%