X S H I P W A R S INSTALLATION INSTRUCTIONS An alternate `more detailed' installation guide is available for installing the client at: http://fox.mit.edu/xsw/dl_main.htm Basic Installation Overview: Step 1: (optional) Install the YIFF Sound Server Compoents. Step 2: (optional) Install the Linux Joystick Driver. Step 3: (optional) Install the XJoystick Caliberator and libjsw. Step 4: Build the XShipWars client. Step 5: Install a graphics and (optional) sound set. Step 6: (optional) Build the ShipWars server. Step 7: (optional) Build the ShipWars server monitor. Step 8: (optional) Build the Universe Editor. 1. (optional) Install the YIFF Sound Server Compoents: * Linux users only. * Download the YIFF Sound Server source package from the same location you obtained this package or http://wolfpack.twu.net/YIFF You only need to build and install the libY2 and the Y2 header files to compile the XShipWars client for YIFF Sound Server support. 2. (optional) Install the Linux Joystick Driver: * Skip this step if you already have a Linux Joystick Driver * * or if you are not using Linux. * Download the Linux Joystick Driver 1.2.x at: http://atrey.karlin.mff.cuni.cz/~vojtech/joystick/ -or- ftp://atrey.karlin.mff.cuni.cz/pub/linux/joystick/joystick-1.2.14.tar.gz Follow the instructions included in the Linux Joystick Driver. Rememeber to load the joystick driver modules and install the joystick.h header file in /usr/include/linux/joystick.h. 3. (optional) Build the Joystick Caliberator and libjsw: * This program is required for joystick support! * Download libjsw at: http://wolfpack.twu.net/libjsw Follow the instructions included with libjsw, make sure that you build and install both libjsw and jscalibrator. Caliberate your joystick right afterwards to generate a .joystick in your home directory. 4. Build the XShipWars Client: NOTE: Users of older g++ may wish to see the FreeBSD note in the README file. This concerns g++ 2.72.x and below. Important note regarding Linux and sound: If you want YIFF Sound Server support (and you probably do if you have Linux and a supported sound card with driver installed), then make sure that you have libY2 installed. libY2 comes with the YIFF Sound Server source and is available from the same place where you obtained this source. All you really need is the libY2 and the Y2 header files installed. If you do not have Y2 and/or you don't want support for it then edit the client's Makefile.Linux, remove -lY2 from the LIB line and -DHAVE_YIFF from the CFLAGS line. Otherwise make sure you have Y2 installed first before compiling the client. If you want EsoundD support, you will need to modify the CFLAGS and LIB line of client/Makefile.Linux (read the comments in that file). Now, on with the build... First, run the "configure" script in the main directory. This will do some automatic detection of your system setup, and generate the Makefiles necessary for the next step. To run this script, go to the main directory and type './configure'. Go to the `client' subdirectory. Choose the correct Makefile for your system and type 'make clean;make -f <makefile>' then 'make install'. Important: Before you can run the client, you must install atleast one image set package and the XSW data package. They are available at the same place where you obtained this source package. This program will be installed in /usr/games/. This program's data files will be installed in /usr/share/games/xshipwars/. 5. Install a graphics and (optional) sound set: Image and sound sets are distributed *sperately*. You can obtain them from the same location you obtained this package or from various other fan sites. Untar them in /usr/share/games/xshipwars/. YOU MUST INSTALL ATLEAST ONE IMAGE SET FOR XSW'S CLIENT TO RUN! THE SOUND SET IS OPTIONAL. Image sets typically go in /usr/share/games/xshipwars/images Sound sets typically go in /usr/share/games/xshipwars/sounds 6. (optional) Build the ShipWars Server: Attention: See http://fox.mit.edu/xsw/swservhowto.htm for a more detailed server installation guide. Otherwise, follow the instructions below: Go to the `server' subdirectory. Choose the correct Makefile for your system and type 'make clean;make -f <makefile>' then 'make install'. The server is installed /home/swserv with several subdirectories, they are explained as follows: /home/swserv/bin/ -- ShipWars server and utils. /home/swserv/etc/ -- Configuration files. /home/swserv/db/ -- Universe and data files. /home/swserv/logs/ -- Log files. /home/swserv/public_html/ -- HTML format stats files. /home/swserv/plugins/ -- Plugins. /home/swserv/tmp/ -- Tempory files. 7. (optional) Build the server monitor: Go to the `monitor' subdirectory. Choose the correct Makefile for your system and type 'make clean;make -f <makefile>' then 'make install'. This program will be installed in /home/swserv/bin/. 8. (optional) Build the Universe Editor: Go to the `unvedit' subdirectory. Choose the correct Makefile for your system and type 'make clean;make -f <makefile>' then 'make install'. This program will be installed in /usr/games/. ------- Playing If you are new to XShipWars, then follow the steps in this section to properly initialize the server and client. Make sure the following installation steps have been completed: * Built and installed the XShipWars client. * Installed atleast one image set for the XShipWars client. 1. Edit the XShipWars client configuration file: The XShipWars client configuration file is typically located in your home directory as .xshipwarsrc. Edit this file as needed with a text editor. Make sure that all paths are stated correctly, leave anything else you don't understand alone. 2. Run the XShipWars client: Make sure you are in X and type 'xsw &' on any xterm. Note any error messages and act on them accordingly. If all goes well, the XShipWars client's `bridge window' should appear and also the Universe List window. 3. Additional configuration: Once the XShipWars client is running, go to `options' from the main menu and motify all the settings to your liking. Be sure to edit the keyboard mappings, go to options->general->keyboard maps. Click on OK when you are done (your options will be saved when you exit the XShipWars client). 4. Connecting to the server: When you start up the XShipWars client, you should be automatically presented with the `Universe List' (if you do not see the `Universe List', then click on the `connect' button on the XShipWars client main menu). Choose the universe you want to connect to, a good starting place would be the Generic test universe on dogstar.mit.edu (aka Dogstar or Generic@Dogstar). Double click on the universe entry you want to connect to or right-click on it to modify it. 5. Once you are connected and (automatically) logged in: Type `e' to bring up the Server Command Prompt and type `who' then enter. This will display a list of players currently online. If you can find another newbie, fly up to them and hail them (press the `h' key). Then wait for a response hail or message. If you need to change channels, press `k' then enter the channel frequency. To send a message press the single quote key (') and then enter your message and press enter. To see a list of client (local) commands type `/' then `?' then enter. To see a list of server (remote) commands type `e' then '?' then enter. 6. Disconnecting from the universe. When you want to leave the universe, just press `f10' and disconnect. ------------- Learning More XShipWars is a very versitile and powerful gamming platform, there are many different setup and configuration possibilities. Visit the XShipWars home page for the latest information and documents: XShipWars home page: http://fox.mit.edu/xsw/ XShipWars news page: http://fox.mit.edu/xsw/news.htm XShipWars downlaods page: http://fox.mit.edu/xsw/dl_main.htm You can interact with other ShipWars developers, players, and administrators on the ShipWars list: http://wolfpack.twu.net/contacts.html Bon voryarg~e! :) --------- XShipWars