[ Warning! Research Software. For HP Products go to http://www.hp.com ]

[ up ][ curious ][ user ][ developer ][ contributor ][ suggestions ]

Installing Ubiwise

[Overview of Ubiwise]

This is a complex system, so installation will not be trivial. I welcome suggestions on how to make it easier or how to describe it better.

The download files are on a site called "handhelds.org". All the ubiwise source except for the idSoftware-derived source is copyright HP and licensed under "LGPL" with the intent being that you know it is legitimately intended to be open for you to use. The idSoftware-derived source is covered by their license with modifications covered by LGPL. Please note: LGPL does not require you to release your code as open source.

In increasing levels of fun, we have three kinds of installations:

  1. Curious -- minimum install, just want to run it.
  2. Users -- all the tools for using it but no source.
  3. Developers -- tools plus source
  4. Contributors-- the full monty: tools, source, and connection to cvs

So far these instructions are all for Windows and specifically for Win2k. Mostly this stuff should work on Linux or Mac: let me know how it goes.

[ home ][ install ][ read ][ curious ][ user ][ developer ][ contributor ][ suggestions ]

Curious: Install Ubiwise; try it.

To try ubiwise you need to download it, unzip it, set up the environment, then run it. Here are the steps:

  1. Download the zip file
  2. Pick an install directory.
  3. Two choices that we know will work if you have enough disk space are "C:\" or "G:\".
  4. Unzip ubiwise.zip in that directory.
  5. This sets up subdirectory ./ubiwise. The full path for this direction, e.g. G:/ubiwise, will be called UBIHOME below. For more info on directories, see the top-level readme).

  6. Install Java 1.4.0. (I backed off of 1.4.1 on my machine: it kept crashing my win2k to a blue screen. This is likely some problem in Java's use of DirectX.
  7. Install a retail copy of Quake 3 Arena into the directory UBIHOME/ubiwise/quake3/.
  8. Yes it has to go there. Do a full install (soon we won't need the huge zip file of Q3A media and a small install will work. But for now, load it all).

  9. Set up the your shell environment to include four values:
  10. JAVA_HOME (e.g. set JAVA_HOME=G:\j2sdk1.4.0_02\)
    Directory containing a SUN JDK distribution.
    CLASSPATH (e.g. set CLASSPATH=%JAVA_HOME%\jre\lib\rt.jar )
    Java CLASSPATH containing the JDK from JAVA_HOME.
    UBIHOME (e.g. set UBIHOME=G:/ubiwise)
    Directory containing the UbiWise Distribution. A forward slash is needed if you use our makefiles.
    WISEHOME (e.g. set WISEHOME=%UBIHOME%/wise)
    Subdirectory of UbiWise containing WISE.

The file in ubiwise/bin/ubiwise_env.bat sets CLASSPATH and WISEHOME (See also the top-level readme)

  1. Bring up a command line (Start->Run and type "cmd" for Win2k); cd to ubiwise/bin and type "doUbi".
  2. You will end up with three command windows and two user interface windows. An example scenario will be running. (Need a walkthru here!)

    I put "G:\ubiwise\bin" on my Win2k PATH (using Start->Settings->System->Advanced->EnvironmentVariables). Then when I bring up the cmd window, I can just type doUbi.

[ home ][ install ][ read ][ curious ][ user ][ developer ][ contributor ][ suggestions ]

User: Installing Ubiwise to add scenarios and new entities

  1. Do all of the steps for a Curious install.
  2. Install gtkRadiant 1.2.8 to do level editing. Beware: This program is more finicky about graphics cards than Q3A.
    1. I install it under UBIHOME/ubiwise/tools/GtkRadiant.
    2. The current version of 1.2.8 is setup for editing Jedi-Knight II. The installer will ask you where you JediKnight files are located: just give a temp file name because in a subsequent screen you can de-select the JediKnight media files. (I plan to switch to GtkRadiant 1.3 when it is stable).
    3. When you run it the first time select "Custom Quake III Modification" and set fsgame to "ubisim". Then you can open "ubisim/maps/ubi3.map" for example.

[ home ][ install ][ read ][ curious ][ user ][ developer ][ contributor ][ suggestions ]

Developers: Installing Ubiwise to develop.

The source is available in the zip file.

  1. Do all of the steps for a Curious install.
  2. Go to ubiwise/wise/src for wise source.
  3. Go to ubiwise/quake3/source for ubisim source. Again note that this source is covered by a license from idsoftware.

Alternatively you can keep in sync with the ubiwise development by using cvs anonyomously via handhelds.org.

  1. cd to UBIHOME (eg for me that would be G:).
  2. cvs co ubiwise

[ home ][ install ][ read ][ curious ][ user ][ developer ][ contributor ][ suggestions ]

Contributors: Installing Ubiwise to give back.

To help directly with ubiwise:

  1. You need to get a user id on admin.handhelds.org.
  2. Request write access to cvs by sending me mail at johnjbarton@johnjbarton.com. Send me the user id you registered with on handhelds.org.
  3. Get compilers:
    1. Jikes (if you like fast compiles) or JDK 1.3 for wise
    2. Microsoft Visual C++ for ubisim
  4. checkout the source with cvs
    1. cygwin toolkit is real handy (Cygwin is a UNIX environment, developed by Red Hat, for Windows) I use version 1.3.6-6
    2. cvs command line tool works fine. I use cvs 1.11.
    3. Since I work behind a firewall I use plink from the putty tool.
    4. To checkout, cd to the UBIHOME directory and issue:
      1. cvs checkout ubiwise
    5. To commit your changes:
      1. Send some to ubiwise on the handhelds.org site to let us know you are incoming.
      2. cd to the source directory: ubiwise/wise/src/wise or ubiwise/quake3/source
      3. cvs update -dP
      4. rebuild..please after you update to sync to new changes.
      5. cvs commit -m "yourid: your fix"
  5. Build
    1. WISE: cd to wise/src, "make"
    2. UBISIM: cd to ubisim/quake3/source, launch ubisim.dws, build all three projects.
[ home ][ install ][ read ][ curious ][ user ][ developer ][ contributor ][ suggestions ]

Copyright HP 2002