L3DGEWorld 2.3 README

Website:

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

Summary:

  L3DGEWorld is a standalone application based on Open Arena (OA), a free,
  open source game based on the Quake III Arena engine. L3DGEWorld allows
  monitoring and control of a live network to take place from within a virtual
  world created by the 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 combined with greymatter (our provided input daemon) create a
  virtual world in which objects with a number of different visual
  characteristics represent a number of network metrics calculated by
  greymatter.  By using in-game techniques (currently this involves 'shooting a
  gun at the object') a network operator can initiate an ACL update to block
  undesired traffic.  Multiple participants may view and interact with the
  spinning network entities. L3DGEWorld may be configured to require one, two
  or more participants to concurrently interact with an entity before ACL
  updates are triggered.

  L3DGEWorld 2.3 may be compiled under FreeBSD, Linux, Windows and Mac OS X.
  Please check the project website (http://caia.swin.edu.au/urp/l3dge) for
  packages containing binaries pre-compiled for each of these platforms.

  This release includes 'greymatter', a FreeBSD-based application that
  monitors 'greynet' network traffic [2] and feeds real time information to
  L3DGEWorld; and LRCD, an application that listens for control messages from
  the L3DGEWorld server and places ACLs on a Cisco Router. L3DGEWorld itself does
  not specifically require greymatter or LRCD, and may be fed real time traffic
  information from other external sources [3].

System Requirements:

  L3DGEWorld and it's demonstration software (fakematter) have been verified to
  run on FreeBSD 6.2, Linux (Ubuntu 7.10), Mac OS X 10.4.9 and Windows XP
  Platforms (with the addition of cygwin).  At this stage greymatter has only
  been verified to run on FreeBSD.

  Client Requirements:
    - L3DGEWorld 2.3 distribution
    - libSDL and libOpenAL are required on FreeBSD and Linux.
    - A computer capable of running Quake III Arena [4] (and thus
    sufficient to run OpenArena)
    - In addition to the Q3A System requirements, at least 192MB of RAM

  Server Requirements:
    - L3DGEWorld 2.3 distribution
    - A computer capable of running Quake III Arena [4] (and thus
    sufficient to run OpenArena)
    - In addition to the Q3A System requirements, at least 192MB of RAM
 
  Greymatter Requirements:
    - Currently only supports FreeBSD
    - libpcap packet capturing library

  LRCD Requirements:
    - Only tested to work on FreeBSD, but should also work on other Unix-like 
      operating systems
    - expect (http://expect.nist.gov/) 
    - a direct serial link or telnet access to a cisco router

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.
    http://www.projects.ncassr.org/sift/vizsec/vizsec06/program/vizsec05.pdf

[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. 
    http://ieeexplore.ieee.org/iel5/10397/33047/01550875.pdf?tp=&arnumber=1550875&isnumber=33047

[3] L. Parry "L3DGEWorld 2.2 Input & Output Specifications",
    CAIA Tech Report, December 2007
    http://caia.swin.edu.au/reports/071218B/CAIA-TR-071218B.pdf

[4] http://www.idsoftware.com/games/quake/quake3-arena/index.php?game_section=sysreq