update reamde

This commit is contained in:
Kevin Ngo
2018-11-17 06:05:28 -08:00
parent 5e43d0107a
commit 18fabcdefd

View File

@@ -1,23 +1,30 @@
# supersaber
Beat Saber on the Web with searchable and playable community songs from [Beat
Saver](https://beatsaver.com/). Instantly search and play over 2500 Beat Saber
songs without having to install the game nor any mods.
Free and open source clone of Beat Saber that lets you play from over 6000
community songs from [Beat Saver](https://beatsaver.com/) songs without having
to install any mods.
![Supersaber](https://user-images.githubusercontent.com/674727/45820657-236bfd80-bc9c-11e8-9af0-88e269e0b841.png)
Built with [A-Frame](https://aframe.io) and JavaScript on the Web so it loads
in seconds without any installs!
![Supersaber](https://user-images.githubusercontent.com/674727/48661927-bf14b280-ea2e-11e8-8dec-4ca76992322b.png)
Play Super Saber now for free on HTC Vive or Oculus Rift via
**[Supermedium](https://supermedium.com)**, the virtual reality browser!
Available on:
**[Supermedium](https://supermedium.com)**, the browser for the VR Internet!
Available for free on:
- [Steam](http://store.steampowered.com/app/803010/Supermedium/)
- [Oculus](https://www.oculus.com/experiences/rift/1629560483789871/)
<a href="https://store.steampowered.com/app/803010/Supermedium/">
<img src="https://user-images.githubusercontent.com/674727/48661907-84ab1580-ea2e-11e8-844a-63a111cccd13.png" width="50%">
</a>
<a href="https://www.oculus.com/experiences/rift/1629560483789871/">
<img src="https://user-images.githubusercontent.com/674727/48661906-84127f00-ea2e-11e8-8cd9-6b98cf05eb85.png" width="50%">
</a>
![Supermedium](https://user-images.githubusercontent.com/674727/45821011-07b52700-bc9d-11e8-9fc6-356c93b13be7.png)
## Development
From the creators of [A-Frame](https://aframe.io), built with A-Frame!
Built with [A-Frame](https://aframe.io) and JavaScript, from the creators of A-Frame!
```
npm install
@@ -26,7 +33,26 @@ npm run start
Then head to `localhost:3000` in your browser.
Also uses
[aframe-state-component](https://www.npmjs.com/package/aframe-state-component)
as state container and [Nunjucks](https://mozilla.github.io/nunjucks/) to
assist HTML templating.
### Debug Flags
| Flag | Description |
|---------------|-------------------------|
| ?debug | Move sabers with mouse. |
| ?debugloading | Show loading screen. |
| ?debugvictory | Show victory screen. |
| ?godmode | Never die. |
| ?synctest | Log beat timestamps. |
## Chat
Hang out with us on [Discord](https://supermedium.com/discord/) and follow us
on [Twitter](https://twitter.com/supermediumvr)!
Hi, we're the [Supermedium](https://supermedium.com) team! We'd love if you
provide feedback, bug reports, and feature requests! A-Frame and the Web lets
us iterate and deploy new features very quickly.
- Hang out with us on [Discord](https://supermedium.com/discord/).
- Follow us on [Twitter](https://twitter.com/supermediumvr)!