Difference between revisions of "Sample conf"

From BZFlagWiki
Jump to: navigation, search
(A sample configuration file.)
Line 1: Line 1:
# This is a BZFlag Server (bzfs) configuration file.
# This is a BZFlag Server (bzfs) configuration file.
# It assumes that you wish to connect to the bzflag list server.
# It assumes that you wish to connect to the bzflag list server.
Line 513: Line 513:
# All other path examples given in this file use *nix format
# All other path examples given in this file use *nix format
# Windows users will have to change all the path examples given in this file.
# Windows users will have to change all the path examples given in this file.

Revision as of 14:48, 22 February 2007

  1. This is a BZFlag Server (bzfs) configuration file.
  2. It assumes that you wish to connect to the bzflag list server.
  3. Please read through it carefully. Lines starting with a # are comments.
  4. to enable an option, remove the # at the beginning of a line. To
  5. disable that option, put the # back. There are some examples in this
  6. file. Make sure you change the examples if you uncomment the line. If
  7. you don't know what something does, you are okay to just leave
  8. it commented out. Failure to read through this file (looking for
  9. already uncommented lines) might be a little embarrassing. Have fun.

  1. This option is for debug. You can have as many as 4 of them.
  2. simple debug
  3. -d
  4. and more complex debugging.


  1. -ddd
  2. -dddd
  1. Sets the admin password for the server. It is necessary for server
  2. administration if no groups are used.

-password abcdef

  1. Enables inertia and sets the maximum linear and angular accelerations.
  2. The units are somewhat arbitrary so you'll have to experiment to find
  3. suitable values. The values must be non-negative and higher values
  4. yield greater inertia.
  5. Used to control "Mouse Enhancements"

-a 50 38

    1. World ##
  1. This specifies the world filename.
  2. Use this format for Windows
  3. -world "c:\mymaps\louschurchyard.bzw"
  4. Use this format for *nix and Mac
  5. -world /users/noob/lousdesktop.bzw

    1. Random World Generation ##
  1. This option allows world objects to be randomly rotated. Only applies
  2. if a randomly generated world is used.
  3. -b
  1. Enables capture-the-flag style game with a balanced random map. Default is
  2. free-for-all style game.
  3. -cr
  1. Adds teleporters to the game. for random maps only
  2. -t
  1. This option controls the building density on random worlds(1-10) default is 5
  2. -density 7
  1. This option changes the size of random maps.
  2. -worldsize 800
  1. This option gives buildings random heights. This is used when
  2. you are using random maps.
  3. -h

    1. Game Styles ##
  1. This enables capture-the-flag style game. Default is free-for-all style.
  2. Requires one base object for each team to be specified in the world file.
  3. Can be used with random world generation.
  4. -c
  1. More than one team-flag may be specified.
  2. This is generally not desirable.
  3. B* - Blue Team G* - Green Team, P* - Purple Team, R* - Red Team,
  4. +f B*
  5. +f R*
  1. This sets the maximum number of shots before a reload. The default
  2. is 5.

-ms 3

  1. This makes most shots ricochet.


  1. This option allows jumping.


  1. These two flags can be used if they are not specified as options.
  2. +f R{1} # Ricochet
  3. +f J{1} # Jumping
  1. This option allows for flags on box buildings.
  2. -fb
  1. This option allows tanks to spawn on buildings. This is especially useful
  2. as tank spawn locations are now are calculated on the server without the
  3. advantage of knowing where shots are.
  4. -sb
  1. By default if a player kills a teammate, he dies too, this option turns this
  2. off. Used mostly for capture the flag style games.
  3. -tk
  1. Kick a player if his ratio of teammate to non-teammate kills is this
  2. percentage or greater.

