This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Sample conf"
From BZFlagWiki
m (Fixed formatting with the comment symbols) |
(update) |
||
(30 intermediate revisions by 16 users not shown) | |||
Line 1: | Line 1: | ||
− | < | + | <pre> |
− | + | # This is a BZFlag Server (bzfs) configuration file. | |
− | + | # It assumes that you wish to connect to the bzflag list server. | |
− | + | # Please read through it carefully. Lines starting with a # are comments. | |
− | + | # to enable an option, remove the # at the beginning of a line. To | |
− | + | # disable that option, put the # back. There are some examples in this | |
− | + | # file. Make sure you change the examples if you uncomment the line. If | |
− | + | # you don't know what something does, you are okay to just leave | |
− | + | # it commented out. Failure to read through this file (looking for | |
− | + | # already uncommented lines) might be a little embarrassing. Have fun. | |
− | + | ||
− | + | ||
− | + | ||
− | + | # This option is for debug. You can have as many as 4 of them. | |
− | + | # simple debug | |
− | + | #-d | |
− | -dd | + | # and more complex debugging. |
− | + | -dd | |
− | + | #-ddd | |
− | + | #-dddd | |
− | + | ||
− | + | # Sets the admin password for the server. It is necessary for server | |
− | + | # administration if no groups are used. | |
− | -password abcdef | + | # CHANGE THIS! |
− | + | #-password abcdef | |
− | + | ||
− | + | # Enables inertia and sets the maximum linear and angular accelerations. | |
− | + | # The units are somewhat arbitrary so you'll have to experiment to find | |
− | + | # suitable values. The values must be non-negative and higher values | |
− | + | # yield greater inertia. | |
− | -a 50 38 | + | # Used to control "Mouse Enhancements" |
− | + | -a 50 38 | |
− | + | ||
− | + | ||
− | + | ## World ## | |
− | + | ||
− | + | # This specifies the world filename. | |
− | + | # Use this format for Windows | |
− | + | #-world "c:\mymaps\louschurchyard.bzw" | |
− | + | # Use this format for *nix and Mac | |
− | + | #-world /users/noob/lousdesktop.bzw | |
− | + | ||
− | + | ||
− | + | ## Random World Generation ## | |
− | + | ||
− | + | # This option allows world objects to be randomly rotated. Only applies | |
− | + | # if a randomly generated world is used. | |
− | + | #-b | |
− | + | ||
− | + | # Enables capture-the-flag style game with a balanced random map. | |
− | + | # Default is free-for-all style game. | |
− | + | #-cr | |
− | + | ||
− | + | # Adds teleporters to the game. for random maps only | |
− | + | #-t | |
− | + | ||
− | + | # This option controls the building density on random worlds(1-10) | |
− | + | # Default is 5 | |
− | + | #-density 7 | |
− | + | ||
− | + | # This option changes the size of random maps. | |
− | + | #-worldsize 800 | |
− | + | ||
− | + | # This option gives buildings random heights. This is used when | |
− | + | # you are using random maps. | |
− | + | #-h | |
− | + | ||
− | + | ||
− | + | ## Game Styles ## | |
− | + | ||
− | + | # This enables capture-the-flag style game. Default is free-for-all style. | |
− | + | # Requires one base object for each team to be specified in the world file. | |
− | + | # Can be used with random world generation. | |
− | + | #-c | |
− | + | ||
− | + | # More than one team-flag may be specified. | |
− | + | # This is generally not desirable. | |
− | + | # B* - Blue Team G* - Green Team, P* - Purple Team, R* - Red Team, | |
− | + | #+f B* | |
− | + | #+f B* | |
− | + | ||
− | -ms 3 | + | # This sets the maximum number of shots before a reload. |
− | + | # Default is 5. | |
− | + | -ms 3 | |
− | +r | + | |
− | + | # This makes most shots ricochet. | |
− | + | +r | |
− | -j | + | |
− | + | # This option allows jumping. | |
− | + | -j | |
− | + | ||
− | + | # These two flags can be used if they are not specified as options. | |
− | + | # +f R{1} # Ricochet | |
− | + | # +f J{1} # Jumping | |
− | + | ||
− | + | # This option allows for flags on box buildings. | |
− | + | #-fb | |
− | + | ||
− | + | # This option allows tanks to spawn on buildings. This is especially useful | |
− | + | # as tank spawn locations are calculated on the server without the | |
− | + | # advantage of knowing where shots are. | |
− | + | #-sb | |
− | + | ||
− | + | # By default if a player kills a teammate, he dies too, this option turns this | |
− | + | # off. Used mostly for capture the flag style games. | |
− | + | #-tk | |
− | + | ||
− | -tkkr 32 | + | # Announce team kills to the admin channel. |
− | + | #-tkannounce | |
− | + | ||
− | + | # Kick a player if his ratio of teammate to non-teammate kills is this | |
− | + | # percentage or greater. | |
− | + | -tkkr 32 | |
− | + | ||
− | + | # This option allows you to tell the server how long a team flag remains | |
− | + | # before it is reset after the last player on a team leaves. | |
− | + | # Default is 30 seconds. | |
− | + | #-tftimeout 60 | |
− | + | ||
− | + | # Hunt the rabbit game is activated with this option. | |
− | + | # Use only one of these options. | |
− | + | # Choose rabbit based on score. | |
− | + | #-rabbit score | |
− | + | # Rabbit is chosen by whoever kills the rabbit. | |
− | + | #-rabbit killer | |
− | + | # Or you can choose the rabbit randomly. | |
− | + | #-rabbit random | |
− | + | ||
− | + | # Open Free For All game is a teamless free-for-all game style. There are no | |
− | + | # teams, regardless of colors. | |
− | + | # Don't combine this with -c, -cr or -rabbit | |
− | + | #-offa | |
− | + | ||
− | + | # It is possible to restrict bots and autopilot from being used on the server. | |
− | + | # This is accomplished with the following. | |
− | + | #-disableBots | |
− | + | ||
− | + | # This option causes the server to quit after serving one game. This is | |
− | + | # handy if you want to do a timed game, or script a rotating server. | |
− | + | #-g | |
− | + | ||
− | + | # This option sets the max score for players. The game ends when a player | |
− | + | # reaches this score and is declared the winner. | |
− | + | #-mps 100 | |
− | + | ||
− | + | # This sets the max team score. The first team to reach this score is | |
− | + | # declared the winner and the game is ended. | |
− | + | #-mts 250 | |
− | + | ||
− | + | # This dumps the score to console when it changes. | |
− | + | #-printscore | |
− | + | ||
− | + | # This sets time limit (in seconds) for the game. Time starts when first | |
− | + | # client connects. | |
− | + | #-time 3600 | |
− | + | ||
− | - | + | # This option requires a timed game to be started using the /countdown |
− | + | # command to start a timed game. Default is when first player joins. | |
− | + | #-timemanual | |
− | + | ||
− | -publicaddr 123.456.789.000:5154 | + | |
− | + | ## List server Connection ## | |
− | + | ||
− | -p 5154 | + | # This is the public message that the server advertises on the public |
− | + | # server list. This is required if you want to be shown on the list. | |
− | + | # It often advertises the map you are using. Keep it short. | |
− | + | -publictitle "Noo BZFlag Server With Random Map" | |
− | + | ||
− | + | # This is also needed to be listed on the public server list. The | |
− | + | # address needs to be valid in DNS. It's your IP, plus port number. | |
− | + | -publicaddr 123.456.789.000:5154 | |
− | + | ||
− | + | # You need a public key to get your server listed on the official | |
− | + | # listserver. Read here how to get one: | |
− | + | # http://wiki.bzflag.org/ServerAuthentication | |
− | + | -publickey XXXXXXXXXXXX | |
− | + | ||
− | + | # The server will listen on this port. Default port is 5154. | |
− | + | -p 5154 | |
− | + | ||
− | + | # Tells server not to respond to "pings". This makes the server private. | |
− | + | # You should remove -public and -publicaddr when using it. | |
− | + | # If your router is open, you can still give people your IP and port, and | |
− | + | # they will be able to connect, you just wont be on the list. | |
− | + | #-q | |
− | + | ||
− | + | # You probably don't need to use this, but it is there if you do. This | |
− | + | # specifies where the server advertises itself. The built-in default | |
− | + | # should work just fine. You need to hunt down the proper address if | |
− | + | # it doesn't work. DON'T Change It | |
− | + | #-publiclist <list-server-url> | |
− | -autoTeam | + | |
− | + | # Server will listen for and respond to "pings" (sent via broadcast) on | |
− | + | # the given interface. The server uses the first interface by default. | |
− | + | # This is the TCP/UDP/IP address the server will listen on. | |
− | + | # You don't need to use this unless your server has multiple | |
− | + | # interfaces and doesn't show up on the server lists. | |
− | + | #-i 123.456.789.000 | |
− | + | ||
− | -mp 12 | + | |
− | + | ## Player Connections ## | |
− | + | ||
− | + | # Automatically assigns players to teams when they join so that teams are | |
− | + | # evenly matched in number of players. Players are placed on teams with | |
− | + | # lowest number of players first, then those with the lowest scores or | |
− | + | # kill ratios. | |
− | + | -autoTeam | |
− | + | ||
− | + | # This sets the max number of players. It can be done in 2 ways. A flat | |
− | - | + | # count of players, or by number of players on a given team. |
− | + | # This allows up to 50 players, no team limits. | |
− | + | # Typical home DSL connections max out at 12 players before lag begins. | |
− | + | # Lag equals players times shots. So a one-shot server could have more | |
− | + | # players, and vice-versa. | |
− | + | -mp 12 | |
− | + | ||
− | + | # This allows for max player by team. | |
− | -lagwarn 350 | + | # The order is rogue, red, green, blue, purple, observer. |
− | + | #-mp 3,3,3,3,3,3 | |
− | + | ||
− | + | # userdb can be used to map users to local groups. In most cases you can | |
− | -lagdrop 3 | + | # probably live without this. Consider using global groups instead. |
− | + | #-userdb /path/to/users.txt | |
− | + | ||
− | + | # If you use the BZFlag forums at http://my.bzflag.org/bb | |
− | - | + | # and have established groups there, you only need groupdb |
− | + | # Though local registrations can also be used. | |
− | + | # groupdb stores group to permission mappings. | |
− | + | #-groupdb /path/to/groups.txt | |
− | + | ||
− | + | # If you have registered groups at the bzbb forums, only players | |
− | + | # in this group will see your server in the list. | |
− | + | #-advertise NOOB.COP | |
− | + | ||
− | + | # This option kicks the user after they have been idle for a number of | |
− | + | # seconds. Idle means paused, not-spawning or not-responding. | |
− | + | -maxidle 300 | |
− | + | ||
− | + | # Set to not use a UDP connection for players. You typically do NOT want to | |
− | + | # do this (UDP is good!) | |
− | + | #-noudp | |
− | + | ||
− | + | # Define a lag threshold over which players with high lag will be | |
− | + | # announced to the admin channel. | |
− | + | #-adminlagannounce 300 | |
− | + | ||
− | + | # Define a threshold over which players with high lag will be announced. | |
− | + | #-lagannounce 400 | |
− | + | ||
− | + | # This option warns the user their lag is too high when it crosses the | |
− | + | # number of milliseconds set. | |
− | + | -lagwarn 350 | |
− | + | ||
− | + | # This option kicks players after they have been warned about high lag for | |
− | + | # a certain number of times. | |
− | + | -lagdrop 3 | |
− | + | ||
− | + | # Packetloss and Jitter are two different things. | |
− | + | # Packetloss is a percentage of total data being completely lost. | |
− | + | # A player with packetloss is usually downloading files, switching | |
− | -srvmsg " This is a Noo BZFlag Server " | + | # between applications, or simply has a bad connection. |
− | -srvmsg " Have Fun and Play Nice " | + | # Jitter is variation in the time between packets arriving, caused by network |
− | + | # congestion, timing drift, or route changes. | |
− | + | # A player with jitter may be purposely manipulating his lag to avoid | |
− | -admsg " Noo BZFlag Server " | + | # being shot, or to "lag through a wall". |
− | -admsg " BZFlag is Fun " | + | # These next four functions should be used with caution, slower servers |
− | + | # may wish to avoid using them altogether. | |
− | + | ||
− | + | # This option warns the user their packet loss is too high. | |
− | -spamtime 15 | + | #-packetlosswarn 4 |
− | + | ||
− | + | # This option kicks players after they have been warned about packet loss | |
− | + | # a certain number of times. | |
− | -spamwarn 3 | + | #-packetlossdrop 2 |
− | + | ||
− | + | # This option warns the user their jitter is too high when it crosses | |
− | + | # the number of milliseconds set. | |
− | + | # -jitterwarn 25 | |
− | + | ||
− | + | # This option kicks players after they have been warned about high | |
− | + | # jitter for a certain number of times. | |
− | + | # -jitterdrop 3 | |
− | + | ||
− | + | # This option tells the server where to store the ban list. The ban list will | |
− | + | # be loaded from this file when the server starts (if the file exists) and | |
− | + | # written back to the file when someone gets banned or unbanned. If this | |
− | + | # option isn't used the ban list will not be saved. | |
− | + | #-banfile /path/to/mybanfile.txt | |
− | + | ||
− | + | # This option sets up your ban list. This is ip masks separated by commas. | |
− | + | # The * character is used as a wild card in range bans. | |
− | + | #-ban "192.168.1.5,10.10.2.*,10.2.*.*" | |
− | + | ||
− | + | ||
− | + | ## General Options ## | |
− | + | ||
− | + | # adds timestamps to every line of the log | |
− | + | #-ts | |
− | + | ||
− | + | # uses UTC for timestamps instead of localtime and implies -ts | |
− | + | #-utc | |
− | + | ||
− | + | # -pidfile /path/to/pidfile.txt | |
− | + | # Specify a file where the server will write its process ID so it may be used for remote administration. | |
− | + | ||
− | + | # This is the server welcome message. Please change it. | |
− | + | -srvmsg " This is a Noo BZFlag Server " | |
− | + | -srvmsg " Have Fun and Play Nice " | |
− | + | ||
− | + | # Define a message which will be broadcast to all players every 15 minutes. | |
− | + | -admsg " Noo BZFlag Server " | |
− | + | -admsg " BZFlag is Fun " | |
− | + | ||
− | + | # This sets the amount of time in seconds that is required to pass between | |
− | + | # two identical messages sent. | |
− | + | -spamtime 15 | |
− | + | ||
− | + | # This sets the amount of times to warn spammers (see -spamtime) before they | |
− | + | # are kicked. | |
− | + | -spamwarn 3 | |
− | + | ||
− | + | # Specify a file that contains bad words that will be used when | |
− | + | # either -filterCallsigns or -filterChat is enabled. | |
− | + | # A multilingual badwords file can be found in source downloads. | |
− | + | #-badwords /path/to/badwords.txt | |
− | + | ||
− | + | # Turn on the filtering of chat messages. Messages have words provided | |
− | + | # via a -badwords file are replaced with !@#$%^&* characters. | |
− | + | #-filterChat | |
− | + | ||
− | + | # Turn on the filtering of callsigns. Callsigns are compared against | |
− | + | # bad words provided via -badwords. | |
− | + | #-filterCallsigns | |
− | + | ||
− | -sa | + | # By default, all filtering is aggressive, matching much more than what |
− | + | # is strictly listed in a -badwords file for convenience. Providing this | |
− | + | # option will make the -filterCallsigns and -filterChat comparisons | |
− | -st 5 | + | # exact match only. |
− | + | #-filterSimple | |
− | + | ||
− | -sw 1 | + | # This forces all clients to use the same time of day. The time is |
− | + | # determined by the server's clock. This disables the + and - keys | |
− | + | # on the clients. | |
− | + | #-synctime | |
− | + | ||
− | + | ||
− | + | ||
− | + | ## Player Controlled Functions ## | |
− | + | ||
− | + | # This option specifies a help file that will be displayed when the player | |
− | + | # types /help name | |
− | + | # Maximum length is 50 lines and 120 characters per line | |
− | + | #-helpmsg shock /path/to/shockwavehelp.txt | |
− | + | #-helpmsg noob /path/to/noobhelp.txt | |
− | + | ||
− | + | # You can specify a file so that people can type /report to report problems | |
− | +f A{2} | + | # on the server. The reports are logged in this file. |
− | +f CL{2} | + | #-reportfile /path/to/reports.txt |
− | +f F{2} | + | |
− | +f G{1} | + | # You can also use this option to cause the /report to trigger a command |
− | +f GM{2} | + | # as well as, or instead of, logging to a file. |
− | +f IB{2} | + | #-reportpipe command |
− | +f L{2} | + | |
− | +f MG{2} | + | # This specifies the number of seconds in which a poll can be vetoed. |
− | +f N{2} | + | #-vetoTime 60 |
− | +f OO{2} | + | |
− | +f PZ{2} | + | # This specifies the percentage of people required for a successful vote. |
− | +f QT{2} | + | #-votePercentage 51 |
− | +f SB{2} | + | |
− | +f SE{2} | + | # This is the number of voters required to hold a poll. |
− | +f SH{2} | + | #-votesRequired 6 |
− | +f SR{2} | + | |
− | +f ST{2} | + | # This is the length of time that players have to vote. |
− | +f SW{2} | + | #-voteTime 60 |
− | +f T{2} | + | |
− | +f TH{2} | + | |
− | +f US{2} | + | ## Flags ## |
− | +f V{2} | + | |
− | +f WG{2} | + | # This option allows for antidote flags to be available for players who |
− | + | # get bad flags. | |
− | + | -sa | |
− | +f B{1} | + | |
− | +f BY{1} | + | # Bad flags are automatically dropped after this many seconds. |
− | +f CB{1} | + | -st 5 |
− | +f FO{1} | + | |
− | +f JM{1} | + | # Bad flags are automatically dropped after this many wins. |
− | +f LT{1} | + | -sw 1 |
− | +f M{1} | + | |
− | +f NJ{1} | + | # This allows you to limit the number of shots from a particular flag. |
− | +f O{1} | + | #-sl GM 20 |
− | +f RC{1} | + | #-sl L 20 |
− | +f RO{1} | + | |
− | +f RT{1} | + | # There are two sets of flags. Flags that must be in the world at all times |
− | +f TR{1} | + | # and flags that may get generated randomly. in addition. +f specifies flags that |
− | +f WA{1} | + | # must be there and -f specifies flags that should never be generated. |
− | + | ||
− | + | # The server will randomly place flags from the following list. | |
− | + | # To be sure there is at least a certain amount of a flag on the map | |
− | + | # at any given time, you can use the +f option to guarantee a certain | |
− | + | # number of a flag. | |
− | + | ||
− | + | # 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 | |
− | + | ||
− | + | # BAD FLAGS | |
− | + | +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 | |
− | + | ||
− | + | # Using "+f good" is the equivalent of doing +f for each of the good flags. | |
− | + | # If you want to restrict a certain flag, you can use the -f option. | |
− | + | # just like with the +f option. "-f bad" is the same as doing -f for | |
− | + | # all of the bad flags. | |
− | + | #-f bad #no bad flags | |
− | -set _rainType bubble | + | #+f good #one of each good flag |
− | + | #-f G #no genocide | |
− | + | ||
− | + | # For world weapons, a flag may be enabled, without placing it on the ground. | |
− | + | # by using the flag's switch, without a bracketed number. | |
− | + | #+f SW | |
− | + | ||
− | + | # Use +s to have the server generate a certain number of extra flags | |
− | + | # and have them available at all times. This is in addition to | |
− | + | # any other flags specified. | |
− | + | #+s 20 | |
− | + | ||
− | + | # The server will have up to this many super flags at any time. | |
− | + | # Use this if you don't use any other method of flag generation. | |
− | + | #-s 30 | |
− | + | ||
− | + | ||
− | + | ## Variables ## | |
− | + | ||
− | + | # There are three ways to load sets of server-specific variables. | |
− | + | # They can be specified in this .conf file. | |
− | + | # They can be specified in the .bzw map file in an options block. | |
− | + | # Or they can be specified in a third file with this option | |
− | + | #-vars /path/to/vars.txt | |
− | + | ||
− | + | # Server variables can also be modified in-game using | |
− | + | # /set _varName value | |
− | + | # View the entire variable list by using | |
− | + | # /set (with nothing afterward) lists all vars | |
− | + | # /diff will list most non-default settings | |
− | + | # /? will list other available commands | |
− | + | ||
− | + | # Here are a few examples of variables. | |
− | + | # Some variables are set to 0 for off, 1 for on. | |
− | + | #-set _obeseFactor 12 | |
− | + | #-set _skyColor grey44 | |
− | + | #-set _wingsJumpCount 3 | |
− | + | #-set _tankExplosionSize 60 | |
− | + | #-set _jumpVelocity 20 | |
− | + | #-set _squishTime 7 | |
− | + | #-set _mirror grey22 | |
− | + | #-set _wallHeight 2 | |
− | + | #-set _shotsKeepVerticalVelocity 1 | |
− | + | #-set _drawGround 1 | |
− | + | #-set _drawSky 1 | |
− | + | #-set _drawClouds 0 | |
− | + | #-set _drawMountains 0 | |
− | + | #-set _fogMode exp | |
− | + | #-set _fogColor black | |
− | + | #-set _fogDensity .01 | |
− | + | -set _rainType bubble | |
− | + | ||
− | + | ||
− | + | ## Plugins ## | |
− | + | ||
− | + | # Plugins have mostly superseded patches as a means of modifying | |
− | + | # the play of BZFlag servers. Recent improvements in the bzfs2.0.9 have enabled | |
− | + | # almost every server functionality to be modified with the plugin API. | |
− | + | # | |
− | + | # Plugins cannot be accessed unless you compile your plugins and | |
− | + | # bzfs binary with the option --enable-shared | |
− | + | #-loadplugin /path/to/playHistoryTracker | |
− | + | ||
− | + | ## Replay ## | |
− | + | ||
− | + | # You can set up a server for replay mode by entering this option | |
+ | #-replay | ||
+ | |||
+ | # This option sets the recording buffer to the specified amount of megabytes. | ||
+ | #-recbuf 2 | ||
+ | |||
+ | # This option sets the directory to look for and save recordings. | ||
+ | #-recdir /path/to/recordings | ||
+ | |||
+ | ## More Comments ## | ||
+ | |||
+ | # This is intended to include the minimum options for a working | ||
+ | # BZFlag server, that is also connected to the list server. | ||
+ | # All you need to do is edit your IP numbers in -publicaddr | ||
+ | # and start bzfs. | ||
+ | # As it connects to the list server, your terminal will show | ||
+ | # something that looks like a player has joined, then immediately left. | ||
+ | # When you see that happen, you have succeeded, and are listed. | ||
+ | # If you can not connect to the list server, you probably need to open | ||
+ | # port 5154 through your router, for both UDP and TCP. Instructions for that | ||
+ | # are not included here. | ||
+ | |||
+ | # You join your server locally, by opening your BZFlag game client | ||
+ | # and editing these lines in the JOIN GAME screen. | ||
+ | # In the SERVER line add localhost | ||
+ | # In the PORT line add 5154 | ||
+ | # Then JOIN your server. | ||
+ | |||
+ | # Here are the short instructions. | ||
+ | # Open your router firewall at port 5154 | ||
+ | # Change the -publicaddr line in this .file to match your IP. | ||
+ | # In your terminal, cd to the location of the bzfs binary. | ||
+ | # ./bzfs -conf /path/to/sample.conf | ||
+ | # Don't take out any # comment markers or add options that you think look cool | ||
+ | # until after you have the server working. | ||
+ | # The options you need have been included in this file. | ||
+ | # You don't even need to specify a map, bzfs will create a random map for you. | ||
+ | # | ||
+ | # You do not even need this .conf file to start a server. | ||
+ | # You can use as many options you'd like just typing them into the terminal. | ||
+ | # Assuming you have installed BZFlag in default locations. | ||
+ | # In Macintosh terminal application these two should work | ||
+ | # cd /Applications/BZFlag2.4.8/Contents/MacOS/ | ||
+ | # ./bzfs -dd | ||
+ | # | ||
+ | # In windows command prompt, these two commands should suffice | ||
+ | # cd C:\program files\bzflag2.4.8 | ||
+ | # bzfs.exe -dd | ||
+ | # 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. | ||
+ | </pre> | ||
+ | |||
+ | [[Category:Sample]] | ||
+ | [[Category:Server]] |
Latest revision as of 18:30, 28 February 2017
# This is a BZFlag Server (bzfs) configuration file. # It assumes that you wish to connect to the bzflag list server. # Please read through it carefully. Lines starting with a # are comments. # to enable an option, remove the # at the beginning of a line. To # disable that option, put the # back. There are some examples in this # file. Make sure you change the examples if you uncomment the line. If # you don't know what something does, you are okay to just leave # it commented out. Failure to read through this file (looking for # already uncommented lines) might be a little embarrassing. Have fun. # This option is for debug. You can have as many as 4 of them. # simple debug #-d # and more complex debugging. -dd #-ddd #-dddd # Sets the admin password for the server. It is necessary for server # administration if no groups are used. # CHANGE THIS! #-password abcdef # Enables inertia and sets the maximum linear and angular accelerations. # The units are somewhat arbitrary so you'll have to experiment to find # suitable values. The values must be non-negative and higher values # yield greater inertia. # Used to control "Mouse Enhancements" -a 50 38 ## World ## # This specifies the world filename. # Use this format for Windows #-world "c:\mymaps\louschurchyard.bzw" # Use this format for *nix and Mac #-world /users/noob/lousdesktop.bzw ## Random World Generation ## # This option allows world objects to be randomly rotated. Only applies # if a randomly generated world is used. #-b # Enables capture-the-flag style game with a balanced random map. # Default is free-for-all style game. #-cr # Adds teleporters to the game. for random maps only #-t # This option controls the building density on random worlds(1-10) # Default is 5 #-density 7 # This option changes the size of random maps. #-worldsize 800 # This option gives buildings random heights. This is used when # you are using random maps. #-h ## Game Styles ## # This enables capture-the-flag style game. Default is free-for-all style. # Requires one base object for each team to be specified in the world file. # Can be used with random world generation. #-c # More than one team-flag may be specified. # This is generally not desirable. # B* - Blue Team G* - Green Team, P* - Purple Team, R* - Red Team, #+f B* #+f B* # This sets the maximum number of shots before a reload. # Default is 5. -ms 3 # This makes most shots ricochet. +r # This option allows jumping. -j # These two flags can be used if they are not specified as options. # +f R{1} # Ricochet # +f J{1} # Jumping # This option allows for flags on box buildings. #-fb # This option allows tanks to spawn on buildings. This is especially useful # as tank spawn locations are calculated on the server without the # advantage of knowing where shots are. #-sb # By default if a player kills a teammate, he dies too, this option turns this # off. Used mostly for capture the flag style games. #-tk # Announce team kills to the admin channel. #-tkannounce # Kick a player if his ratio of teammate to non-teammate kills is this # percentage or greater. -tkkr 32 # This option allows you to tell the server how long a team flag remains # before it is reset after the last player on a team leaves. # Default is 30 seconds. #-tftimeout 60 # Hunt the rabbit game is activated with this option. # Use only one of these options. # Choose rabbit based on score. #-rabbit score # Rabbit is chosen by whoever kills the rabbit. #-rabbit killer # Or you can choose the rabbit randomly. #-rabbit random # Open Free For All game is a teamless free-for-all game style. There are no # teams, regardless of colors. # Don't combine this with -c, -cr or -rabbit #-offa # It is possible to restrict bots and autopilot from being used on the server. # This is accomplished with the following. #-disableBots # This option causes the server to quit after serving one game. This is # handy if you want to do a timed game, or script a rotating server. #-g # This option sets the max score for players. The game ends when a player # reaches this score and is declared the winner. #-mps 100 # This sets the max team score. The first team to reach this score is # declared the winner and the game is ended. #-mts 250 # This dumps the score to console when it changes. #-printscore # This sets time limit (in seconds) for the game. Time starts when first # client connects. #-time 3600 # This option requires a timed game to be started using the /countdown # command to start a timed game. Default is when first player joins. #-timemanual ## List server Connection ## # This is the public message that the server advertises on the public # server list. This is required if you want to be shown on the list. # It often advertises the map you are using. Keep it short. -publictitle "Noo BZFlag Server With Random Map" # This is also needed to be listed on the public server list. The # address needs to be valid in DNS. It's your IP, plus port number. -publicaddr 123.456.789.000:5154 # You need a public key to get your server listed on the official # listserver. Read here how to get one: # http://wiki.bzflag.org/ServerAuthentication -publickey XXXXXXXXXXXX # The server will listen on this port. Default port is 5154. -p 5154 # Tells server not to respond to "pings". This makes the server private. # You should remove -public and -publicaddr when using it. # If your router is open, you can still give people your IP and port, and # they will be able to connect, you just wont be on the list. #-q # You probably don't need to use this, but it is there if you do. This # specifies where the server advertises itself. The built-in default # should work just fine. You need to hunt down the proper address if # it doesn't work. DON'T Change It #-publiclist <list-server-url> # Server will listen for and respond to "pings" (sent via broadcast) on # the given interface. The server uses the first interface by default. # This is the TCP/UDP/IP address the server will listen on. # You don't need to use this unless your server has multiple # interfaces and doesn't show up on the server lists. #-i 123.456.789.000 ## Player Connections ## # Automatically assigns players to teams when they join so that teams are # evenly matched in number of players. Players are placed on teams with # lowest number of players first, then those with the lowest scores or # kill ratios. -autoTeam # This sets the max number of players. It can be done in 2 ways. A flat # count of players, or by number of players on a given team. # This allows up to 50 players, no team limits. # Typical home DSL connections max out at 12 players before lag begins. # Lag equals players times shots. So a one-shot server could have more # players, and vice-versa. -mp 12 # This allows for max player by team. # The order is rogue, red, green, blue, purple, observer. #-mp 3,3,3,3,3,3 # userdb can be used to map users to local groups. In most cases you can # probably live without this. Consider using global groups instead. #-userdb /path/to/users.txt # If you use the BZFlag forums at http://my.bzflag.org/bb # and have established groups there, you only need groupdb # Though local registrations can also be used. # groupdb stores group to permission mappings. #-groupdb /path/to/groups.txt # If you have registered groups at the bzbb forums, only players # in this group will see your server in the list. #-advertise NOOB.COP # This option kicks the user after they have been idle for a number of # seconds. Idle means paused, not-spawning or not-responding. -maxidle 300 # Set to not use a UDP connection for players. You typically do NOT want to # do this (UDP is good!) #-noudp # Define a lag threshold over which players with high lag will be # announced to the admin channel. #-adminlagannounce 300 # Define a threshold over which players with high lag will be announced. #-lagannounce 400 # This option warns the user their lag is too high when it crosses the # number of milliseconds set. -lagwarn 350 # This option kicks players after they have been warned about high lag for # a certain number of times. -lagdrop 3 # Packetloss and Jitter are two different things. # Packetloss is a percentage of total data being completely lost. # A player with packetloss is usually downloading files, switching # between applications, or simply has a bad connection. # Jitter is variation in the time between packets arriving, caused by network # congestion, timing drift, or route changes. # A player with jitter may be purposely manipulating his lag to avoid # being shot, or to "lag through a wall". # These next four functions should be used with caution, slower servers # may wish to avoid using them altogether. # This option warns the user their packet loss is too high. #-packetlosswarn 4 # This option kicks players after they have been warned about packet loss # a certain number of times. #-packetlossdrop 2 # This option warns the user their jitter is too high when it crosses # the number of milliseconds set. # -jitterwarn 25 # This option kicks players after they have been warned about high # jitter for a certain number of times. # -jitterdrop 3 # This option tells the server where to store the ban list. The ban list will # be loaded from this file when the server starts (if the file exists) and # written back to the file when someone gets banned or unbanned. If this # option isn't used the ban list will not be saved. #-banfile /path/to/mybanfile.txt # This option sets up your ban list. This is ip masks separated by commas. # The * character is used as a wild card in range bans. #-ban "192.168.1.5,10.10.2.*,10.2.*.*" ## General Options ## # adds timestamps to every line of the log #-ts # uses UTC for timestamps instead of localtime and implies -ts #-utc # -pidfile /path/to/pidfile.txt # Specify a file where the server will write its process ID so it may be used for remote administration. # This is the server welcome message. Please change it. -srvmsg " This is a Noo BZFlag Server " -srvmsg " Have Fun and Play Nice " # Define a message which will be broadcast to all players every 15 minutes. -admsg " Noo BZFlag Server " -admsg " BZFlag is Fun " # This sets the amount of time in seconds that is required to pass between # two identical messages sent. -spamtime 15 # This sets the amount of times to warn spammers (see -spamtime) before they # are kicked. -spamwarn 3 # Specify a file that contains bad words that will be used when # either -filterCallsigns or -filterChat is enabled. # A multilingual badwords file can be found in source downloads. #-badwords /path/to/badwords.txt # Turn on the filtering of chat messages. Messages have words provided # via a -badwords file are replaced with !@#$%^&* characters. #-filterChat # Turn on the filtering of callsigns. Callsigns are compared against # bad words provided via -badwords. #-filterCallsigns # By default, all filtering is aggressive, matching much more than what # is strictly listed in a -badwords file for convenience. Providing this # option will make the -filterCallsigns and -filterChat comparisons # exact match only. #-filterSimple # This forces all clients to use the same time of day. The time is # determined by the server's clock. This disables the + and - keys # on the clients. #-synctime ## Player Controlled Functions ## # This option specifies a help file that will be displayed when the player # types /help name # Maximum length is 50 lines and 120 characters per line #-helpmsg shock /path/to/shockwavehelp.txt #-helpmsg noob /path/to/noobhelp.txt # You can specify a file so that people can type /report to report problems # on the server. The reports are logged in this file. #-reportfile /path/to/reports.txt # You can also use this option to cause the /report to trigger a command # as well as, or instead of, logging to a file. #-reportpipe command # This specifies the number of seconds in which a poll can be vetoed. #-vetoTime 60 # This specifies the percentage of people required for a successful vote. #-votePercentage 51 # This is the number of voters required to hold a poll. #-votesRequired 6 # This is the length of time that players have to vote. #-voteTime 60 ## Flags ## # This option allows for antidote flags to be available for players who # get bad flags. -sa # Bad flags are automatically dropped after this many seconds. -st 5 # Bad flags are automatically dropped after this many wins. -sw 1 # This allows you to limit the number of shots from a particular flag. #-sl GM 20 #-sl L 20 # There are two sets of flags. Flags that must be in the world at all times # and flags that may get generated randomly. in addition. +f specifies flags that # must be there and -f specifies flags that should never be generated. # The server will randomly place flags from the following list. # To be sure there is at least a certain amount of a flag on the map # at any given time, you can use the +f option to guarantee a certain # number of a flag. # 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 # BAD FLAGS +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 # Using "+f good" is the equivalent of doing +f for each of the good flags. # If you want to restrict a certain flag, you can use the -f option. # just like with the +f option. "-f bad" is the same as doing -f for # all of the bad flags. #-f bad #no bad flags #+f good #one of each good flag #-f G #no genocide # For world weapons, a flag may be enabled, without placing it on the ground. # by using the flag's switch, without a bracketed number. #+f SW # Use +s to have the server generate a certain number of extra flags # and have them available at all times. This is in addition to # any other flags specified. #+s 20 # The server will have up to this many super flags at any time. # Use this if you don't use any other method of flag generation. #-s 30 ## Variables ## # There are three ways to load sets of server-specific variables. # They can be specified in this .conf file. # They can be specified in the .bzw map file in an options block. # Or they can be specified in a third file with this option #-vars /path/to/vars.txt # Server variables can also be modified in-game using # /set _varName value # View the entire variable list by using # /set (with nothing afterward) lists all vars # /diff will list most non-default settings # /? will list other available commands # Here are a few examples of variables. # Some variables are set to 0 for off, 1 for on. #-set _obeseFactor 12 #-set _skyColor grey44 #-set _wingsJumpCount 3 #-set _tankExplosionSize 60 #-set _jumpVelocity 20 #-set _squishTime 7 #-set _mirror grey22 #-set _wallHeight 2 #-set _shotsKeepVerticalVelocity 1 #-set _drawGround 1 #-set _drawSky 1 #-set _drawClouds 0 #-set _drawMountains 0 #-set _fogMode exp #-set _fogColor black #-set _fogDensity .01 -set _rainType bubble ## Plugins ## # Plugins have mostly superseded patches as a means of modifying # the play of BZFlag servers. Recent improvements in the bzfs2.0.9 have enabled # almost every server functionality to be modified with the plugin API. # # Plugins cannot be accessed unless you compile your plugins and # bzfs binary with the option --enable-shared #-loadplugin /path/to/playHistoryTracker ## Replay ## # You can set up a server for replay mode by entering this option #-replay # This option sets the recording buffer to the specified amount of megabytes. #-recbuf 2 # This option sets the directory to look for and save recordings. #-recdir /path/to/recordings ## More Comments ## # This is intended to include the minimum options for a working # BZFlag server, that is also connected to the list server. # All you need to do is edit your IP numbers in -publicaddr # and start bzfs. # As it connects to the list server, your terminal will show # something that looks like a player has joined, then immediately left. # When you see that happen, you have succeeded, and are listed. # If you can not connect to the list server, you probably need to open # port 5154 through your router, for both UDP and TCP. Instructions for that # are not included here. # You join your server locally, by opening your BZFlag game client # and editing these lines in the JOIN GAME screen. # In the SERVER line add localhost # In the PORT line add 5154 # Then JOIN your server. # Here are the short instructions. # Open your router firewall at port 5154 # Change the -publicaddr line in this .file to match your IP. # In your terminal, cd to the location of the bzfs binary. # ./bzfs -conf /path/to/sample.conf # Don't take out any # comment markers or add options that you think look cool # until after you have the server working. # The options you need have been included in this file. # You don't even need to specify a map, bzfs will create a random map for you. # # You do not even need this .conf file to start a server. # You can use as many options you'd like just typing them into the terminal. # Assuming you have installed BZFlag in default locations. # In Macintosh terminal application these two should work # cd /Applications/BZFlag2.4.8/Contents/MacOS/ # ./bzfs -dd # # In windows command prompt, these two commands should suffice # cd C:\program files\bzflag2.4.8 # bzfs.exe -dd # 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.