                  _        _                         _            
 _ __   __ _  ___| | _____| |_    __ _  __ _ _ __ __| | ___ _ __  
| '_ \ / _` |/ __| |/ / _ \ __|  / _` |/ _` | '__/ _` |/ _ \ '_ \ 
| |_) | (_| | (__|   <  __/ |_  | (_| | (_| | | | (_| |  __/ | | |
| .__/ \__,_|\___|_|\_\___|\__|  \__, |\__,_|_|  \__,_|\___|_| |_|
|_|                              |___/                            

This is the README for the Packet Garden Linux Beta.                  
                                                                      
Packet Garden is written in Python on a GNU/Linux system          
using Vim7.0.
                                                                      
Packet Garden on Linux resources the following quality open source    
software products: 

      Python: http://python.org                  
      Python GeoIP: http://www.maxmind.com/app/geoip_country
      Soya3D: http://http://soyaproject.org     
      LibPcap: http://tcpdump.org                     
      PyPcap: http://www.monkey.org/~dugsong/pypcap/ 
      DPKT: http://www.monkey.org/~dugsong/dpkt     
      gksu
      Python Imaging: http://www.pythonware.com/products/pil/                           
      Simple Direct Media Layer: http://www.libsdl.org/index.php              
      Psyco: http://psyco.sf.net             
      OpenAL: http://openal.org             

Thanks:

.. 10**6 to souvarine, atomekk and most of all jiba from #soya on Freenode 
for their help and advice over the last few months. You guys rock. 
Thanks also to starling, TML and ironfroggy in #python for steering me away 
from threads and pix for his sturdy advice.

Installing:

Debian and Ubuntu:

  You may prefer To install Packet Garden using the Debian packages. If so, 
  you'll need to first install dpkt and pypcap. The first two are 
  available as Debian packages for either Ubuntu or Debian systems from:
    
        http://selectparks.net/~julian/pg/dists/linux

  The Packet Garden debian package will tell you what you're missing when
  you install. With the exception of the packages at the above address, all
  the necessary dependencies to run the project are in Debian Sid or Ubuntu
  6.10 (Edgy).

Other Linux distributions:

  You'll need to install all the above dependencies using your package manager 
  or from source. If you run another distribution and are interested in 
  packaging Packet Garden for your distro, I'm really keen to hear from you..

Useage:
                                                                      
  0  'cd' to the place you unpacked Packet Garden. Start Packet Garden by 
    typing './packetgarden -local' in a terminal and hitting ENTER.

  1  Read the menu item 'protocol guide'.
                                                                    
  2  Ensure you're online. Start to capture some packets by          
    clicking on the menu item "start packet capture".               
    Enter your user password in the prompt and hit "start".          
    If you don't have system wide sudo permissions setup, then      
    simply become root and execute the capture script from the      
    command line like so:                                           
                                                                    
    'python pg_packet.py <devicename> ~/.packetgarden'                              
                                                                    
    .. where <devicename> is the network device you want to capture    
    packets on. On my systems this device is either eth0 or eth1    
                                                                     
    The script will now capture packets until you stop it using the 
    same menu item, or reboot.            
                                                                    
  3  Now generate lots of traffic: visit some websites, download,    
    upload, check mail.                                             
                                                                    
  4  Click on the menu item "generate world". If you've captured     
    lots of traffic it will take a while.                           
                                                                    
  5  Once the world has been generated, click on the button          
    "visit world" and read the on screen instructions.              
                                                                    
  6  Play around with the settings in the "configure" menu item. 
      By default, Packet Garden doesn't start with shadows, or in
      full screen mode.             
                                                                      
If you encounter any errors, or have some suggestions, please get     
in touch:

      julian@selectparks.net                                
                                                                     
Happy gardening,

Julian Oliver, Jan 02, 2007.
