L3DGEWorld V1.0 README

Website:

  http://caia.swin.edu.au/urp/l3dge

Summary:

 L3DGEWorld is a plug-in modification to the Quake III Arena (Q3A) game
 engine. L3DGEWorld allows monitoring and control of a live network
 to take place from within a virtual world created by the Q3A game engine.

 L3DGEWorld is the product of a research project aimed at simplifying
 two key network management tasks [1]:

    - The identification of anomalous traffic patterns
      within IP networks, and
    - The control of network elements (such as routers and firewalls)
      to block anomalous traffic.

 L3DGEWorld currently creates a virtual world in which spinning objects
 represent the rate at which IP packets are heading towards particular,
 monitored IP addresses on your network. By using in-game techniques
 (in version 1.0 this involves 'shooting a gun at the spinning object')
 a network operator can initiate an ACL update to block undesired traffic.
 Our current implementation allows multiple participants to view and
 interact with the spinning network entities, and requires two participants
 to concurrently trigger any ACL updates.

 L3DGEWorld will run on any platform to which Q3A has been ported, and does
 not require the client or server portions of Q3A to be recompiled.

 Included in this release is greymatter, a FreeBSD-based application that
 monitors 'greynet' network traffic [2] and feeds real time information to
 L3DGEWorld. L3DGEWorld itself does not specifically require greymatter,
 and may be fed real time traffic information from other external sources.

System Requirements:

 L3DGEWorld and it's demonstration scripts have been verified to run
 on FreeBSD 6.2 and Windows XP Platforms (with the addition of cygwin).
 At this stage greymatter has only been verified to run on FreeBSD.

 Client Requirements:
   - Full Version of Quake 3 Arena, updated to version 1.32
   - L3DGEWorld V1.0 distribution
   - Q3A capable computer

 Server Requirements:
   - Full Version of Quake 3 Arena, updated to version 1.32
   - L3DGEWorld V1.0 distribution
   - Q3A capable computer
   - expect (http://expect.nist.gov/)
   - BASH (Bourne Again SHell)

 Q3A updates can be found at ftp://ftp.idsoftware.com/idstuff/quake3/

Documentation:

 Please see the files included in this tarball for further documentation.

Licensing:

 L3DGEWorld is copyright (C) 2007, the Centre for Advanced Internet
 Architectures, Swinburne University of Technology
 http://caia.swin.edu.au

 L3DGEWorld is distributed under version 2 of the GNU General Public Licence.
 See COPYING for the full text of the licence.

References:

[1] W. Harrop, G. Armitage, "Real-Time Collaborative Network Monitoring and
  Control Using 3D Game Engines for Representation and Interaction,"
  VizSEC'06 Workshop on Visualization for Computer Security, Virginia, USA,
  October-November 2006.

[2] W. Harrop, G. Armitage "Defining and Evaluating Greynets (Sparse Darknets)",
  IEEE 30th Conference on Local Computer Networks (LCN 2005) Sydney, Australia,
  15-17 November, 2005.