Palaver
Contents


Disclaimer:

#include <stddisclaim.h>

I provide no guarantee against damage to hardware, software,
loss of data, property, sleep or sanity caused either directly
or indirectly by this software.

"This product is Y2K compliant" :P

The latest version, plugins, and more information can be found at http://www.aleax.com/products/palaver/



Introduction

(To-do: brief introduction to IRC)


Requirements

  • A java runtime environment (JRE 1.2.2 recommended, get it from java.sun.com).
  • Access to the internet

The Palaver core (excluding JFC/Swing based plugins) has been tested on:

  • Linux (x86): -
  • MacOS: -
  • Sun/Solaris: JDK/JRE 1.1.3, 1.1.5, 1.1.6
  • Windows 95/98/NT4: JDK/JRE 1.1.5, 1.1.6, 1.2.0, 1.2.1, 1.2.2, 1.3b0
NOTE: Individual plugins may not be cross-platform/cross-version compatible. Eg. JFC/Swing-based applications are not compatible between JDK/JRE 1.1.6 and JDK/JRE 1.2.x. It is up to plugin authors to ensure maximum compatibility of their plugins.


Installation

To install Palaver, simply extract the archive to it's own directory.
You should end up with the following:

	Palaver
	   |
	   +-- config                  (contains configuration files for each plugin)
	   +-- docs                    (contains manuals for each plugin)
	   +-- plugin                  (contains classfiles/data for each plugin)
	   |
	   +-- palaver.jar             (the Palaver core and standard plugins)
	   +-- readme.html             (what you're reading now)
	   |
	   \-- assorted batch files    (chmod +x to run from un*x shell)


Quick Start

For JRE1.2 or later:

Windows users can run the default plugin (initially XGUI), by simply double-clicking "palaver.jar".
For other OSs, the equivalent commandline is: java -jar palaver.jar

If you're running Palaver for the first time, the XGUI plugin will start up and ask you a few simple questions:

Nickname What you want to be known as to other users.
Note: The nickname may already be in use and some IRC networks place restrictions on the types of names that can be used. A good choice is an obscure (but pronuncable :-) ) name of 6-9 letters.
Real name Your real name. :-)
This is optional and isn't usually seen by other users unless they specifically request it. Don't enter anything offensive in here, as other users might judge you harshly by it...
User Id The bit before the '@' in your email address.
Entering 'dontknow' or similar is generally frowned upon and may actually stop you connecting to some IRC networks.
IRC Network Which IRC network you wish to connect to.
'localhost' is only used for testing, and will attempt to connect to your own machine (and probably fail).


Commandline options

java -classpath palaver.jar;. com.aleax.irc.IRC options plugin

Where plugin is the fully qualified class name of the plugin
and options can be any of the following:
   -window - Enable windowed/GUI mode (default)
   -console - Force console-based mode
   -configure - Change the core options

Plugins included in the palaver core are:

  • plugin.alias.NoGUI - provides a very basic console-based IRC interface. eg. for use over a telnet connection.
  • plugin.alias.AWTGUI - extends NoGUI to provide a basic windowed UI.
  • plugin.alias.SwingGUI - AWTGUI using JFC swing classes.
  • plugin.alias.HTMLGUI - Displays its text using HTML
  • plugin.alias.Tunnel - Tunnel to connect multiple channels together.
  • plugin.alias.XGUI.XGUI - Fancy MDI plugin (default).
(To-do: info about invoking with "javaw -jar" or double-clicking jarfile in windows or specifying no plugin)


Installing plugins

Simply place the plugin jarfile in the"plugins" directory.

To run the plugin, simply start Palaver with the name of the plugin eg.:
   java -classpath palaver.jar;. plugin.newplugin

Note: plugins shouldn't need files installed anywhere else other than "plugins". If any files are created elsewhere on your system, or existing files are deleted/changed during the installation, then don't trust the plugin!

(To-do: Talk about default plugin selection from plugin-chooser)


Authoring plugins

mail me

(To-do: Place links to developer information here)