JavaScript Audio Visualizer
SKQW (pronounced "skew") allows you to visualize the audio output of you computer's sound card. It is inspired by my love of the old Winamp plugins like Milkdrop and Geiss. Visualizations are written in JavaScript and use HTML Canvas (2d or 3d) to render.
For installation, build, and development guides, see https://michaelbromley.github.io/skqw
Since this is an Electron app, you'll find the meat of the code split between the src/main
folder for the main process code, and src/render
for the render process (browser app) code.
The docs are generated from markdown files in the docs/source
folder.
I develop SKQW on a Windows machine, so I can only provide exact instructions for building on Windows for now. Since SKQW makes use of a natively-compiled node addon for sound card access, it needs to be compiled on the target platform.
Those who are familiar with compiling electron apps and native node modules on OSX / Linux may be able to follow along with these instructions and modify the platform-specific parts. If you succeed, please let me know how you did it, so I can add instructions for those platforms.
dist:win64
git clone https://github.com/michaelbromley/skqw.git
npm install
- installs the dev dependenciescd src
npm install
- installs the runtime dependencies (native node addons)cd ..
npm run electron:rebuild
- rebuild the native modules for electronnpm run app:build
- build the appnpm run electron:start
- test the app in dev modenpm run dist:win64
- create a Windows 64-bit binary. Will be created in the dist
folder.I just upgraded to Node 6.4.0. This caused some problems with incompatible dependencies which have not upgraded some of their own dependencies to newer versions. Here's what I needed to do to get the build to work:
The docs are build with Hexo. In development, go to the /docs
folder and run hexo serve
To deploy, run hexo generate --deploy
In the Windows "sound" dialog (right click icon in system tray), go to "recording devices" tab and make sure "stereo mix" is enabled and not muted.
SKQW is built on top of the following open source projects: