From 7b9b469310f80b9935e861a294aa2cfa5f82ec3e Mon Sep 17 00:00:00 2001 From: Alex Burger Date: Sun, 20 Oct 2002 21:52:00 +0000 Subject: [PATCH] Updated documentation git-svn-id: http://svn.code.sf.net/p/xqf/code/trunk@282 d2ac09be-c843-0410-8b1f-f8a84130e0ec --- xqf/docs/xqfdocs.html | 1041 +++++++++++++++++++++-------------------- 1 file changed, 538 insertions(+), 503 deletions(-) diff --git a/xqf/docs/xqfdocs.html b/xqf/docs/xqfdocs.html index 69ac58f..02e4eb8 100644 --- a/xqf/docs/xqfdocs.html +++ b/xqf/docs/xqfdocs.html @@ -1,10 +1,10 @@ - + - + XQF Documentation @@ -22,19 +22,19 @@ Jordi Mallach <jordi@debian.org>  

Table of Contents

-
Overview +
Overview

System Requirements

- +

Downloading

- +

Installation / Configuration

- +
RPM Binary package
DEB Binary package
TAR.GZ source code
CVS source code
- Using XQF + Using XQF
Launching XQF
Toolbar

Bottom Status bar
- Menu bar + Menu bar
File
Edit
View
Server
Preferences
Filters
- +

Game Specific Information

- +

Troubleshooting / FAQ
@@ -82,7 +82,7 @@ Heretic 2
Unreal Tournament
Unreal Tournament 2003
Rune
-Descent 3 +Descent 3

Other games that use the 'Gamespy' type master protocol such as
    No one Lives Forever
    Rally Masters
@@ -136,8 +136,8 @@ from the Web


 

XQF can be downloaded as a pre-compiled binary for some distributions, -or as source code. The source code can be downloaded as either a .tar.gz file, -or via CVS.  See the file section of http://www.linuxgames.com/xqffor downloading instructions.
 

@@ -145,68 +145,68 @@ downloading instructions.
/ Compiling
 

RPM Binary -package: -
Make sure QSTAT 2.5b or higher -is already installed +package: +
Make sure QSTAT 2.5b or +higher is already installed

As root, execute the command:

- +

rpm -Uvh xqf-xxx-i386.rpm

DEB Binary package: - -
Make sure QSTAT 2.5b or higher -is already installed + +
Make sure QSTAT 2.5b or +higher is already installed

As root, execute the command:

- +

dpkg -i xqf_xxx-v_arch.deb

TAR.GZ source code - -
Make sure QSTAT 2.5b or higher -is already installed + +
Make sure QSTAT 2.5b or +higher is already installed

Extract the source code:

- +

tar xvfz xqf-xxx.tar.gz

- +

cd into the directory:

- +

cd xqf-*

- +

Run configure script:

- +

./configure

- +

Compile source code:

- +

make

- +

Install compiled binary and man page (this step must be done as root):

- +

make install
 

CVS source code - -
Make sure QSTAT 2.5b or higher -is already installed + +
Make sure QSTAT 2.5b or +higher is already installed

Create the 'configure' script:

- +

./autogen.sh

- +

Run configure script:

- +

./configure

- +

Compile source code:

- +

make

- +

Install compiled binary and man page (this step must be done as root):

- +

make install

- +

The default location for XQF /usr/local/bin.

@@ -216,7 +216,7 @@ is already installed

Launching XQF:

-
+

The first time you launch XQF, it will attempt to search for games in your path.  If any are found, it will automatically configure the command @@ -229,21 +229,21 @@ for more information.

 XQF doesn't accept any command line options at the moment, except for a debug setting.
- -
xqf -d N + +
xqf -d N

