__READ ME__


SlideApp
version 1.0 October 2008
Simon Yuill




__installation and running__

1.) copy slideapp.tgz to desired location.

2.) tar zxvf slideapp.tgz

3.) cd slideapp/bin

4.) ./clickToLaunchApp.sh


To quit press the 'escape' key.



__compiling__

1.) To compile from source you will need to install version 0.5 of openFrameworks, 
download the Linux version from:

	http://www.openframeworks.cc/download
	
2.) Check installation instructions for any additional libraries that may need installed.

3.) Make a folder in of0.5/apps called 'projects'.

4.) Copy slideapp.tgz to of0.5/apps/projects, then untar: tar zxvf slideapp.tgz

5.) cd slideapp

6.) make


__adjusting the project__

The project settings are contained in the file:

	slideapp/bin/settings.xml
	
This defines playback options and the texts and images used in a project. 
See notes in the comments for how to adjust settings.

New or different images can be added by placing them into the folder: 

	slideapp/bin/data/images
	
then adjust or add entries for <slides> in the settings.xml file.

NOTE: each image or text must have  a unique ID number that follows the
order of the number sequence of the existing entries in settings.xml.

The timeout values for texts and images can either follow the default values
defined in the <project> section of settings.xml, or can be assigned individually
for each entry - see commented out example in settings.xml.

The <transition> tags define probability weightings for selecting which new
text or image the application will go to next. This can be set in a range between
0 and 100, the default value for this is 20. Items with higher value numbers
will be more likely to be selected than those with lower value numbers. If there is 
only one transition with a weight value of 100, this will be selected every time. A 
weight value of 0 will not be chosen at all. The ID values in each transition
entry match the ID numbers for the text or image that will be selected.



__communicating with other apps - OSC__


SlideApp has some basic built-in OSC commands that enable it to be controlled
from another piece of software or over the network, and also to send messages
to other applications so that they can respond to it. A basic example file for
communicating with SlideApp from pd can be found in:

	slideapp/pd/slideappOSC.pd
	
_receiving_

SlideApp will send messages when it changes enters a new scene (i.e. the pause
before starting, or when starting to play) and when it changes to a new text or
slide image. When it changes to a new text or slide image SlideApp will send out the
ID number for that text or image matching the ID numbers listed in settings.xml.

Multiple SlideApp clients can send to the same recipient. To do this each client 
should be given a different name, defined by the <oscname> tag in  settings.xml.
This name becomes the first part of the OSC address of any messages the client
sends out, thus enabling messages from different clients to be easily identified.

_sending_

SlideApp can be set to play, pause and stop - the screen goes blank on 'stop' message.
The autorun mode (when the SlideApp client will automatically choose new images and 
texts) can be turned on and off remotely. SlideApp can also be sent messages to choose
a new random text or image, as well as being sent to select specific texts or images
matching the ID numbers listed in settings.xml.



__distribution__

'SlideApp' is distributed under the terms of the GNU General Public License.
For details see the file LICENSE included with this distribution.

Copyright (C) 2008 Simon Yuill

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA





