Skip to content

Latest commit

 

History

History
executable file
·
157 lines (107 loc) · 6.84 KB

README.md

File metadata and controls

executable file
·
157 lines (107 loc) · 6.84 KB
Raw

Travis Codecov

Winamp2-js

A reimplementation of Winamp 2.9 in HTML5 and JavaScript.

Give it a try!

Works in modern versions of Edge, Firefox, Safari and Chrome. IE is not supported.

Screenshot of Winamp2-js

Features

  • Decodes the actual skin file in your browser so you can load your favorite Winamp 2 skins!
  • Load local audio or skin files via drag-and-drop, eject button, or "options" button (upper left-hand corner)
  • Both visualization modes: oscilloscope and spectrum
  • Hotkeys
  • "Shade" mini-mode
  • "Doubled" mode, where the main window is twice as large: Ctrl-D

A more detailed list of features can be found in features.md.

Use Winamp2-js in your project PRE ALPHA

Several people have expressed interest in including Winamp2-js inside their website. In an attempt to try this out, I have published Winamp2-js as an NPM package. You can attempt to use it in your JS project like so:

Install the package:

npm install --save winamp2-js
npm install --save babel-polyfill

Create a DOM element somewhere in your HTML document:

<div id='winamp2-js'></div>

Initialize Winamp2-js in your JavaScript:

import 'babel-polyfill';
import Winamp from 'winamp2-js';

const winamp = new Winamp({
  initialTrack: {
    name: "1. DJ Mike Llama - Llama Whippin' Intro",
    url: "https://d38dnrh1liu4f5.cloudfront.net/projects/winamp2-js/mp3/llama-2.91.mp3"
  },
  initialSkin: {
    url: "https://d38dnrh1liu4f5.cloudfront.net/projects/winamp2-js/skins/base-2.91.wsz"
  }
});
winamp.render(document.getElementById('winamp2-js'));

// In response to a user selecting a track from your UI:
winamp.loadTrackUrl(url, name);

Notes:

  • This should not be considered "production" code.
    • Winamp2-js does not support Internet Explorer.
    • Winamp2-js was built to run on it's own page, it may not play well with surrounding CSS.
  • You will probably need to include babel-polyfill on the page that includes Winamp2-js.
  • Skin and audio URLs are subject to CORS. Please ensure they are either served from the same domain, or that the other domain is served with the correct headers.
  • This API is subject to change at any time.
  • Please reach out to me. I'd love to help you set it up, and understand how it's being used. I plan to expand this API as I learn how people want to use it.

Development

yarn
# Or: npm install
npm start

Open http://localhost:8080/webpack-dev-server/ in your browser.

Building

npm install
npm run build

Open index.html in your browser.

Deploying

These commands assume you have an SSH key to my server, which you probably don't have. Feel free to adapt them to your own server.

npm run deploy

Reverting

npm run revert # Reverts quickly to the previous deploy
HASH=<SOME_GIT_HASH> npm run deploy # Runs a new deploy at a given hashlike.

Advanced ussage

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.
  • playlistEnabled (boolean) Should the incomplete Playlist window be made avalaible.
  • noMarquee (boolean) Enable/disable to scrolling of the song title in the main window. It can be nice to turn this off when debugging Redux actions, since the scrolling generates a lot of noise.
  • hideAbout (boolean) Selectively hide the byline and GitHub link at the bottom of the page. Useful for taking screenshots.
  • 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.

Reference

Predecessors

  • Webamp2x An impressive implementation from 2002(!).

  • JsAmp An implementation from 2005 by @twm (via Hacker News).

  • LlamaCloud Comp From 2011 by Lee Martin (via Twitter)

  • Winamp em HTML5 e Javascript In 2010 a developer named Danilo posted one of his HTML5 experiments: "an audio player simulating good old Winamp". You will have to download the zip file.

  • JuicyDrop An HTML5 implementation with less empasis on being true to the skin, but fully featured visualizations. @cggaurav is keeping it alive on GitHub

  • Spotiamp The folks at Spotify reimplemented Winamp as a frontend for Spotify. Not in a browser, and only runs on Windows.

Thanks

  • Research and feature prototyping: @PAEz

Thank you to Justin Frankel and everyone at Nullsoft for Winamp which inspired so many of us.

License

While the Winamp name, interface, and, sample audio file are surely property of Nullsoft, the code within this project is released under the MIT License. That being said, if you do anything interesting with this code, please let me know. I'd love to see it.