Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
rphsoftware committed Sep 10, 2020
2 parents 791e53c + 725a550 commit c5bcd03
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Revolving door

A modern web player for Binary Revolution Stream (BRSTM) files

## Compiling

This program is built using webpack. To set up a dev environment, simply run `yarn` and to compile run `npm run build`. The compiled js is then dropped into `dist/`

## Operation

This program exposes a very basic API to the window context with just one function to initiate playback. `window.player.play(URL)`. Afterwards, everything is handled by gui.

To properly add this program to your website, you also need to link the `player.css` stylesheet somewhere.

## Browser compatibility

The program has been tested in all modern browsers (Chrome, Firefox, Safari) and has been known to also work on some older ones like Palemoon 28 and Icecat 60.

The program attempts to adjust its functionality to what the browser requires (Either disabling or enabling the streaming features for example).

## Software used:

This program uses `webpack` to compile and bundle itself ( https://webpack.js.org/ )

The `brstm` module by https://github.com/kenrick95 is used to decode BRSTM files (https://github.com/kenrick95/nikku/blob/master/src/brstm/ , https://www.npmjs.com/package/brstm , licensed under the MIT license)

The audio resampler used by the program was written by Grant Galitz and was released to the Public Domain by the author.
3 changes: 2 additions & 1 deletion player.css
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,8 @@
justify-content: center;
flex-direction: column;
height: 100px;
font-size: 14px;
}
.error > h3 {
margin: 0;
}
}

0 comments on commit c5bcd03

Please sign in to comment.