============================
==                        ==
==  rFactorLive 0.9 BETA  ==
==                        ==
============================


ABOUT
-----

rFactorLive is an application that allows rFactor races to be watched from PCs that do not have rFactor installed.
Features include a live animated track map and real-time timing data. Operation does not require a web server.

Note that this is a BETA version of the software, so please don't expect flawless operation just yet!



DISTRIBUTION
------------

rFactorLive can be freely distributed.  However, any distribution must include the following files in an unmodified state:
	readme.txt, rFactorLive.exe, rFactorLivePlugin.dll, rFactorLiveServer.bat, changelog.txt

This has been developed in my spare time, so if you have any enhancement requests and/or find the software useful,
any wife-placation-fund donations will be gladly received via paypal to 'alain@rfactorlive.co.uk'.



INSTALLATION
------------

CLIENT INSTALLATION:

1. Extract rFactorLive.exe to a suitable location
2. Run rFactorLive.exe

If you get an error about the application not being installed correctly, download and install the Visual C++ 2008 runtimes. Google for "vc 2008 redist" to find them.



PLUGIN INSTALLATION:

1. Extract rFactorLivePlugin.dll to rFactor's 'Plugins' folder
2. Run rFactor up, then shut it down
3. In the top level rFactor folder locate the file called 'rFactorLivePlugin.ini'.
   This file can be edited to control the base TCP port that the server will use.
   In order to pick up changes made to this file, rFactor must be restarted.
4. Ensure that the configured TCP port is forwarded through any routers/firewalls.
   The port specified in the .ini file is used for the first instance of rFactor. A second instance of rFactor will use the next higher free port, and so on.

If no rFactorLivePlugin.ini file is created, install the Visual C++ 2008 runtimes as described in the client installation.
NOTE: If the runtimes are not installed no error message will be displayed, BUT THE SERVER WILL NOT WORK.



RELAY SERVER INSTALLATION

The rFactorLive plugin supports a single client connection.
If you wish to broadcast to multiple clients it is necessary to setup a relay server.
The relay server does not have to run on the same PC as the rFactor server.

1. Extract rFactorLive.exe and rFactorLiveServer.bat to a suitable location
2. Run rFactorLiveServer.bat

If you get an error about the application not being installed correctly, download and install the Visual C++ 2008 runtimes. Google for "vc 2008 redist" to find them.





UNINSTALLATION
--------------

CLIENT UNINSTALL:

1. Delete rFactorLive.exe, rFactorLive.ini and rFactorLive.log.
   That's it. No registry data or other files are created.


PLUGIN UNINSTALL:

1. Delete rFactorLivePlugin.dll from the rFactor 'Plugins' folder.
2. Delete rFactorLivePlugin.ini and rFactorLivePlugin.log from the top level rFactor folder.


RELAY SERVER UNINSTALL:

1. Follow the instructions for CLIENT UNINSTALL.
1. Delete rFactorLiveServer.bat.



CLIENT (VIEWER) OPERATION
-------------------------

Double-click the rFactorLive.exe file.
Select 'Connect' on the File menu.
Enter the host name or IP address of the server and its port number.
To zoom in and follow a vehicle, left-click on the driver's name in the Standings window. To zoom out again, left-click anywhere in the trackmap area.


CLIENT (VIEWER) COMMAND LINE PARAMETERS
---------------------------------------

The '-server' command line parameter can be used to set the server's name and port number. The value of the parameter should exactly match what would be entered into the Connect dialog.
The '-connect' command line switch can be used to connect immediately to the server when rFactorLive is started.
For example:
	rFactorLive.exe -server examplehost.co.uk:12345 -connect
	will immediately attempt to connect to the rFactorLive server running on port 12345 at examplehost.co.uk.
	
	
	
RELAY SERVER OPERATION
---------------

Double-click the rFactorLiveServer.bat file.
Enter the rFactor server host name (or IP address) and its port number.
Enter the port that you want the other clients (viewers) to connect to this relay server on.
Enter the maximum number of clients (viewers) that you want to allow.
Click the 'Start Relay Server' button to start the server.

The status bar will change to 'Connected' when communication is established with the rFactor server.
The status bar will indicate the current number of clients connected to the relay server.



	


KNOWN ISSUES
------------

Sometimes on change of track the client does not receive the new track outline. To clear this the client has to be closed and restarted.

Stopping the relay server while there are clients connected to it will cause the relay server to crash (but rFactor itself will be unaffected)



FUTURE PLANS
------------

It should soon be possible to run rFactorLive without a live connection to an rFactor server.
Instead it will read and display the contents of an rFactor replay (VCR) file.



DISCLAIMER
----------
This software is supplied entirely as-is with no warranties with respect of any bugs or errors in the software or to its fitness for a particular purpose.
Please inform me of any bugs you may find and I will endevour to rectify them.



CONTACT
-------
Please let me know of any issue you may find by emailing me at:
	alain@rfactorlive.co.uk
	
For further documentation please visit www.rfactorlive.co.uk.



CREDITS
-------
Design and coding:
	Alain Cottignies (Lumpy)

Beta testing:
	Hans Brauer (M00ndancer)
	Steve Parsons (Spadowski)
	KC at rleague.eu

Making rF a special online experience:
	Everyone at rfgrc.co.uk

Making rF the ideal online racing platform:
	ISI


(c) 2007-2008 Alain Cottignies. All Rights Reserved

