shaggy/README

   1 Shaggy: java-powered citadel/ux client
   2 by Will Schenk (chilly@alumni.psu.edu, chilly @ uncnsrd)
   3
   4 Last mod: 04 Aug 1999
   5
   6 This is the java client.  It has been re-written to be multithreaded and to
   7 use the JFC/Swing library.  You need Swing for this application to work;
   8 either with Java > 1.1.3, or Java 1.2 (aka Java 2).
   9
  10 At the moment, my aim is just use this client to connect, so basically
  11 that means that I should get the client to do all the stuff that I use
  12 the bbs for.  'm sure that there are many features that I don't use, and
  13 so that'll give you an idea of where I'll need input: things like aide
  14 commands and editing configuration and other stuff I don't use.  :)
  15
  16 I've also run into some issues with non-obvious resolutions in how to
  17 layout the gui and it's behavior.  Ideas are welcome.
  18
  19 I'll try and keep the STATUS file up-to-date with the current niftyness
  20 of the features and lack thereof.
  21
  22 - BUILDING
  23 I've including a copy of my "java make script", a perl script called "jmake".
  24 Assuming javac is in your path and nothing funky is going on with your
  25 $CLASSPATH, typing
  26
  27 ./jmake
  28
  29 should compile any java source files that are
  30 newer than the corrosponding class files.  The "main" java file is
  31 "citadel.java", so if you are concerned about anything being out of
  32 whack,
  33
  34 javac -depend citadel.java
  35
  36 will build the main class, and recursively work down all the classes that
  37 it references, so everything needed will be rebuilt.  (Contrast with jmake:
  38 it builds all java classes in the directory, even those just hanging out
  39 there having nothing to do with the citadel client.)
  40
  41 - RUNNING
  42 At the moment there is no applet class, so it only works as an application.
  43 The easiest way to run the client is:
  44
  45 java citadel [host]
  46
  47 where [host] is the optional network address of the server.  host defaults
  48 to 127.0.0.1.  You'll have to change the code in net.java if you want it
  49 to use a different port.
  50
  51 ideally, when it's distributed there should be either a zip or jar file
  52 (both are actually zip files, only difference is the letters) with all the
  53 classes.  This makes the applet load faster, and it's cleaner.
  54
  55 REMEMBER: if you are using java 1.1.x, you'll need to download the swing
  56 libraries.  To use the libraries, you will need to put them in the
  57 CLASSPATH environment variable, or pass them on the command line.  Remember
  58 to put "." in the classpath.
  59
  60 example:
  61 export CLASSPATH=.:/usr/local/jdk/lib/classes.zip:/usr/local/swing/swingall.jar
  62
  63 -- will