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