
Hacking the VRwave 0.9 Source Code
==================================


This file contains some hopefully useful hints and tips for modifying
the VRwave source code.

Important: you must respect the conditions of the VRwave licence
agreement for modified code. See the file LICENCE for further details.


* Updating .class Files

  javac sometimes misses compiling one or the other .java file.
  You can use the jc script found in most javasrc subdirs to selectively
  compile .java files (sets up CLASSPATH and class file destination);
  e.g. to compile all files of one subpackage call jc "*.java"
  For a complete rebuild, execute the mkclean script to remove all .class
  files, and build them again by executing makeit.

  Also be sure to make the native code again if you changed relevant
  java sources, or strange errors may occur.


* Changing Package Names

  Modify javasrc/iicm/vrml/chgpackage and run it on .java files;
  afterwards update compilation scripts, makefiles etc.


* Upgrading javadoc Files

  > cd jdoc ; rm *.html
  > cd javasrc ; makedoc

  Javadoc files will be written into the jdoc directory


* Collecting a Modified VRwave Binary Release

  Be sure there is no old classes/vrwave.zip file
  > makezip
  move classes/vrwave.zip to its destination
  > cd native
  make sure VRWAVE_HOME is set appropriately
  > make install
  this copies native lib files to $VRWAVE_HOME/lib/*

  If you have Java JDK 1.1 or later, you can use the jar
  utility. Call makejar instead of makezip and you get
  a compressed .jar file which you can use the same way
  as the .zip file.



Michael Pichler,                June 10, 1997
