Permalink
Browse files

Merge branch 'master' of github.com:gattis/milkshake

  • Loading branch information...
2 parents 0cdeba6 + b209d53 commit 9d4476398e0842f0a21b0d93ecc3464375325562 @gattis committed Sep 28, 2011
Showing with 45 additions and 3 deletions.
  1. +45 −0 README
  2. +0 −3 milkshake.js
View
45 README
@@ -1,10 +1,23 @@
milkshake -- A browser-based WebGL music visualizer based on Milkdrop / projectM
Copyright (C) 2011 Matt Gattis and contributors
+http://github.com/gattis/milkshake
Overview
--------
+milkshake is a broswer-based music visualizer implemented using WebGL
+APIs available in the latest browsers. It is a rendering engine which
+takes in preset scripts and outputs visualizations that sync in various ways
+with music. The preset format comes from MilkDrop, which was a rendering
+engine built with DirectX as a WinAmp plug-in (Windows only). projectM
+is a reimplementation of MilkDrop using OpenGL 1.0. milkshake is yet another
+reimplementation using WebGL, which is a browser-based implementation of
+OpenGL 2.0 ES. The main difference in implementations, besides being
+written in javascript, is that WebGL (OpenGL ES 2.0) has no fixed function
+pipeline like OpenGL 1.0, so all of that functionality has to be emulated
+in programmable shaders.
+
milkshake is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
@@ -16,3 +29,35 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
+Installing
+----------
+
+See milkshake.html for an example installation.
+
+
+Presets
+-------
+
+The presets are stored in Presets.js. They are very similar to milkdrop presets,
+except they are formatted in JSON. The convert_preset.py script is a handy tool to
+convert your favority mildrop presets. Most milkdrop presets are now working, and I've
+included a nice set of working ones already in Presets.js.
+
+
+Development
+-----------
+
+The project is still very much under development. Any help would be greatly
+appreciated. Send pull requests on GitHub for any fixes or improvements you
+are able to make.
+
+
+Credit Due
+----------
+
+Ryan Geiss - The creator of MilkDrop - http://www.geisswerks.com/about_milkdrop.html
+projectM - OpenGL reimplementation of MilkDrop - http://projectm.sourceforge.net/
+
+
+
+
View
3 milkshake.js
@@ -36,9 +36,6 @@ var milk = (function(){
req.open("GET", "Renderer.js", false); req.send(); eval(req.responseText);
req.open("GET", "TimeKeeper.js", false); req.send(); eval(req.responseText);
-
- var RenderItemMatcher,RenderItemMergeFunction,Renderable;
-
var milkshake;
var gl;
var textures = {};

0 comments on commit 9d44763

Please sign in to comment.