Mirrors/webamp
1
0
Fork 0
mirror of https://github.com/captbaritone/webamp.git synced 2026-07-27 03:54:24 +00:00
Code Issues Projects Releases Wiki Activity
webamp/packages/webamp/demo
History
Exact
jberg b522ef3ed0
Update butterchurn and butterchurn-presets betas (#1062) 
* Update butterchurn-presets to beta3

* update to beta.4

* update butterchurn to 3.0.0-beta.2

* fix type
2021-02-13 19:54:19 -08:00
..
config Pull demo site webamp config into typed module (#1057) 2021-01-02 13:16:26 -08:00
css Remove message about BLM 2020-07-03 20:20:15 -07:00
images Poolside (#1053) 2021-01-03 13:25:42 -08:00
js Update butterchurn and butterchurn-presets betas (#1062) 2021-02-13 19:54:19 -08:00
mp3 Start adopting Yarn workspaces (#985) 2020-05-17 22:12:17 -07:00
skins Allow for skins that have forward slashes in their file names (#1052) 2020-12-31 11:29:05 -08:00
index.html Revert autoformat 2020-08-18 23:04:13 -07:00
readme.md Tight up README by moving sections into sub-readmes 2021-01-04 17:13:01 -08:00

readme.md

Webamp.org

The Webamp demo site, webamp.org, uses the same interface as the NPM module but adds the following functionality by utilizing Webamp's public API

Additionally, it makes use of some private Webamp APIs to add the following functionality:

  • Butterchun integration to render MilkDrop visualizations. We intend to make this part of the public API soon.
  • "Screenshot" mode https://webamp.org/?screenshot=1 which can be used together with Puppeteer to automate the generation of Winamp skin screenshots

Production Builds

To do an optimized build of the demo site, you can run:

yarn run build

If you wish to test this build locally, run:

yarn run serve

Then open the local ip/port that is output to the console in your browser.

Deploying

Netlify watches GitHub for new versions of master. When a new version is seen, it is automatically built using npm run build and pushed to the server. Additionally, Netlify will run a build on every pull request and include a link under the heading "Deploy preview ready!". This enables easy high level testing of pull requests.

In short, deploying should be as simple as pushing a commit to master.

Additionally, if you want to fork the project, deploying should be as simple as setting up a free Netlify account

Advanced Usage

There are some "feature flags" which you can manipulate by passing a specially crafted URL hash. Simply supply a JSON blob after the # of the URL to change these settings:

  • skinUrl (string) Url of the default skin to use. Note, this file must be served with the correct Allows Origin header.
  • audioUrl (string) Url of the default audio file to use. Note, this file must be served with the correct Allows Origin header.
  • initialState (object) Override the initial Redux state. Values from this object will be recursively merged into the actual default state.

Note: These are intended mostly as development tools and are subject to change at any time.