OSCAvoid
--------

Description
-----------
A very simple game about collecting dots coloured the same as you, and avoiding
dots coloured differently.

The game transmits and responds to Open Sound Control messages. This means it
can be played in multiplayer by running two instances and setting the listen
ports and send addresses/ports accordingly (see command line options below).

The game uses the following OSC addresses:
/player/position/x
/player/position/y
/player/colour/r
/player/colour/g
/player/colour/b

/entityX/position/x
/entityX/position/y
/entityX/colour/r
/entityX/colour/g
/entityX/colour/b
(where X is a number 0..7)

/score

Score messages are assumed to be integers, all other messages are floats(0..1).


The game has no end condition. It's up to the players to decide when the game
ends.


Controls
--------
Move the mouse.
Escape quits.


Game Options
------------
The game will automatically start fullscreen at your desktop's current
resolution, with the game corrected to its desired aspect ratio.

You can pass the executable various command line flags:

Usage:
OSCAvoid.exe -w [width] -h [height] -win -a [name] -d [name] -lp [port] -sa [address] -sp [port] -debug

Flags:
--width [val] | -w [val]:       Set the width of the window.
--height [val] | -h [val]:      Set the height of the window.
--windowed | -win:              Sets whether to go windowed or not.
--drawer [name] | -d [name]:    Sets the renderer to use. Can be GLESDrawer
                                (newer, more efficient) or GLImmediateDrawer
                                (older, more compatible).
--listenPort [val] | -lp [val]: Sets the port to listen for OSC messages on.
--sendAddress [val] | -sa [val]:Sets the ip address to send OSC messages to.
--sendPort [val] | -sp [val]:   Sets the port to send OSC messages to.
--debug | -debug:               Output debug info to
                                <home dir>/NiallDebugFile<some long number>.txt.
--help:                         Display this help.

These can also be set from the config.txt file that will be generated
when the program is first run. It resides alongside the keyconfig.txt file at:

Windows XP:      Documents and Settings/<user name>/Application Data/OSCAvoid
Windows Vista/7: Users/<user name>/AppData/Roaming/OSCAvoid
Linux etc.:      /home/<user name>/.OSCAvoid
OSX:             /Users/<user name>/Library/Application Support/OSCAvoid


License Details
---------------
Source code is licensed under the GPL v3. Graphics and sounds are licensed
under the Creative Commons Attribution-ShareAlike license. The font is League
Gothic from the League of Movable Type:
http://www.theleagueofmoveabletype.com/league-gothic/


- Niall Moody (14/08/13).