-tkkr 32

  1. This option allows you to tell the server how long a team flag remains
  2. before it is reset after the last player on a team leaves. The default
  3. is 30 seconds.
  4. -tftimeout 60
  1. Hunt the rabbit game is activated with this option.
  2. Use only one of these options.
  3. Choose rabbit based on score.
  4. -rabbit score
  5. Rabbit is chosen by whoever kills the rabbit.
  6. -rabbit killer
  7. Or you can choose the rabbit randomly.
  8. -rabbit random
  1. It is possible to restrict bots and autopilot from being used on the server.
  2. This is accomplished with the following.
  3. -disableBots
  1. This option causes the server to quit after serving one game. This is
  2. handy if you want to do a timed game, or script a rotating server.
  3. -g
  1. This option sets the max score for players. The game ends when a person
  2. reaches this score and is declared the winner.
  3. -mps 100
  1. This sets the max team score. The first team to reach this score is
  2. declared the winner and the game is ended.
  3. -mts 250
  1. This dumps the score to console when it changes.
  2. -printscore
  1. This sets time limit (in seconds) for the game. Time starts when first
  2. client connects.
  3. -time 3600
  1. This option requires a timed game to be started using the /countdown
  2. command to start a timed game. Default is when first player joins.
  3. -timemanual

    1. List server Connection ##
  1. This is the public message that the server advertises on the public
  2. server list. This is required if you want to be shown on the list.
  3. It often advertises the map you are using. Keep it short.

-public "Noo BZFlag Server With Random Map"

  1. This is also needed to be listed on the public server list. The
  2. address needs to be valid in DNS. It's your IP, plus port number.

-publicaddr 123.456.789.000:5154

  1. The server will listen on this port. Default port is 5154.

-p 5154

  1. Tells server not to respond to "pings". This makes the server private.
  2. You should remove -public and -publicaddr when using it.
  3. If your router is open, you can still give people your IP and port, and
  4. they will be able to connect, you just wont be on the list.
  5. -q
  1. You probably don't need to use this, but it is there if you do. This
  2. specifies where the server advertises itself. The built-in default
  3. should work just fine. You need to hunt down the proper address if
  4. it doesn't work. DON'T Change It
  5. -publiclist <list-server-url>
  1. Server will listen for and respond to "pings" (sent via broadcast) on
  2. the given interface. The server uses the first interface by default.
  3. This is the TCP/UDP/IP address the server will listen on.
  4. You don't need to use this unless your server has multiple
  5. interfaces and doesn't show up on the server lists.
  6. -i 123.456.789.000

    1. Player Connections ##
  1. Automatically assigns players to teams when they join so that teams are
  2. evenly matched in number of players. Players are placed on teams with
  3. lowest number of players first, then those with the lowest scores or
  4. kill ratios.


  1. This sets the max number of players. It can be done in 2 ways. A flat
  2. count of players, or by number of players on a given team.
  3. This allows up to 50 players, no team limits.
  4. Typical home DSL connections max out at 12 players before lag begins.
  5. Lag equals players times shots. So a one-shot server could have more
  6. players, and vice-versa.

-mp 12

  1. This allows for max player by team.
  2. The order is rogue, red, green, blue, purple, observer.
  3. -mp 3,3,3,3,3,3
  1. This requires clients to use UDP (a good thing). This will generally
  2. make the server behave better, and make play more smooth.
  3. It will kick players who are unable to establish a UDP connection
  4. when they attempt to fire.


  1. Set to not use a UDP connection for players. You typically do NOT want to
  2. do this (UDP is good!)
  3. -noudp
  1. This option warns the user their lag is too high when it crosses the
  2. number of milliseconds set.

-lagwarn 350

  1. This option kicks players after they have been warned about high lag for
  2. a certain number of times.

-lagdrop 3

  1. This option kicks the user after they have been idle for a number of
  2. seconds. Idle means paused, not-spawning or not-responding.

-maxidle 300

  1. This option sets up your ban list. This is ip masks separated by commas.
  2. The * character is used as a wild card in range bans.
  3. -ban ",10.10.2.*,10.2.*.*"
  1. This option tells the server where to store the ban list. The ban list will
  2. be loaded from this file when the server starts (if the file exists) and
  3. written back to the file when someone gets banned or unbanned. If this
  4. option isn't used the ban list will not be saved.
  5. -banfile /path/to/mybanfile.txt
  1. Registered player files which will be loaded on startup.
  2. Use all three if you are not connecting to the list server.
  3. Players can use /register passwd and /identify passwd
  4. to confirm their identities.
  5. passdb stores local user password mappings.
  6. -passdb /path/to/passes.txt
  7. userdb stores user to group mappings.
  8. -userdb /path/to/users.txt
  1. If you use the BZFlag forums at http://my.bzflag.org/bb
  2. and have established groups there, you only need groupdb
  3. Though local registrations can also be used.
  4. groupdb stores group to permission mappings.
  5. -groupdb /path/to/groups.txt
  1. If you have registered groups at the bzbb forums, only players
  2. in this group will see your server in the list.
  3. -advertise NOOB.COP

    1. General Options ##
  1. This is the server welcome message. Please change it.

