XShipWars 2.5.x Client Manual

[ Home | Download | Contributions | Universes | Documentation | Contacts & Mailing List ]

Contents

• Command Line Arguments
  • X GUI Options
• Files & Directories
  • Configuration Files
  • Graphic Files
  • Sound Files
• Windows
  • Bridge Window
  • Large Message Window
  • Universe List Window
  • Economy Window
• Controls
  • Keyboard
  • Joystick
  • Pointer
• Client Commands
  • aint
  • con
  • discon
  • exit
  • help
  • int
  • lname
  • log
  • lpass
  • mem
  • refresh
  • script
  • set
  • synctime
  • version

• X GUI Options

Usage: xsw [url] [options] [GUI_options]

    [url] is the URL to the universe that you want to connect to.

    [options] can be any of the following:

        --cfgfile <file>        Load configuration from <file>.
        --rcfile <file>         Same as --cfgfile.
        -f                      Same as --cfgfile.
        --control <type>        Specify which controller to use:
                                   keyboard
                                   joystick
        -c                      Same as --control.
        --help                  Prints (this) help screen and exits.
        --version               Prints version information and exits.

    Most customizations can be performed in the options menu.

    Command line options override any options in the
    configuration file.

    [GUI_options] can be any options standard to your GUI, consult
    your GUI's manual for available options.

Go to: [ Contents ]

Go to: [ Command Line Arguments | Contents ]

• Configuration Files
• Graphic Files
• Sound Files

Go to: [ Files & Directories | Contents ]

Go to: [ Files & Directories | Contents ]

Go to: [ Files & Directories | Contents ]

• Bridge Window
• Large Message Window
• Universe List Window
• Economy Window

Bridge Window

This is the main window which displays the interface to control your vessel.

View Screen (center window) displays the surroundings of your vessel in a overhead view. The viewscreen camera position can be zoomed in and out or auto zoomed to fit by containature with a referanced subject object. When you are not connected, the viewscreen displays the main menu. See controls for a list of control functions.

Players stats console (left column window) displays the condition and information about your vessel. See controls for a list of control functions.

Subject stats console (right column window) displays the condition and information about the object that your scanning. See controls for a list of control functions.

Scanner (upper right window) shows the objects visable on your vessel's scanner. Use the scale bar on the right edge to change the scanner `zoom'. See controls for a list of control functions.

Message box (lower horizontal window) displays the messages recieved from the universe and client responses statements.

Go to: [ Client Windows | Contents ]

Larger display of the contents in the message box on the bridge window. To map this window press Button3 on the bridge window's message box.

See controls for a list of control functions.

Go to: [ Client Windows | Contents ]

Universe List Window

Lists the universes that you have bookmarked.

To map this window click on connect from the main menu.

Double clicking on the universe entry will connect to that universe. Pressing Button3 over an entry selects it and maps the menu, from there you can add, edit, and delete universe entries.

You can also change the order of the universes by dragging the entries around.

Universe entries are stored in the file .shipwars/universes located in your home directory.

Go to: [ Client Windows | Contents ]

Economy Window

Buying and selling are performed in this window.

To map this window, first select an object that you want to buy or sell from/to and then press Button3 over the viewscreen and go to Economy....

Proprietor object specifies the object that all information and transactions to take place are in relation to. You can manually enter a different object name in its place and click on refresh to obtain a new listnig for that object (provided it exists).

Tax specifies the tax value that is to be applied to all purchases and sells.

The product list window lists all available products on the proprietor object.

Sell price specifies the price per 1 unit quantity of the product when the customer sells to the proprietor.

Buy proce specifies the price per 1 unit quantity of the product when the customer buys from the proprietor.

Quantity specifies the amount of product quantity for the transaction. If the product is of whole unit quantity, then the lower rounded whole unit product amount will be used.

The buy button buys the selected product in the amount specified in quantity from the proprietor to the customer.

The sell button sells the selected product in the amount specified in quantity to the proprietor from the customer.

Go to: [ Client Windows | Contents ] <

• Keyboard
• Joystick
• Pointer

Go to: [ Controls | Contents ]

Joystick

To map your joystick go to Options... and set the Controller Type to Joystick, then click on Apply. Next, click on Map Joystick, you should then see the Joystick Map Window (as shown on the right).

Axises are moveable parts on your joystick, most notibly the main stick moves in two directions (three directions for the Saitek Cyborg 3D for example). The throttle and hats are also considered axises, you may have more or less axises depending on the design of your joystick and the support of the joystick driver. The axis numbers start from 0, axis numbers 0 and 1 are usually the x and y axises (respecivly). The rotate (for 3D sticks) and throttle axises are usually axis numbers 2 and 3 (respectivly). Consult your joystick driver set up and your joystick manual for the exact axis information. Setting an axis number to -1 implies that no axis is to perform that operation.

Buttons are clickable surfaces which have two positions (pressed and released), note that hats are not considered buttons but rather as axises. Each button can generate a keycode, this keycode is treated as if it were a key pressed (and released) from the keyboard (but no auto-repeat, unless your joystick has that as a hardware feature). Each keycode performs operations set by the keymappings, so make sure you have them configured to your liking first.

The joystick calibration file is typically stored in the .joystick file located in your home directory.

To calibrate your joystick, exit the XShipWars client first and then run jscalibrator to calibrate your joysticks.

Go to: [ Controls | Contents ]

Controlling the vessel with the pointer is currently not supported. However, the pointer can still be used to click on most of the buttons on the bridge window's consoles, scanner, and viewscreen.

Holding down the SHIFT key and clicking on a button often performs an alternate function (such as decreasing a value instead of otherwise increasing it).

In cases where a label's value has a positive and a negative incremental capability, clicking on the upper half of the label increments it and the lower half decrements it.

In addition to the above, clicking on the various labels and icons on the player and subject console panels will perform various corresponding actions. Holding down the SHIFT key while clicking will also produce alternate or accelerated affect.

Pressing Button2 over the picture of the player or subject vessel will print its statistics to the message box.

Go to: [ Controls | Contents ]

• aint
• con
• discon
• exit
• help
• int
• lname
• log
• lpass
• mem
• refresh
• script
• set
• synctime
• version

1. Press / on the bridge window (a prompt will then appear).
2. Type in a client command (listed below).
3. Press ENTER.

Go to: [ Client Commands | Contents ]