
Jungle Monkey README
--------------------
Copyright (C) 1999-2002 David A. Helder


Table of Contents
=================

  Introduction		What's Jungle Monkey
  Install		How to install from packages or source
  Quickstart		Using JM once its installed
  Mailing lists		JM mailing lists
  License		Licensing information

  Other files
    INSTALL	instructions for compiling from source
    FAQ 	frequently asked questions
    AUTHORS	list of authors
    BUGS 	list of bugs
    NEWS        changes since the last release
    TODO	plans for future releases
    HACKING	information for JM developers
    LICENSE	additional license information


Introduction
============

Jungle Monkey (JM) is a distributed file sharing program.  You join
channels where people offer files for download.  You can offer your
own files and create your own channels as well.  Once you download a
file, others can connect to you to get that file.  You can also search
for files.

Features:
  - Create your own file-sharing channels and offer files for download
  - Browse other peoples channels and download their files
  - Search for files
  - Efficiently uses bandwidth by finding the closest client with the
	file you want

JM is for Unix and requires GTK/GLIB 1.2, GNet 1.1.4, and some other
libraries.  If you have Gnome, you can enable Gnome support.

JUNGLE MONKEY IS BETA SOFTWARE.  It is fairly stable and usable, but
may still have lingering bugs.  Development will continue in the 0.1
series that may break backward compatabilty with older Jungle Monkey
clients.

Comments, questions, and bug reports should be sent to
jm@eecs.umich.edu.  Please read the FAQ before asking questions.

The Jungle Monkey homepage is at:
	http://www.junglemonkey.net
			
Debian and Red Hat packages are available on the homepage.

Jungle Monkey is part of a research project at the EECS Department of
the University of Michigan.  The current incarnation of Jungle Monkey
began in the fall of 1999, but Jungle Monkey has existed in some form
since the summer of 1998.  We're looking at end-host multicast and
other multicast issues.  See the FAQ for more information.  The lead
developer is David Helder, a PhD student at U of M.


Install
=======

It is HIGHLY RECOMMENDED that you use packages whenever possible.
There may be current Jungle Monkey packages on the JM web page.
Packages are available for all the libraries JM requires.  It is
considerably easier to install a package than it is to install
something from source code.  If you are using packages and want to
compile JM from the source, you will probably need the development
versions of these packages.  Usually these packages have names that
end with "-dev" or "-devel".

JM requires:

  GLIB 1.2.7	http://www.gtk.org
  GTK 1.2.7	http://www.gtk.org
  GNet 1.1.4	http://www.eecs.umich.edu/~dhelder/misc/gnet
  libglade	http://www.daa.com.au/~james/gnome/
  libpopt 1.2	http://www.freshmeat.net/projects/popt/
  libxml	http://www.xmlsoft.org/#Downloads

Newer versions of these libraries will probably work.  I'm using
libglade 0.17 and libpopt 1.6.4.  If you have Gnome, you do not need
libpopt.


In a nutshell, do:
  ./configure
  make
  make install

If you want Gnome support, instead do:
  ./configure --enable-gnome
  make
  make install

See INSTALL for more information.



Quickstart
==========

After installing Jungle Monkey, run 'jm' to start it (or launch it
from the Gnome menu if you compiled it with Gnome support).  Fix any
network problems it complains about.  You will need to configure JM
manually if you are behind a firewall or NAT.

Once JM is configured properly, select the "Channels" tab.  It may be
selected already.  You should see two columns.  The left column is the
Channel List, a list of all the channels you have joined.  "Monkey
Central" is in the Channel List by default.  There should be a grey
monkey head icon next to it.  The right column is the Files List, a
list of the files, channels, chats, and URLs currently advertised on
the channel selected in the Channels List.  It should be empty because
you aren't on any channels yet.

Now double click Monkey Central in the Channel List to join the Monkey
Central channel.  If you successfully join the channel, the monkey
head icon will turn brown.  If the channel is down, a red X will
appear over the monkey head.  Hopefully, this won't happen.

Once you have successfully joined Monkey Central, you should see
announcements for other channels in the Files List.  Double-click on
another channel in the Files List to join it.  If you successfully
joined it, the channel will be added to the Channels List.  Download
files by double-clicking on them.  Files being downloaded appear under
the Download tab.  Downloaded files go into the "jm" directory folder
in your home directory by default.

Now try creating a new channel.  Selected Monkey Central in the
Channels List.  Right click anywhere in the Files List and select
"Create Channel".  JM will ask you for a name for your channel.  Once
the channel has been created, select the channel in the Channels List.
Right click the files area and select "Add File".  You can add a whole
directory by selecting "Add Directory".  You can also drop-and-drag
files and directories from your browser or file viewer (like Gnome
Midnight Commander).

You can create channels that aren't advertised on another channel by
selecting "Create Private Channel".  Private channels aren't really
private, they're just unannounced.  If you create a private channel,
right-click it and select "Properties" (note you can view the
properties of any file, not just private channels).  You can then mail
the URL from the Properties window to people who need to access the
channel.  You can join a private channel by selecting "Open Channel".
JM will ask you for the URL of the channel you want to join.



Mailing lists
=============

You can join the Jungle Monkey mailing lists by sending an email to
<name>-request@eecs.umich.edu with "subscribe" as the subject where
<name> is the name of the mailing list.  The mailing lists are:

	jm-announce	Announcements about Jungle Monkey
	jm		Discussion of Jungle Monkey for JM users
	jm-dev		Discussion of Jungle Monkey for JM developers 


License
=======

Jungle Monkey is released under the GNU General Public License.
This means it's free, you can share it with your friends, but it's not
our fault if it breaks your computer.  See COPYING for more
information.