-srvmsg " This is a Noo BZFlag Server " -srvmsg " Have Fun and Play Nice "

  1. Define a message which will be broadcast to all players every 15 minutes.

-admsg " Noo BZFlag Server " -admsg " BZFlag is Fun "

  1. This sets the amount of time in seconds that is required to pass between
  2. two identical messages sent.

-spamtime 15

  1. This sets the amount of times to warn spammers (see -spamtime) before they
  2. are kicked.

-spamwarn 3

  1. Specify a file that contains bad words that will be used when
  2. either -filterCallsigns or -filterChat is enabled.
  3. A multilingual badwords file can be found in source downloads.
  4. -badwords /path/to/badwords.txt
  1. Turn on the filtering of chat messages. Messages have words provided
  2. via a -badwords file are replaced with !@#$%^&* characters.
  3. -filterChat
  1. Turn on the filtering of callsigns. Callsigns are compared against
  2. bad words provided via -badwords.
  3. -filterCallsigns
  1. By default, all filtering is aggressive, matching much more than what
  2. is strictly listed in a -badwords file for convenience. Providing this
  3. option will make the -filterCallsigns and -filterChat comparisons
  4. exact match only.
  5. -filterSimple
  1. This forces all clients to use the same time of day. The time is
  2. determined by the server's clock. This disables the + and - keys
  3. on the clients.
  4. -synctime

    1. Player Controlled Functions ##
  1. This option specifies a help file that will be displayed when the player
  2. types /help name
  3. Maximum length is 50 lines and 120 characters per line
  4. -helpfile shock /path/to/shockwavehelp.txt
  5. -helpfile noob /path/to/noobhelp.txt
  1. You can specify a file so that people can type /report to report problems
  2. on the server. The reports are logged in this file.
  3. -reportfile /path/to/reports.txt
  1. You can also use this option to cause the /report to trigger a command
  2. as well as, or instead of, logging to a file.
  3. -reportpipe command
  1. This specifies the number of seconds in which a poll can be vetoed.
  2. -vetoTime 60
  1. This specifies the percentage of people required for a successful vote.
  2. -votePercentage 51
  1. This is the number of voters required to hold a poll.
  2. -votesRequired 6
  1. This is the length of time that players have to vote.
  2. -voteTime 60

    1. Flags ##
  1. This option allows for antidote flags to be available for players who
  2. get bad flags.


  1. Bad flags are automatically dropped after this many seconds.

-st 5

  1. Bad flags are automatically dropped after this many wins.

-sw 1

  1. This allows you to limit the number of shots from a particular flag.
  2. -sl GM 20
  3. -sl L 20
  1. There are two sets of flags. Flags that must be in the world at all times
  2. and flags that may get generated randomly. in addition. +f specifies flags that
  3. must be there and -f specifies flags the should never be generated.
  1. The server will randomly place flags from the following list.
  2. To be sure there is at least a certain amount of a flag on the map
  3. at any given time, you can use the +f option to guarantee a certain
  4. number of a flag.
  1. Good Flags

+f A{2} # Agility +f CL{2} # Cloaking +f F{2} # rapid Fire +f G{1} # Genocide +f GM{2} # Guided Missile +f IB{2} # Invisible Bullett +f L{2} # Laser +f MG{2} # Machine Gun +f N{2} # Narrow +f OO{2} # Oscillation Overthruster +f PZ{2} # Phantom Zone +f QT{2} # QuickTurn +f SB{2} # Super Bullet +f SE{2} # SEer +f SH{2} # SHield +f SR{2} # SteamRoller +f ST{2} # Stealth +f SW{2} # ShockWave +f T{2} # Tiny +f TH{2} # THeif +f US{2} # USeless +f V{2} # Velocity (high speed) +f WG{2} # WinGs


