
HOWTO INSTALL
=============

If you got here it might be obvious you know you need PD to run this program
it was developed and tested using PD 0.37.0

STEP 0 :: A) untar the tarball in your favorite location (/usr/local or /usr/local/patches/
             is recommended) and create a symlink to videoflow-XX where XX is the version.

             # tar xzvf videoflow-1.1.tgz
             # ln -s videoflow-1.1 videoflow

          B) cd to videoflow and follow the next steps

STEP 1 :: install all required dependencies

Required externals

* playlist - browse your directories and choose files to be played
* spigot~ - used for muting the main out
* oggread~ - play ogg files (highly recommend, but could be replaced if you want)
* filterbank~ - used by the ekwalizer (from Yves)

All of the above are critical for the patch to work.
	
Required abstractions (located in the abstractions/ dir within the package):

multiplexor - something not used anymore, but still required (to be removed soon)
autofader - interface for monitor mixer to main mixer
ekwalizer - does the name gives any clue?
keymap - keyboard mapping interface to control things from the keyboard
joy_16faders_midi - required for joystick
joybut - required for joystick
joy_sense - required for joystick
killnoff - required for joystick
stabilize_bang - required for joystick
rebang - required for joystick
trickb - required for joystick

Optional externals:

oggamp~ - for tunning into ogg/vorbis streams
oggcast~ - for streaming out the whole mix against an Icecast2 server in ogg/vorbis format
mp3write~ - for recording to mp3 the whole mix
mp3amp~ - tune to mp3 streams
mp3cast~ - send out the whole mix into an mp3 stream (requires an ice/shout-cast server)
mp3streamin~ - part of the stream out enhancing (not fully implemented/tested)
mp3streamout~ - part of the stream out enhancing (not fully implemented/tested)
linuxjoystick - will provide support for your joystick or gamepad

Joystick implementation was developed for Logitech Wingman RumblePad (Cordless also)
No other joysticks/pads were tested with it, though it might work.

It is recommended that you don't use a .pdrc file, but instead stick to the configuration
set in the audioflow.sh

STEP 2 :: Edit videoflow.sh shell script & fix your paths and stuff according to your system setup.

STEP 3 :: Run audioflow using the following command: ./scripts/audioflow.sh

if step 3 works, you can copy scripts/audioflow.sh to /usr/local/bin so that you can just type audioflow.sh on any console and the program will start

STEP 4 :: browse your music (for the moment just ogg/vorbis files ONLY) and play!

STEP 6 :: have a lot of fun !

in case of problems (you will have!), don't hesitate to contact me at pdrama@xicnet.com
