Portable Space Engine, Installation Notes
Alpha version 1.1.x
-------------------------------------------------------------------------------

The Portable Space Engine is maintained by Cameron Smith 
(cksmith@western.wave.ca) and Mark Cooke (vspace@geocities.com). It may be 
used freely as indicated in the GNU General Public License (see the file 
'COPYING').


INSTALLATION
============

- Untar the space distribution.
- Create a symbolic link from the newly created distribution source directory
  to your server source directory.

    % cd server-dir/src
    % ln ../../space-1.1.x/src space

- Copy the appropriate patch file from the PSE patches/ directory over to
  your MU* server top level directory.
- cd to your server top level directory
- Type:  

      TinyMUX

    % patch -p1 < patch-tinymux<version>
    % cd src
    % ./configure

      TinyMUSH

    % patch -p1 < patch-tinymush<version>
    % ./configure

      PennMUSH

    % patch -p1 < patch-tinymush<version>
    % ./Configure

- Make your usual changes to the server Makefile and the configuration
  files you use for your site.
- Change directory to the one from where you compile your MU* server.
- Type:

    % make

- This should rebuild both the server and the Portable Space Engine.
- Congratulations!  The engine is now installed! 


STEP BY STEP GUIDE
==================

      TinyMUX 1.6

    % mkdir tiny
    % cd tiny
    % tar xvfz ../tinymux-1.6p0.tar.gz
    % cd ..
    % tar xvfz space-1.1.x.tar.gz
    % cd tiny/src
    % ln -s ../../space-1.1.x/src space
    % cd ..
    % patch -p1 < ../space-1.1.x/patches/patch-tinymux-1.6p0
    % cd src
    % ./configure
    % make clean
    % make

      TinyMUSH 2.2.x

    % tar xvfz tinymush-2.2.3.tar.gz
    % tar xvfz space-1.1.x.tar.gz
    % cd tinymush-2.2.3/src
    % ln -s ../../space-1.1.x/src space
    % cd ..
    % patch -p1 < ../space-1.1.x/patches/patch-tinymush-2.2.3
    % ./configure
    % make clean
    % make

      TinyMUSH 3.0

    % tar xvfz tinymush-3.0b19.tar.gz
    % tar xvfz space-1.1.x.tar.gz
    % cd tinymush-3.0b19/src
    % ln -s ../../space-1.1.x/src space
    % cd ..
    % patch -p1 < ../space-1.1.x/patches/patch-tinymush-3.0b19
    % ./configure
    % make clean
    % make

      PennMUSH

    % tar xvfz pennmush-1.7.2pl27.tar.gz
    % tar xvfz space-1.1.x.tar.gz
    % cd pennmush/src
    % ln -s ../../space-1.1.x/src space
    % cd ..
    % patch -p1 < ../space-1.1.x/patches/patch-pennmush-1.7.2pl27
    % ./Configure -d
    % make update
    % make clean
    % make


REQUIRED SOFTCODING
===================

Quite a bit of softcode is required to make the space engine work.  An example
of a working space system (in the form of a setup script) can be found at the 
primary web site site at www.sr.bham.ac.uk/~mpc/pulsar/pse.  Please drop 
by, give the system a try, and steal whatever code you think you might need!  
All of the important objects should be there.

NOTE:  The sample database may lag behind the development of the 1.1.x series
somewhat.  If you find bugs in the sample objects and manage to fix them, 
please send the changes to the mailing list.


ADDITIONAL NOTES FOR TINYMUSH USERS
===================================

Please note that soft code developed for PSE running on TinyMUX may not work
with TinyMUSH.  To help you get started in porting any sample code that
we release, here are a few hints:

- Objects with $-commands will need to have the COMMAND flag set.
- You will have to substitute 'think' with a similar command that MUSH 
  supports.  @pemit me= might work just as well.  


FINALLY
=======

If you do come up with a set of sample objects that works well with the
PSE, and would be willing to share, please e-mail Cameron at
cksmith@western.wave.ca, or the discussions list at
pse-discuss@pc24.sr.bham.ac.uk