+f B{1} # Blindness +f BY{1} # Bouncy +f CB{1} # Color Blindess +f FO{1} # Forward Only +f JM{1} # Jamming +f LT{1} # Left Turn only +f M{1} # Momentum +f NJ{1} # No Jumping +f O{1} # Obesity +f RC{1} # Reverse Controls +f RO{1} # Reverse Only +f RT{1} # Right Turn only +f TR{1} # Trigger Happy +f WA{1} # Wide Angle

  1. Using "+f good" is the equivalent of doing +f for each of the good flags.
  2. If you want to restrict a certain flag, you can use the -f option.
  3. just like with the +f option. "-f bad" is the same as doing -f for
  4. all of the bad flags.
  5. -f bad #no bad flags
  6. +f good #one of each good flag
  7. -f G #no genocide
  1. Use +s to have the server generate a certain number of extra flags
  2. and have them available at all times. This is in addition to
  3. any other flags specified.
  4. +s 20
  1. The server will have up to this many super flags at any time.
  2. Use this if you don't use any other method of flag generation.
  3. -s 30

    1. Variables ##
  1. And there are three ways to load sets of server-specific variables.
  2. They can be specified in this .conf file.
  3. They can be specified in the .bzw map file in an options block.
  4. Or they can be specified in a third file with this option
  5. -vars /path/to/vars.txt
  1. Server variables can also be modified in-game using
  2. /set _varName value
  3. View the entire variable list by using
  4. /set (with nothing afterward) lists all vars
  5. /diff will list most non-default settings
  6. /? will list other available commands
  1. Here are a few examples of variables.
  2. Some variables are set to 0 for off, 1 for on.
  3. -set _obeseFactor 12
  4. -set _skyColor grey44
  5. -set _wingsJumpCount 3
  6. -set _tankExplosionSize 60
  7. -set _jumpVelocity 20
  8. -set _squishTime 7
  9. -set _mirror grey22
  10. -set _wallHeight 2
  11. -set _shotsKeepVerticalVelocity 1
  12. -set _drawGround 1
  13. -set _drawSky 1
  14. -set _drawClouds 0
  15. -set _drawMountains 0
  16. -set _fogMode exp
  17. -set _fogColor black
  18. -set _fogDensity .01

-set _rainType bubble

    1. Plugins ##
  1. Plugins have mostly superseded patches as a means of modifying
  2. the play of BZFlag servers. Recent improvements in the bzfs2.0.9 have enabled
  3. almost every server functionality to be modified with the plugin API.
  4. Plugins cannot be accessed unless you compile your plugins and
  5. bzfs binary with the option --enable-shared
  6. -loadplugin /path/to/playHistoryTracker
    1. Replay ##
  1. You can set up a server for replay mode by entering this option
  2. -replay
  1. This option sets the recording buffer to the specified amount of megabytes.
  2. -recbuf 2
  1. This option sets the directory to look for and save recordings.
  2. -recdir

    1. More Comments ##
  1. This is intended to include the minimum options for a working
  2. BZFlag server, that is also connected to the list server.
  3. All you need to do is edit your IP numbers in -publicaddr
  4. and start bzfs.
  5. As it connects to the list server, your terminal will show
  6. something that looks like a player has joined, then immediately left.
  7. When you see that happen, you have succeeded, and are listed.
  8. If you can not connect to the list server, you probably need to open
  9. port 5154 through your router, for both UDP and TCP. Instructions for that
  10. are not included here.
  1. You join your server locally, by opening your BZFlag game client
  2. and editing these lines in the JOIN GAME screen.
  3. In the SERVER line add localhost
  4. In the PORT line add 5154
  5. Then JOIN your server.
  1. Here are the short instructions.
  2. Open your router firewall at port 5154
  3. Change the -publicaddr line in this .file to match your IP.
  4. In your terminal, cd to the location of the bzfs binary.
  5. ./bzfs -conf /path/to/sample.conf
  6. Don't take out any # comment markers or add options that you think look cool
  7. until after you have the server working.
  8. The options you need have been included in this file.
  9. You don't even need to specify a map, bzfs will create a random map for you.
  10. You do not even need this .conf file to start a server.
  11. You can use as many options you'd like just typing them into the terminal.
  12. Assuming you have installed BZFlag in default locations.
  13. In Macintosh terminal application these two should work
  14. cd /Applications/BZFlag2.0.8/Contents/MacOS/
  15. ./bzfs -dd
  16. In windows command prompt, these two commands should suffice
  17. cd C:\program files\bzflag2.0.2
  18. bzfs.exe -dd
  19. All other path examples given in this file use *nix format
  20. Windows users will have to change all the path examples given in this file.