This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "BZFS"

From BZFlagWiki
Jump to: navigation, search
(Command line options and Config files: Added list of what this section is useless without. Will try to find some answers and also add them.)
(World Files)
Line 20: Line 20:
  
 
==World Files==
 
==World Files==
BZFS can read in [[BZW]] formated map files and use them to define the 3d world the game is played in.
+
BZFS can read in [[BZW]] formatted map files and use them to define the 3d world the game is played in.
  
 
==Plug-ins and the BZFS API==
 
==Plug-ins and the BZFS API==

Revision as of 01:48, 8 July 2014

This is an article specifically about the BZFS program. For general information on creating a BZFlag server, see Creating A Server.

BZFS is name of the BZFlag server application. It is a command line application that can ether be run manually or started from within the game. The server supports a large list of command line options that can be used. All BZFlag games are hosted on BZFS servers, there is no 'single player' game that is run with only a client.

Public Vs. Private Servers

BZFS can be run in ether a public or private mode. Public servers are listed with the central List Server system and can take advantage of the Global Registration system for user management. Private servers will only be visible on the LAN they are started on. The in-game server menu can only start private servers.

Command line options and Config files

BZFS uses a large number of command line options to set the various modes and options for a game. These options can be specified from the command line prompt of the host OS, or via a text file that is called the 'Config'. BZFS does not ship with a standard config file, it is assumed that the user will make their own. The path (relative or absolute) to the config file is specified with the -conf option. The file referenced by -conf must itself end with a newline or bzfs will complain that the file does not exist Template:Dubious

It may or may not be possible to put comments in the file, starting with an unspecified character(s).

It is not documented whether the options must be one per line, or can all be packed.

It is not documented whether the options must start with "-" as they would on the command line or not.

It is not documented what happens if an option is specified multiple times.

Not even one example is provided.

World Files

BZFS can read in BZW formatted map files and use them to define the 3d world the game is played in.

Plug-ins and the BZFS API

BZFS can be extended by the use of server side Plug-ins. These Plug-ins are runtime loaded DLLs/SO files that use the BZFS API to modify and automate various game logic and settings.

See also

BZFS Command Line Options

BZFS API

Plug-ins

Sample Config File