Sets debug level to `N', where N is greater than 0. If N is greater than 5, XQF will output a lot of debug information.

- +

XQF is normally installed into /usr/local/bin.  If /usr/local/bin is not in your path, launch xqf with:

- +

/usr/local/bin/xqf -d N

- +

You can also add the directory to your path, or simply make a symbolic link in /usr/bin.  For example, as root:

- +

ln -s /usr/local/bin/xqf /usr/bin/xqf

- +

XQF can be customized via GTK's rc files.  XQF parses files /etc/gtkrc, $HOME/.gtkrc and $HOME/.qf/gtkrc.
 

@@ -251,30 +251,30 @@ $HOME/.gtkrc and $HOME/.qf/gtkrc.

Toolbar:

Update, Refresh, Refresh Selected, Stop, Connect, Observe, Record -S Filter, P Filter, SF Cfg, PF Cfg +S Filter, P Filter, SF Cfg, PF Cfg

Update:

-
+
See 'View - Update from Master'
- Refresh: + Refresh:
See 'View - Refresh'
- Refresh Selected: + Refresh Selected:
See 'View - Refresh Selected'
- Stop: + Stop:
Abort the current task
- Connect: + Connect:
See 'Server - Connect'
- Observe: + Observe:
See 'Server - Observer'
- Record: + Record:
See 'Server - Record Demo'
- S Filter: + S Filter:
Enable the currently selected Server filter
- P Filter: + P Filter:
Enable the currently selected Player filter
- SF Cfg: + SF Cfg:
See 'Preferences - Server Filter'
- PF Cfg: + PF Cfg:
See 'Preferences - Player Filter'
Window Panes: @@ -283,14 +283,14 @@ S Filter, P Filter, SF Cfg, PF Cfg
Left pane:  Source
Top pane:  Server list
Middle bottom pane:  Player list
-Bottom right pane:  Server info +Bottom right pane:  Server info

While in the Server pane:

- +
  • Left double-click launches game on selected server.
  • Right click pops up server option menu.
  • Middle click selects one server and refreshes its information.
    • - +
Bottom status bar: @@ -299,131 +299,139 @@ Bottom right pane:  Server info
Left bar: Current XQF activity
Middle bar: Filter information
Right bar: Moving activity bar
-
+
Menu bar:

File, Edit, View, Server, Preferences

File:

-
Statistics: -
Servers tab: +
Statistics: +
Servers tab:

Display server statistics for all games such as number of servers, # up, times on, # down, # info not available, # of players

- +

O/S tab:

- +

Quake2, Quake3, WolfenStein, Kingpin and Half-Life server statistics based on CPU/architecture and operating system

- +


Exit:

- +
Exit / quit XQF


Edit:
 

-
Add new Server: +
Add new Server:
Add a new server to the Favorites list
- Add to Favorites: + Add to Favorites:
Add the currently selected server(s) to the Favorites list
- Remove from Favorites: + Remove from Favorites:
Delete server entry from Favorites list.  This is only available when viewing the Favorites list.
- Copy: -
Copy basic server information to clip board: - + Copy: +
Copy basic server information to clip board: +

ip:port

- +

Example:

- +

24.101.93.126:27912

- Copy+: -
Copy more detailed server information to clip board: - + Copy+: +
Copy more detailed server information to clip board: +

ping ip:port name map curplayers maxplayers

- +

Example:

- +

0 24.101.93.126:27912 Toronto_NH_BatCave q2dm2 0 of 5

- Add Master: -
Add a master server to the 'Source' pane. - + Add Master: +
Add a master server to the 'Source' pane. +

Enter the name of the master server, the type of game, and the master server address. XQF supports the following types of master servers in the address field:

- +

master://

- +
Considered a standard master server. When XQF calls QSTAT, it will use use QSTAT's standard master support. For example, Quake2 would -use the qstat option '-q2m' +use the qstat option '-q2m' +

Example:

- +

master://q2master.planetquake.com

- gmaster:// + gmaster://
When XQF calls QSTAT, it will use the '-gps' option to query 'Gamespy' style master servers. This will not allow you to query master servers at gamespy.com, as they use an key to only allow Gamespy users to use their -master servers. -

Unreal Tournament uses this type of master server protocol, but -does not require the key.

- +master servers. +

Unreal Tournament uses this type of master server protocol, but does +not require the key.

+

Example:

- +

gmaster://unreal.epicgames.com

- http:// -
Parses html pages for server listings. Common in Quake1, -Quake2, Kingpin and Heretic II. + http:// +
Parses html pages for server listings. Common in Quake1, Quake2, +Kingpin and Heretic II.

Example:

- +

http://www.gameaholic.com/servers/qspy-heretic2
 

- lan:// + lan://
Issues a broadcast search for servers in your LAN. This does not work with all games. UT and Rune use the Gamespy protocol for LAN queries -and will therefore be listed under "Generic Gamespy". - +and will therefore be listed under "Generic Gamespy". +

Example:

- +

lan://255.255.255.255
 

- +

file://

- -
-

??

- + +
+

Parses a list of servers from a local text file that is in the html +master format.

+

Example:

- ??
+file://~/quake3-servers
+file:///home/alex/quake3-servers
+
+ Sample text file:
+
+61.139.69.204:27960
+68.41.236.152:27960
+213.40.130.42:27961
-
Note:  Not specifying a prefix will default to master://
- Rename Master: + Rename Master:
Allow you to change the name of the master.  You can not modify the address or game type.
- Delete Master: + Delete Master:
Removes a master from the Source list
- Find Player: + Find Player:
Search for a player by name using an exact match string, sub string or regular expression.
- Find Again: + Find Again:
Find the next player that matches the previously defined search string.
- Properties: + Properties:
Displays the following server properties:
- +
  • IP address
  • game port
    • @@ -435,7 +443,7 @@ string.
  • server password (if supported for this game)
  • spectator password (if supported for this game)
  • RCon password (if supported for this game)
    • - +
    Number of reserved slots is used by the redial feature to determine how many @@ -445,9 +453,9 @@ in the game, there must be 3 free slots avabilabe (5/8 players in the game) for it to launch the game.

    Server, spectator and RCon password allow you to set the password for that -particular server so you will not be prompted when connecting.  The -password is stored in the configuration file (~/.qf/config).  The selected -game determines which of these options are available.
    +particular server so you will not be prompted when connecting.  The password +is stored in the configuration file (~/.qf/config).  The selected game +determines which of these options are available.

    For custom cfg, enter a custom configuration file to be executed when the game starts.  For example:  custom2.cfg.  If you have specified @@ -456,429 +464,448 @@ both be executed.
    View: -
    Refresh: +
    Refresh:
    Refresh (ping) all servers for the current game / source
    - Refresh selected: + Refresh selected:
    Refresh (ping) all servers for the currently selected / highlighted servers
    - Update from Master: + Update from Master:
    Fetch the latest list of servers from the master server.
    - Show host names: + Show host names:
    Configure XQF to attempt to convert IP addresses to host names.  Also available in Preferences menu.
    - Show default port: + Show default port:
    Configure XQF to display the port next to the IP address if it is considered the default port for the game.  Also available in the -Preferences menu.  +Preferences menu. 

    For example:

    - +

    When on, a Quake2 server on port 27910 would be displayed as:

    - +

    quake2.somedomain.com:27910

    - +

    When off, a Quake2 server on port 27910 would be displayed as:

    - +

    quake2.somedomain.com

    Server: -
    Server Filters: +
    Server Filters:
    Select a custom filter.  The bottom status bar will update showing your selection.  The filter is not activated until you click the 'S Filter' button on the tool bar.
    - Connect: -
    Connect to selected server. + Connect: +
    Connect to selected server. +

    The server is 'pinged / refreshed' before the connection is attempted.  -If the server is found to be down, you will be warned before the game is launched.
    +If the server is found to be down, you will be warned before the game is +launched.

    If the game is busy (no free player slots) you can choose to Launch anyways, Cancel or Redial.  When redialing, XQF will refresh the server every -5 seconds until a free slot is available.  For servers that reserve -slots for administrators, you can define the number of free slots by right -clicking on the server and entering the number of reserved slots.

    - +5 seconds until a free slot is available.  For servers that reserve slots +for administrators, you can define the number of free slots by right clicking +on the server and entering the number of reserved slots.

    +

    If the server has a password set, a password prompt will appear.

    - Observe: + Observe:
    Launches the game in observer / spectator mode. Only effective for some games.
    - Record Demo: + Record Demo:
    Launches game with +record option. Only works in Quake1, Quake2 and Quake3.
    - Add to Favorites: + Add to Favorites:
    Add the currently selected server(s) to the Favorites list.
    - Delete: + Delete:
    Delete server entry from Favorites list.
    - DNS Lookup: + DNS Lookup:
    Attempt to convert IP addresses to host names of the selected servers.
    - RCON: + RCON:
    Remote Console to Quake2 servers. Will be prompted for rcon password.
    - Properties: + Properties:
    See Edit / Properties
    Preferences: -
    General: -
    On Startup -
    Refresh Favorites: - +
    General: +
    On Startup +
    Refresh Favorites: +

    Refresh / ping servers in Favorites when XQF starts

    - On Exit -
    Save Server lists: - + On Exit +
    Save Server lists: +

    Save list of servers when you quit XQF.  Recommended if you have a slow connection

    - +

    Save server information:

    - +

    Save server information such as map name, game type, flags etc when you quit XQF. Recommended if you have a slow connection

    - +

    Save player information:

    - +

    Save list of players and scores when you quit XQF.

    - When Launching a Game -
    Terminate XQF: - + When Launching a Game +
    Terminate XQF: +

    Quit XQF when you launch a game. Not normally necessary unless you areextremely low on RAM

    - +

    Create Launchinfo.txt:

    - +

    A Launchinfo.txt file will be created in the (home directory)/.qf directory. This can be used by external programs such as IRC scripts that notify other people in IRC that you are playing a game.  Usually used in combination with 'Execute prelaunch'.  Saves the same information as Copy+ does:

    - +

    ping ip:port name map curplayers maxplayers

    - +

    Iconify XQF window:

    - +

    Iconify / minimize the XQF window when you launch a game.

    - +

    Execute prelaunch:

    - +

    A file (if exists) PreLaunch will be launched / executed from the (home directory)/.qf directory before launching the game. This can be used -by external programs such as IRC scripts that notify other people in IRC -that you are playing a game.  Usually used in combination with 'Create -Launchinfo.txt'.

    +by external programs such as IRC scripts that notify other people in IRC that +you are playing a game.  Usually used in combination with 'Create Launchinfo.txt'.

    - Games + Games
    For each game supported by XQF there are one or more configuration tabs.  

    - Following are the common options for all games. - + Following are the common options for all games. +

    Invoking:

    - -
    Command Line: - -
    Command to execute the game - + +
    Command Line: + +
    Command to execute the game +

    Example: quake2

    - - + +

    The Suggest button will search for the game in the path and is found, will populate the command line.  Does not work with all games.

    - Working directory: -
    Directory to run the game from - + Working directory: + +
    Directory to run the game from +

    Example: /games/quake2

    - +
    Disable sound:
    - -
    + +
    Disable sound if the game supports the option on the command line. For example, Quake2 would be called with the

    +nosound switch
    - +
    Disable CD audio:
    - -
    + +
    Disable cd audio if the game supports the option on the command line. For example, Quake2 would be called with the

    +nocd switch
    - +

    Following are the game specific options for all games:

    - +

    Quake

    - +
    Invoking:
    -     +
    Custom CFG:
    - +
    Enter a custom configuration file to be executed when the game starts.  For example:  custom.cfg
    - -
    Player Profile - + +
    Player Profile +
    Enter your player name. Can also define your player's colour, skin or model
    QuakeWorld
    -     +
    Weapons
    - -
    + +
    The highest weapon that Quake should switch to
    - -
    -
    upon a weapon pickup: - -
    Choose the highest weapon that Quake should switch -to when you pick up a new weapon. Passed to Quakeworld as the 'setinfo w_switch -x' switch
    - upon a backpack pickup: - -
    Choose the highest weapon that Quake should switch -to when you pick up a backpack. Passed to Quakeworld as the 'setinfo b_switch -x' switch
    - Disable auto-aiming: - -
    Disable automatic aiming + +
    + +
    upon a weapon pickup: +
    Choose the highest weapon that Quake should switch to +when you pick up a new weapon. Passed to Quakeworld as the 'setinfo w_switch +x' switch
    + upon a backpack pickup: + +
    Choose the highest weapon that Quake should switch to +when you pick up a backpack. Passed to Quakeworld as the 'setinfo b_switch +x' switch
    + Disable auto-aiming: + +
    Disable automatic aiming +

    This is passed to Quakeworld as the 'noaim' switch.

    - -
    Options: + +
    Options: +
    Skins:
    - -
    -
    Use skins: - + +
    + +
    Use skins: +

    Allow skins to be used during the game.

    - + +

    Don't use skins:

    - + +

    Disable skins.  This is passed to Quakeworld as the 'noskins' switch.

    - + +

    Don't download new skins:

    - -

    QuakeWorld and Quake2 can automatically download skins from -servers you play on if you donot already have the skins on your computer.  -This options disables the downloading of skins.

    + + +

    QuakeWorld and Quake2 can automatically download skins from servers +you play on if you donot already have the skins on your computer.  This +options disables the downloading of skins.

    - +
    Rate:
    - -
    + +
    +
    This controls network packets so that your connection bandwidth does not get saturated.  Lowering the number reduces the number of packets sent / received.  Slower connections should use a lower rate -setting. - +setting. +

    Default is 2500.

    - + +

    This is passed to Quakeworld/Quake2 as the 'noaim' switch.

    - -
    Pushlatency: - -
    Do not set (use game default) - + +
    Pushlatency: + +
    Do not set (use game default) +
    Use whatever the Quakeworld default is
    - Automatically calculate from server ping time - -
    Use the following formula to determine pushlatency -setting. - + Automatically calculate from server ping time + +
    Use the following formula to determine pushlatency setting. + +

    If ping is <= 0, set to 10 (minimum)

    - - + +

    If ping is >= 2000, set to 1000 (maximum)

    - - + +

    Otherwise, set to (((ping / 2) +9 ) / 10 ) * 10

    - - + +

    This is passed to Quakeworld as the 'pushlatency' switch.

    - Fixed value - + Fixed value +
    Enter a value to be passed to Quakeworld
    - Troubleshooting: - + Troubleshooting: +

                        Disable delta-compression (cl_nodelta)

    - +

                             ??

    - +

                        Disable player/entity prediction (cl_predict_players)

    - +

                             ??

    - +
    Player Profile:
    - -
    -
    Name - + +
    +
    Name +
    Enter your player name. Can also define your player's team, skin and colors.  Uses pictures from your Quake directory.
    Quake2

    -     +
    Invoking:
    - +
    Custom CFG:
    - +
    Enter a custom configuration file to be executed when the game starts.  For example:  custom.cfg
    - +
    Options:
    -     +
    Skins:                    - -
    Use skins: - + + +
    Use skins: +

    Allow skins to be used during the game.

    - + +

    Don't use skins:

    - + +

    Disable skins.  This is passed to Quakeworld as the 'noskins' switch.

    - + +

    Don't download new skins:

    - -

    QuakeWorld and Quake2 can automatically download skins from -servers you play on if you donot already have the skins on your computer.  -This options disables the downloading of skins.

    - + + +

    QuakeWorld and Quake2 can automatically download skins from servers +you play on if you donot already have the skins on your computer.  This +options disables the downloading of skins.

    + +
    Rate:
    -This controls network packets so that your connection bandwidth does not get -saturated.  Lowering the number reduces the number of packets sent / -received.  Slower connections should use a lower rate setting. - +This controls network packets so that your connection bandwidth does not +get saturated.  Lowering the number reduces the number of packets sent +/ received.  Slower connections should use a lower rate setting. +

    Default is 2500.

    - + +

    This is passed to Quakeworld/Quake2 as the 'noaim' switch.

    - Troubleshooting: - + Troubleshooting: +

                        Disable delta-compression (cl_nodelta)

    - +

                             ??

    - +

                        Disable player/entity prediction (cl_predict_players)

    - +

                             ??

    - -
    -
    Player Profile: - -
    Name - + +
    +
    Player Profile: + +
    Name +
    Enter your player name
    - +


    Model / Skin

    - +
    Define your player's model and skin.  Uses pictures from your Quake2 directory.
    Quake3: Arena

    -     +
    Invoking:
    - +
    Custom CFG:

    +
    Enter a custom configuration file to be executed when the game starts.  For example:  custom.cfg
    - +
    Options:
    - -
    Master server protocol version: - + +
    Master server protocol version: +
    Passes the defined protocol version to QSTAT when finding -servers.  Each patch for Quake3 usually changes this value. - -

    This is passed to QSTAT as -q3m,## where ## is the protocol version.  -Defaults to 68 (v1.32).

    +servers.  Each patch for Quake3 usually changes this value. + +

    This is passed to QSTAT as -q3m,## where ## is the protocol +version.  Defaults to 68 (v1.32).

    - vm_cgame_fix: - + vm_cgame_fix: +
    Sets command line options to make Quake3 prefer QVM to shared objects (.so).  This should only be required if there are .so files from an older release floating around in baseq3.
    - Rocketarena fix: - + Rocketarena fix: +
    Sets command line options to make Quake3 prefer shared -objects (.so) to QVM.  Rocket Arena uses shared objects.  Only affects -Rocket Arena (game type of arena).
    - set fs_game on connect: - -
    XQF will pass the game directory the server is using on -the command line to ensure the game launches and connects properly.
    +objects (.so) to QVM.  Rocket Arena uses shared objects.  Only +affects Rocket Arena (game type of arena).
    + set fs_game on connect: + +
    XQF will pass the game directory the server is using +on the command line to ensure the game launches and connects properly.
    - set cl_punkbuster on connect: - -
    Sets command line options to ensure cl_punkbuster is set -to 1 if the server has it enabled (server punkbuster variable)
    + set cl_punkbuster on connect: + +
    Sets command line options to ensure cl_punkbuster is +set to 1 if the server has it enabled (server punkbuster variable)
    Memory
    - +
    Pass memory settings on command line:
    - +
    Enable or disable the passing of the memory options specified below
    com_hunkmegs, com_zonemegs, com_soundmegs, cg_precacheddmodels:
    - +
    Allow you to set the values passed for each of the above variables.
    Preset values:
    - +
    Click a button to set the memory options based on the amount of memory you have, or the defaults.
    @@ -886,114 +913,119 @@ amount of memory you have, or the defaults.
    Wolfenstein

    -     +
    Options:
    - -
    -
    Master server protocol version: - + +
    +
    Master server protocol version: +
    Passes the defined protocol version to QSTAT when finding -servers.  Each patch for Wolfenstein usually changes this value. - -

    This is passed to QSTAT as -q3m,## where ## is the protocol version.  -Defaults to 59 (v1.32)

    +servers.  Each patch for Wolfenstein usually changes this value. + +

    This is passed to QSTAT as -q3m,## where ## is the protocol +version.  Defaults to 59 (v1.32)

    - +
    set fs_game on connect:
    - -
    XQF will pass the game directory the server is using on -the command line to ensure the game launches and connects properly.
    + +
    XQF will pass the game directory the server is using +on the command line to ensure the game launches and connects properly.
    Voyager Elite Force
    -     +
    Options:
    - -
    -
    Master server protocol version:
    -
    +
    +
    Master server protocol version:
    + +
    Passes the defined protocol version to QSTAT when finding servers.  Each patch for Voyager Elite Force usually changes this value. - -

    This is passed to QSTAT as -q3m,## where ## is the protocol version.  -Defaults to 24.

    + + +

    This is passed to QSTAT as -q3m,## where ## is the protocol +version.  Defaults to 24.

    - -
    + +
    set fs_game on connect:
    - -
    -
    XQF will pass the game directory the server is using on -the command line to ensure the game launches and connects properly
    + +
    +
    XQF will pass the game directory the server is using +on the command line to ensure the game launches and connects properly
    - Tribes 2 - Player Profile: -
    Login Name: - + Tribes 2 - Player Profile: +
    Login Name: +
    Login name to use to log into Tribes 2.  If present, it will be passed on the command line.  To prevent a password prompt, you must save your password inside of Tribes 2.
    - Appearance -
    Server List: -
    Show host names: - + Appearance +
    Server List: +
    Show host names: +
    Attempt to convert IP addresses to host names.
    - Show default port: + Show default port: +
    Configure XQF to display the port next to the IP address if it is considered the default port for the game.  Also available in -the Preferences menu. +the Preferences menu. +

    For example

    - +

    When on, a Quake2 server on port 27910 would be displayed as:

    - +

    quake2.somedomain.com:27910

    - +

    When off, a Quake2 server on port 27910 would be displayed as:

    - +

    quake2.somedomain.com

    - Sort servers real-time during refresh: - + Sort servers real-time during refresh: +
    Sort servers names while refreshing the list.
    - Refresh on Update: + Refresh on Update: +
    Automatically refresh server list after updating list of servers.
    - Show only configured games: - + Show only configured games: +
    If enabled, will only show games in the Source column that have a command line configured.  
    - +
    - +
    - Toolbar: -
    Icons / Text / Both - + Toolbar: +
    Icons / Text / Both +
    Show top toolbar as icons, text or icons/text
    - Tooltips: + Tooltips:
    Enable or disable tooltips. Gives a description of a button when you hold the mouse pointer over it for a couple seconds
    - Qstat: -
    Qstat Options: + Qstat: +
    Qstat Options:
     
    - Number of simultaneous servers to query - + Number of simultaneous servers to query +
    How many servers QSTAT should query at once. This number is passed to QSTAT as the -maxsim switch.  Defaults to 20.  Increase if you have a high speed connection.
    - Number of retries + Number of retries +
    Number of times QSTAT should retry a server. This number is passed to QSTAT as the -retry switch.  Defaults to 3

    @@ -1001,25 +1033,25 @@ is passed to QSTAT as the -retry switch.  Defaults to 3
    Sounds: 
    -     +
    Sound Enable / Disable  
    - -
    -
    + +
    +
    - Enable Sound + Enable Sound
    Enable or disable the playing of sounds in XQF when an event occurs.
    Player Program
    - +
    The full pathname of the program used to play sounds.  For example:  

    /usr/bin/play
    - Sounds + Sounds
    Enter the sound file to play for each event.   If the entry does not start with a /, the user's ~/.qf/ directory is assumed.  For example:
    @@ -1031,69 +1063,73 @@ sounds/stop.wav             &n             (same as ~/.qf/sounds/stop.wav)

    Note:  You may experience sound blocking problems depending on the programs -you are running.  For example, while playing a song with XMMS, play (sox) -waits until XMMS is finished.  Results may vary depending on your system.
    +you are running.  For example, while playing a song with XMMS, play +(sox) waits until XMMS is finished.  Results may vary depending on your +system.
    Filters:
    Server:
    - +
    Server filters can be used to reduce and or fine tune the servers listed.  An unlimited number of custom filters can be defined.

    -To create a new filter, click New.  To select an existing filter to edit, -click the top left menu selector and select the filter.
    +To create a new filter, click New.  To select an existing filter to +edit, click the top left menu selector and select the filter.

    The current filter can be renamed or deleted by clicking the Rename or Delete buttons.

    The following options can be defined for each filter:
    - +

    Server would pass filter if:

    - -
    ping is less than: - + +
    ping is less than: +
    The server's ping must be less than this number to be displayed
    - The number of retries is fewer than: - + The number of retries is fewer than: +
    If XQF must retry more than this number to contact a server, remove it from the list
    - It is not full: + It is not full: +
    The server has room for another player
    - Is not empty: + Is not empty: +
    Has someone playing on it.  BOTS on the server are considered as players
    - Cheats are not allowed: - + Cheats are not allowed: +
    Cheats is not enabled on the server
    - No password required: - + No password required: +
    Server is a public access server
    - Filter Name (For Menu): - + Filter Name (For Menu): +
    Name of filter as listed in the Server - Server Filters menu
    - The game contains the string: - + The game contains the string: +
    Enter text that must be in the game name.  For example: 'arena'
    - The Game Type contains: - + The Game Type contains: +
    Enter text that must be in the game name.  For example: 'ctf'
    - The version contains the string: - + The version contains the string: +
    Only servers that have the text in the 'version' variable
    -
    Player: +
    Player:
    Player filters can be used to help you find your friends on servers.  Each player defined has a colour assigned to it - red, green -or blue.  The server list will display the coloured dot next to the server -name if the player is found on that server. +or blue.  The server list will display the coloured dot next to the +server name if the player is found on that server. +

    Click 'New' and enter a player name using an exact match (string), a partial match (substing) or by using a regular expression.

    @@ -1108,123 +1144,121 @@ Information
     
    Following are notes on using specific games with XQF.  Most games should work with basic setup in XQF, but some may require special configuration.
    -
    Quake3: +
    Quake3:
    Under Preferences - Games, enter the 'command line' and 'working -directory'. Nothing special is normally needed. - -

    QUAKE 3 ARENA SPECIAL INSTRUCTIONS (AKA HACK) for v1.17 and -1.27

    - +directory'. Nothing special is normally needed. + +

    QUAKE 3 ARENA SPECIAL INSTRUCTIONS (AKA HACK) for v1.17 and 1.27

    +

    This may also apply to newer versions of Quake3 as they are released.

    - -

    In Q3A, clients and servers can only talk with each other if they -are using the same protocol.  The protocol in Q3A is defined by a  -number.  So, for instance, Q3A 1.17 uses  protocol 45 wile 1.27 -uses protocol 48.  During the switch-over time after ID releases a new -point release, it can be  frustrating to not be able to connect to any -server one wants. However, if you have lots of disk space, it is possible -to get around this problem.

    - + +

    In Q3A, clients and servers can only talk with each other if they are +using the same protocol.  The protocol in Q3A is defined by a  number.  +So, for instance, Q3A 1.17 uses  protocol 45 wile 1.27 uses protocol +48.  During the switch-over time after ID releases a new point release, +it can be  frustrating to not be able to connect to any server one wants. +However, if you have lots of disk space, it is possible to get around this +problem.

    +

    I (Bill 'EvilBill' Adams) will outline what I did to get it so I can play both 1.17 and 1.27 Q3A games without much fuss.
    -For reference, my Q3A is installed under /usr/local/games/... and I have -a symlink from /usr/local/bin/quake3 to ../games/quake3/quake3.

    - +For reference, my Q3A is installed under /usr/local/games/... and I have a +symlink from /usr/local/bin/quake3 to ../games/quake3/quake3.

    +

    (1) Rename /usr/local/games/quake3 (as I used to have it) to /usr/local/games/quake3-1.17.

    - +

    (2) mkdir /usr/local/games/quake3; cd /usr/local/games/quake3

    - +

    (3) cp -Rav ../quake3-1.17 .

    - +

    (4) Install the point release, copy all of the TA pk3 files into baseq3.  Remove any old mods from 1.17.

    - +

    (5) cd..; mv quake3 quake3-1.27

    - -

    (6) Edit both of the quake3 scripts so the directories all -match, here is the script I use for 1.17: (/usr/local/games/quake3-1.17/quake3) -

    - + +

    (6) Edit both of the quake3 scripts so the directories all match, +here is the script I use for 1.17: (/usr/local/games/quake3-1.17/quake3) +

    +

    ==begin==
    #!/bin/sh
    # Needed to make symlinks/shortcuts work.
    # Run Quake III with some default arguments

    - +

    LD_LIBRARY_PATH="/usr/local/games/quake3-1.17"
    export LD_LIBRARY_PATH

    - +

    cd "/usr/local/games/quake3-1.17"
    quake="./quake3.x86"
    "$quake" +set in_dgamouse 1 $*
    exit $?
    ==cut==

    - -

    (7) [as root], cd into /usr/local/bin.  Make symlinks -for each of the Q3A directories that correspond to the protocol each uses. -So:

    - + +

    (7) [as root], cd into /usr/local/bin.  Make symlinks for +each of the Q3A directories that correspond to the protocol each uses. So:

    +

      ln -s ../games/quake3-1.17 quake3proto45
      ln -s ../games/quake3-1.27 quake3proto48
      ln -s ../games/quake3-1.27 quake3

    - +

    Note the last one is there as the default.

    - +

    (8) Get a very (CVS) recent version of xqf. You will need >=0.9.6e-beta. Set up the executable for quake3 such that it is the FULL path to  quake3, -in my case I entered /usr/local/bin/quake3.  This is VERY important -because of the hack I used where I put 'protoNN' on the end of whatever you -entered for the program and see if xqf can fopen it.  Without the full -path, chances are that xqf will not find it.

    - +in my case I entered /usr/local/bin/quake3.  This is VERY important because +of the hack I used where I put 'protoNN' on the end of whatever you entered +for the program and see if xqf can fopen it.  Without the full path, +chances are that xqf will not find it.

    +

    If you have problems, run xqf with "-d 5" on the command line.  This will give you some hints as to that which it is looking.
     

    - Soldier of Fortune (1.06): + Soldier of Fortune (1.06):
    Create a script in your sof directory called 'startsof-xqf' -that contains: ./sof +set console 1 +won_login username password $* - +that contains: ./sof +set console 1 +won_login username password $* +

    Replace username and password with your WoN username and password

    - +

    Make the script executable with: chmod +x startsof-xqf

    - +

    Under Preferences - Games, enter startsof-xqf for 'command line' and enter the directory sof is installed in for 'working directory'.

    - +

    When you connect to a server, SoF will authenticate to WoN and you will have to click 'OK' to the hopefully successful login screen.  You should then be connected to the selected server

    Soldier of Fortune 2:
    - +
    Qstat 2.5b supports Soldier of Fortune 2 by using a ,qstatrc configuration file (normally stored in your home directory).  You must properly install qstat with the qstatrc configuration file for XQF to work with this game.  See the qstat documentation for more information.

    - Unreal Tournament (436): + Unreal Tournament (436):
    Inside of the directory where Unreal Tournament is installed, backup your ut file: cp ut ut.org (ut is a script that finds and launches -ut-bin) +ut-bin)

    Edit the ut file and change the line near the bottom from exec "./ut-bin" -log $* to exec "./ut-bin" $* -log

    - +

    (-log and $* need to be swapped)

    - +

    Make sure you are using XQF 0.9.5a-beta or later

    - +

    Under Preferences - Games, enter ut for 'command line' and enter the directory UnrealTournament is installed in for 'working directory'.

    - +

    Unreal Tournament 2003:

    - +
    Qstat 2.5b supports Unreal Tournament 2003 by using a .qstatrc configuration file (normally stored in your home directory).  The configuration file supplied by qstat 2.5b does not include support for Unreal Tournament @@ -1241,12 +1275,12 @@ gametype UT2M new extend Q3M
    end

    - +

    - Half-Life: + Half-Life:
    Nothing special required anymore, just enter a command that launches a normal Half-Life such as:
    - +
    wine hl.exe -- hl.exe -console
    You should no longer need to specify a special script to launch Half-Life.
    @@ -1278,7 +1312,7 @@ enter the directory where the script is located for 'working directory'. a script in the How-To section that can be easily modified to suite your configuration. --> - Descent 3: + Descent 3:
    Descent 3 does not currently launch from XQF.  This appears to be a problem with the Descent3 program, and not XQF.  Descent3 for Linux does not accept connections to servers from the command line.
    @@ -1288,24 +1322,24 @@ Linux does not accept connections to servers from the command line.
    Please report problems to the XQF home page Forum at http://www.linuxgames.com/xqfor the user mail list at http://sourceforge.net/projects/xqf. - -

    Most problems can be solved by deleting the '.qf' directory in your home -directory.  This directory contains the configuration of XQF including + +

    Most problems can be solved by deleting the '.qf' directory in your +home directory.  This directory contains the configuration of XQF including game preferences, server lists, player lists etc.

    - -

    Q: When I refresh or update a list, all servers come back with a ping -of 'n/a'

    - -

    A:  Make sure qstat is in your path.  Go to a -shell and type qstat.  If a screen full of qstat command options + +

    Q: When I refresh or update a list, all servers come back with a +ping of 'n/a'

    + +

    A:  Make sure qstat is in your path.  Go to +a shell and type qstat.  If a screen full of qstat command options does not appear, qstat is not installed, or it is not in your path.  After compiling QStat, copy qstat to the /usr/bin directory.  See the QStat home page for installation instructions.

    - +

    Q: QStat is installed, but when I refresh or update a list, all servers come back with a ping of 'n/a'

    - +

    A:  If you are behind a firewall such as a LinkSys or Dlink router, or are using filtering on your machine (iptables or ipchains) you are probably blocking the game's traffic from entering your computer.  @@ -1313,44 +1347,44 @@ Games generally use UDP, not TCP.  Because of this, your firewall needs special configuration.  Search the internet for 'gamenamefirewall port' and you should find something helpfuhttp://www.gimp.org/http://www.gimp.org/l.

    - +

    Q:  When I try to launch XQF, I get 'command not found'

    - +

    A:  XQF is not in your path.  See the Launching XQF section

    - +

    Q:  I have added master0.gamepy.com to XQF, but I can not retreive any servers from that master

    - +

    A:  Gamespy's master servers use an authentication sequence that is not supported by QStat.  This means that you can not query a Gamespy master using QStat and XQF.  Other games such as Unreal Tournament use the Gamespy style master server but do not require authenticatoin which is why they work

    - +

    Q:  I deleted one of the default master servers.  How do I get it back?

    - +

    A:  Edit - Add Default Masters to add ALL the default master -servers back into the list.  If you know the address, you can add a -single master with Edit - Add Master

    - +servers back into the list.  If you know the address, you can add a single +master with Edit - Add Master

    +

    Q: Why do LAN searches not find any servers?

    - +

    A: You either need a default route to your ethernet device or a host route for the broadcast address (try e.g. route add -host 255.255.255.255 eth0).

    - -

    Q: My game is not launching properly.  What do I do?

    +

    Q: My game is not launching properly.  What do I do?

    +

    A: The command line arguments passed by XQF may not be correct due to a configuration problem or maybe a bug.  Launch XQF from a command prompt using:

    - +

    xqf -d 1

    - +

    and 'Connect' to the server.  The command line used by XQF to launch the game will be displayed in the console.  Use that to figure out what is wrong.  If you can determine it is a but, please fill out a bug report @@ -1371,5 +1405,6 @@ at sourceforge.net/projects/xqf

    +