Read Me

General Information
===================

This is Cluster Rave, version Alpha something. Cluster Rave is a program for
distributed music playback and visualization with network control.

This version of Cluster Rave is written by Josiah Boning, inspired by and
borrowing from mrwright's impressive Cluster Rave system.

Compilation
===========

Cluster Rave depends on the following libraries:
 * SDL for graphics and audio
 * SDL_net for networking (this should go away soon)
 * vorbisfile for loading OGG/Vorbis audio
 * mad for loading mp3 audio
 * fftw3 for performing frequency decomposition

You should make sure you have them.

To compile, copy Makefile.orig to Makefile and run `make'. It should (in
theory, at least) work.

Running
=======

There are a number of things you need to do to make Cluster Rave work. The
first is to edit the config file, named testconf.txt. In the simplest case,
running on one machine, you simply need to replace the hostname with the name
of the machine you are on. If you want to run Cluster Rave on multiple hosts,
you will need to add them as well.

Now, run the rave executable on all hosts. If you are having an actual rave,
the dorave.sh script provides a handy wrapper around the actual rave program,
in case it crashes or something.

Finally, run the control.py control console. The commands available here are
still pretty in flux, but the following is likely to get something playing:
	enq <path to song -- no spaces>
	shift
	shift
	play