****** FROCOR README ******

I) STARTING FROCOR

Currently Frocor consists of 4 programs:

1. frocor-player
2. ocor-backend
3. ocor-sdlclient
4. fmsbackend

You need to start those programs in that order. If you plan to run all 4
programs on the same computer, you could also run the script:

* frocor-local

If you plan to run frocor on multiple computers, have a look at section V.



II) USING FROCOR

Using Frocor is pretty straight-foreward:

Simply change the properties of each object with the sliders under the
corresponding image. You will notice the corresponding shape in ocor-sdlclient
and the corresponding sound change accordingly.



III) FROCOR-XMAS

a) Starting Frocor-xmas

To start the Frocor-xmas easteregg, you need to run:

1. frocor-xmas-player
2. ocor-backend
3. ocor-sdlclient
4. fmsbackend

frocor-xmas-player is interactive (needs to be run in a terminal and shouldn't
be sent to the background with &.

If you plan to run all 4 programs on the same computer, you could also run
1. frocor-xmas-player
2. frocor-xmas-clients.


b) Using Frocor-xmas

In frocor-xmas-player press the following:
 s -- start spinning star
 d -- stop spinning star
 + -- adjust tree color
 q -- quit
 


V) RUNNING FROCOR ON MULTIPLE COMPUTERS

Currently, frocor uses unix domain sockets for internal communication. To run
the different frocor components on different computers, you need to reroute 
the uds connections over tcp by using the tcp-uds-connector.

To reroute any connection, on the computer where the server is running, run
$ tucserver [-P port] unix-domain-socket

On the computer where you are going to run the client run:
$ tucclient [-P port] unix-domain-socket hostname

The sockets used by frocor currently are:
* /tmp/frocor-uds for the connection between frocor-player (server) 
  and ocorbackend (client)
* /tmp/fms-uds for the connection between frocor-player (server) and 
  fmsbackend (client)
* /tmp/ocorsdl-user.0 for the connection between ocorbackend (server) and 
  ocor-sdl-client (client)

To for example connect connect an fms-backend to a frocor-player running on
foo.bar.org run:

a) SERVER foo.bar.org:
1. frocor-player
2. tucserver /tmp/fms-uds

b) CLIENT:
3. tucclient /tmp/fms-uds foo.bar.org
4. ocorbackend
5. ocor-sdlclient

c) SERVER foo.bar.org (only if you want to hear sound on the server directly):
6. fmsbackend


The next generation of frocor will include a "real" client-server architecture
with partial direct tcp support.



VI) Further reading
More information can be found in the official frocor report (mostly German, with a few English chapters):

http://www.schule-bw.de/service/foerderprog/ccteam/projekte/download/frocor-report.pdf

or on the official frocor homepage:
http://www.schule-bw.de/service/foerderprog/ccteam/projekte/frocor_html

You might also want to have a look at the man pages (which don't yet exist for all components.)

-- Fabian Stoehr, Daniel Gruen, March 2005