chdh - egregore source Files

EGREGORE SOURCE 
---------------
 * authors: chdh
 * web site: http://www.chdh.net
 * source code: http://sourceforge.net/p/chdh-egregore/code
 * date: 2014-02-20
 * version: 0.5 Beta1

CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation & Run
 * General Usage
 * Files
 * Troubleshooting
 * Pd Users Details
 * License

INTRODUCTION
------------
This is an adaptation of the software used by chdh for the performance 
egregore in 2011-2013. It is based on five different audiovisual instruments
that you can directly control. They will also be played by chdh live on the
19 March 2014

REQUIREMENTS
------------
 * Hardware : 
   This patch should run on any computer with average performance since 2011.
   - CPU : a minimum of 2 core is mandatory. Intel core 2 duo 2GHz is a minimum.
   - GPU : Intel HD 4000 works. Most ATI or NVIDIA GPU since 2010 should work.
 * Software : 
   The software needed depend of your operating system and its version.
   - Linux (32 and 64 bits)
     Pure Data version >= 0.43 and Gem version >= 0.93.3 have to be installed on 
     your computer. The easiest way to get both is to download Pd-extended, see:
       http://puredata.info/downloads/pd-extended
   - OSX (from 10.5 to 10.9)
     Nothing have to be installed.
   - Windows XP / Vista / seven / 8 
     Nothing have to be installed.
 
INSTALLATION & RUN
------------------
 * OSX : Uncompress the egregore_source.zip, move the egregore_source.app where you 
  want on your computer and click on it.
 * Windows : Uncompress the egregore_source.zip, move the directory where you want
  on your computer and double-click on egregore.bat
 * Linux : Uncompress the egregore_source.tar.gz, move the directory where you want
  on your computer and double-click on egregore.sh


GENERAL USAGE
-------------
The egregore instrument is divided in five different behaviors, click on
the on/off button to activate them separately and move the faders to change 
the state.

You can adjust the video settings by clicking on the [config] button. This 
section allows the control of the rendering window size and position. Use 
negative or big positive offset values to move the window on another screen.

The instrument will be played live by chdh on the 19 March 2014. The computing 
will be done locally on your computer. To attend the show, just launch the
application at the right date.

You can use any part of this instrument for yourself. The application is build
in the Pure Data software. To open the engine layer,click on the [engine] button.
Here you can edit, copy and paste in other Pd patchs.

FILES
-----
 * data/ : This directory will contend data controlling the instrument from
  the live performance. 
 * src/
   - abs/ : useful pure data abstraction
   - bin/ : osX and windows pure data binary
   - etc/ : application icon file and various files
   - instruments/ : instruments used for the performance (pure data patch)
   - lib/ : various library (src + binary) used by the patch
   - config.txt : computer specific configuration text file
   - egregore.pd : main patch 

CONTACT
-------
Visit the chdh website to have news and infos
  http://www.chdh.net

or contact us directly by mail
  info@chdh.net

TROUBLESHOOTING
--------------
 * Conflict with existing Pure Data installations : There should be no conflict 
  with existing pd installation. Startup script should start pd with it's own 
  preference file, and do not overwrite preferences. 
 * If you have problem with your video settings and can't launch the application
  anymore, you can delete the config.txt file in the src folder. A new one with 
  basic value will be generated. 
 * To watch the live performance the application need to be connected to Internet. 
  If you see a message in the rendering window announcing the show everything is ok,
  otherwise check your firewall settings.
 * There is a known problem in some version of Gem/Ubuntu where the window can't 
  recreate itself. This doesn't allow you to easily modify the video settings. To
  do that, choose your settings, click save and relaunch the software.
 * The displaying of the text can slow down the rendering in osx. If you have this 
  problem just wait for the text to disappear (~7s).
 * If you have another Linux distribution than Ubuntu, you may need to recompile
  the sources. To do that do
    cd PATH/egregore_source_X.X/src/lib
    make

PD USERS DETAILS
----------------
The main patch is composed of several parts:
 * instruments : create sound and movements for 377 particules.
 * bus : add the sound and position generated by all instruments.
 * server : manage the control parameters.
 * interface : send data to the server.
 * internet reception : manage the data from Internet.
 * render : displays the particules displacements.
Due to some minor instabilities, the downloading part of the patch has been isolated. 
The startup script start this part in -nogui mode and and restart it if it close.

LICENSE
-------
GNU GENERAL PUBLIC LICENSE Version 3
See License.txt for more details.