BZFlagWiki - User contributions [en]

Config File

2011-07-30T15:53:53Z

A11: /* Linux and unix platforms */ updated to version 2.4

BZFlag uses an ASCII configuration file to store user settings. The file is called "config.cfg."
==Location==
The location of the config file depends on your operating system.
===Windows===
'''XP''': C:\Documents and Settings\[user]\My Documents\My BZFlag Files\2.0\config.cfg 
'''Vista / 7''': C:\Users\[user]\Documents\My BZFlag Files\2.0\config.cfg

(You will need to replace [user] with whichever Windows user name you are currently logged in as.)

===Windows Development Version (2.3)===
'''XP''': C:\Documents and Settings\[user]\Local Settings\Aplication Data\BZFlag\2.4\config.cfg 
'''Vista / 7''': C:\Users\[user]\AppData\Local\BZFlag\2.4\config.cfg 
An easy way to get to the BZFlag config folder is to do '''windows key + r''' then copy/paste '''%LOCALAPPDATA%\BZFlag''' into the box and hit enter. 

(You will need to replace [user] with whichever Windows user name you are currently logged in as.)

===Mac OS X===
~/Library/Application Support/BZFlag/2.0/config.cfg
set list http://my.bzflag.org:81/db

===Linux and unix platforms===
~/.bzf/2.4/config.cfg

Note: "~" is expanded to your home directory

==Editing the Config File==
As the config file is a text file, it is possible to directly edit it via text-editor instead of through the built-in GUI. Most things can be edited through the in-game GUI, however, there are some things that you can only add via text-editor. Settings that can only be set by editing the config file directly will be discussed here. (Note: these can also be set in-game with the /localset or /bind commands).

===Localset Options===
set highlightPattern "laser"
set highlightPattern "laser|genocide"
set highlightPattern "(Team Flag|Team's Flag|Genocide)"
''highlightPattern'' highlights lines with the selected words when they appear in the console(chat box).
*When highlighting one word, just type the word in quotes, such as "laser."
*If one wants to highlight two or more words, the words must be separated with a '|', such as "laser|genocide" (highlights lines with laser OR genocide).
*If any of the words have spaces, all the words must be surrounded in parentheses, such as "(Team Flag|Team's Flag|Genocide)" (highlights lines with "Team Flag," "Team's Flag," OR "Genocide").

set linedradarshots 10
set linedradarshots 65
''linedradarshots'' sets how long shots are on the radar. While this option ''is'' set-able through the in-game GUI, you can only set this setting up to 10 via the GUI. You can hand-edit your config to give you longer shot lengths.

set latitude 45
set longitude 71
''latitude'' and ''longitude'' set the latitude and longitude for BZFlag's sky rendering system.

''Hint: To always have a black sky set latitude 90 (north pole) or -90 (south pole) for winter/summer respectively.''

===Binding Custom Keys===
One can bind custom keys outside of those given in the in-game GUI.

The standard format for binding a key is as follows:
bind <event> <press> <action>

The event is the key or button that was pressed (or a combination of keys) such as F or "Shift+Page Up". The double quotes are necessary if there are spaces. The press will be one of up, down, or both. If it is set to up, for example, if will only trigger when they key or button is released. And finally, the action is what will be triggered.

For example, the following binding sets ''displayRadarRange'', or how far the radar is zoomed, to 0.12, when the key '`' is pressed.
bind ` down "set displayRadarRange 0.12"

One can use this template to set any of the options in the config file. However, some of the options, like ''radarsize'' need an additional function call that is only called via the options menu, and as such cannot be altered with this method.

One can also use the toggle keyword instead of set to have a key toggle two options:
bind F down "toggle linedradarshots 65"
bind F down "toggle linedradarshots 65 10"
The first line toggles the length of shots on the radar between 65 and an implied 0. The second line toggles ''linedradarshots'' between 65 and 10. This is much easier than having two keys to switch between two options.

''(Don't do this.)''
bind F down "set linedradarshots 65"
bind G down "set linedradarshots 10"

You can also bind one key with two funtions:

bind E down fire
bind E up identify

This will make it so you can fire and lock-on with GM with the same button.

To un-bind a key, just place a hash(#) at the front of the line, or remove the line completely. For example, to if one is tired of unintentionally hitting F12, he or she can simply disable it.
#bind F12 down quit


[[Category:Client]]

Getting Help

2011-07-25T04:10:23Z

A11: Undo revision 7883 by 173.236.27.154 (talk) Vandalism

Getting help on BZFlag is rather easy. There are a number of places to get help

==IRC Chat Room==
The BZFlag communities [[BZFlag on IRC|make heavy use of IRC]] for communication and collaboration.

The [http://freenode.net/ freenode network] is used for all IRC communications.
Common channels include:
* #bzflag ( development and support )
* #bzflag-chat ( general player talk )

A web interface is provided to these channels for registered forum users on the forum main page.

Please see [[BZFlag on IRC]] for more info.

==Web Forums==

BZFlag maintains a set of [[BZFlag Forums|official forums]], located at http://my.BZFlag.org/bb/

An older set of forums, now mostly unused, is located on SourceForge:
*http://sourceforge.net/forum/?group_id=3248 - main page
*http://sourceforge.net/forum/forum.php?forum_id=9554 - help forum

==Quick Start==

Just want to start playing? Get going with BZFlag right away, [[Getting Started|with this Quick Start page]].

==Mailing Lists==

There are a number of BZFlag mailing lists. The best one for support questions is bzflag-user. Archives and subscription information can be found on the SourceForge BZFlag project mailing list page at http://sourceforge.net/mail/?group_id=3248

==Common Support Issues==
The [[Common Support Issues]] page lists a number of the common problems with the game, and their resolutions.

==Documentation==
The game is documented via a series of manual pages ( or man pages ).
On Linux and other Unix like operating systems they are installed by default and can be accessed by using the '''man''' command and one of the following pages.
*bzflag
*bzfs
*bzadmin
*bzw

On Microsoft Windows and Apple OSX the manual pages are in HTML format. They are installed in the start menu for Windows, or in the extras folder on the install DMG for OSX.

The man pages are also available online in HTML format:
NOTE: As of June 2007 there is a problem with the man page conversion to HTML and the web manuals are NOT CORRECT! Use the man pages from source.
Corrected versions are being made, and will be posted on this wiki.

*[http://my.bzflag.org/bzfman.cgi?bzflag.6.in bzflag]
*[http://my.bzflag.org/bzfman.cgi?bzadmin.6.in bzadmin]
*[http://my.bzflag.org/bzfman.cgi?bzfs.6.in bzfs]
*[http://my.bzflag.org/bzfman.cgi?bzw.5.in bzw]

==Further Support==
If none of these methods provide a resolution to your problem, the project maintains a support tracking system on SourceForge. New tickets can be opened at this URL:

http://sourceforge.net/tracker/?group_id=3248&atid=203248

==See also==
[[BZFlag on IRC]]

[[BZFlag Forums]]

[[Common Support Issues]]

==External links==
[http://my.BZFlag.org/irc/irc.cgi BZFlag Web IRC gateway]

[[Category:Support]]
[[Category:Tutorials]]

Getting Started

2011-07-25T04:08:37Z

A11: Undo revision 7882 by 173.236.27.154 (talk)

This article covers the basics of getting started with BZFlag. It is intended for new players who have just found the game and require assistance. More detailed help can be found on our [[Getting Help]] page.

==Getting Started==
These simple steps have been designed to allow new users to begin playing the game as quickly as possible.

===Downloading and installing the game===

The main thing users need to play is the game software. Users can [[Download]] the software for a number of different [http://en.wikipedia.org/wiki/Operating_system|operating systems].

====Windows====
The most common operating system for players is Microsoft Windows. The official installer can be found at http://sourceforge.net/projects/bzflag/files/bzflag%20win32/2.4.0/bzflag-2.4.0_32Bit.exe/download . Simply double click the downloaded file to install the game.

====Mac OSX====
The next most popular system for players is Apple's MacOS X for the Macintosh family of computers. The version for macs can be found at http://sourceforge.net/projects/bzflag/files/bzflag%20Mac%20OS%20X/2.4.0/BZFlag-2.4.0.zip/download .

====Linux====
The project does not distribute a pre-made binary package for Linux, but many Linux distributions have BZFlag in their package management systems ( APT, YUM, emerge, etc.. ). Linux users can always build the game from the source code. Please see the [[Download|downloads]] page for more information.

===Registering a callsign(Optional)===
It is not mandatory to register a callsign ( the name a player uses in-game), but it is highly recommended.

A few of the benefits of registering are:

* The callsign is reserved, and can not be used by any other player.
* Registered users can post on the BZFlag forums.
* Registered users can join leagues and global groups.
* Many servers require registration to play.

Users that wish to register can do so at the [http://my.bzflag.org/bb/ucp.php?mode=register BZFlag forums registration page].

===Running the game===

Once the game is installed, it must be run to play.

====Windows====
Windows users that have installed the game with the provided installer will find a shortcut to the game in the start menu, under program files. Users simply have to click this shortcut to start the game.

====Mac OS X====
Macintosh users simply have to double click the BZFlag icon that they dragged to their Applications folder to start the game.

====Linux====
Linux, and other UNIX based platforms can start the game by typing the command '''bzflag''' in a terminal.

===Joining a game===
When the game is first started it will show the main menu screen. Users navigate the menu by using the Up and Down arrow keys to highlight a menu item, and using the enter key to select and activate the highlighted item. The red tank on the left visually depicts what command line is the current focus.

{|
|-
|
====Main Menu====
The main menu includes a number of menu items that lead to sub menus. The most important menu for new players is the '''Join Game''' item.
|[[Image:MainMenu.png|right|thumb|300px|The Main Menu]]
|-
|

====Join Game Menu====
Users wishing to join an internet game in progress should choose the '''Join Game''' item from the main menu.

On the first run of the game software all the fields in the '''Join Game''' Menu will be empty. Players need to use the arrow keys to highlight the '''Callsign''' item and input a player name. This name will be how other players see the user. Registered users should use the same callsign that they registered when playing. Registered users should also enter in their password into the item marked '''Password'''. This password is only used for to verify your identity and is NEVER sent to the game server. The '''E-mail''' entry is optional and is usually used to put a personalized message, like a signature, by many users.

Once the callsign, password, and optional email sections have been filled out, the up and down arrows should be used to move up to the '''Find Server''' that is on top of this page. This is how you choose an existing, running server to play on. The '''Start Server''' option on the bottom of this page is for running a server off your own machine, generally for more advanced users. Hitting enter on '''Find Server''' will give you a list of BZ Flag games that are hosted on the internet by other users. There are often over 300 servers to choose from. The various types of games are explained in the objectives section below.

|[[Image:JoinGame.png|right|thumb|300px|]]
|-
|

====Server List====
The server list menu shows a listing of all publicly available internet games. The list is sorted by the number of players on each server at any time, and will dynamically change over time. The servers with the highest player counts will always be at the top of the list.

The various servers can be highlighted using the arrow keys, and additional information about the highlighted game will be shown at the top of the screen. Once the user has chosen a server to join they must hit the enter key to select the server and return to the Join Game Menu.

|[[Image:ServerList.png|right|thumb|300px|The Serverlist]]
|-
|

====Entering a Game====
When a server is choosen from the Server List, it's information will be automatically entered into the appropriate fields in the Join Game menu. The user may then choose a team color, or leave the setting on automatic if they wish the server to assign them to a team.

When all the information is entered, the user simply has to choose connect menu item, and they will join the game. If additional textures or resources are needed to join the game, they will be downloaded automatically.
|-
|

====Playing BZFlag====
Once the user has joined the game they will be able to enjoy the gameplay that has made BZFlag one of the most popular open source games in history.
|-
|

=====Controls=====
The basic controls for the game are rather simple.

By default the mouse is used for movement. Moving the mouse up and down will move the tank forwards and backwards, while moving the mouse left and right will cause the tank to turn in that direction. Returning the mouse to the center of the screen will cause the tank to stop moving.

The left mouse button is used to fire the tank's weapon.

Optionally the keyboard can be used. The arrow keys control movement in the same way as the mouse, and the space bar is used to drop the flag you are carrying. The 'enter' key is used to fire the tanks weapon

Some servers offer a feature that allows tanks to jump. The ''tab'' key is used to start a small jump into the air. When jumping a tank normally can not change its speed or direction until it lands. Depending on the map, it may be possible for tanks to jump and land on various world objects and continue to fight.
|-
|

=====Objective=====
BZFlag is a team game, and has various objectives depending on the game type.

The default game type is '''Free For All''', commonly abbreviated as ''FFA''. This mode is similar to a team death match in other first person shooting type games. The objective is to destroy as many tanks as possible on other teams, while minimizing your own losses. Tanks are destroyed by being shot, in most cases one shot is all it takes to kill an enemy tank.

'''Capture the Flag''', commonly abbreviated as ''CTF'', is another common game type. Its objective is to pick up the flag from an opposing team's base and return it to your base. This is known as capping, where all the members of the team whose flag you are capping are destroyed when you return their flag and land on your home base. Just as in the Free for All game, you shoot at the opposing teams tanks.

The least common type of game is '''Rabbit Hunt'''. In this game mode, one user is a white-colored '''rabbit''' tank, and everyone else is a orange-colored '''hunter''' tank. The '''hunter''' tank(s) must chase and kill the rabbit tank. The '''hunter''' tank which kills the '''rabbit''' tank then becomes the '''rabbit''' tank, although there is the rarer randomly generated '''rabbit''', particularly when the '''rabbit''' and '''hunter''' are destroyed at the same time.

There are also a variety of games designed to practice some particular skill. A few of these are jumping/climbing skills, wings/flying skills, mazes with puzzles to figure out, racing courses, and dodging bullets without jumping allowed.
|-
|

=====Non-Standard Teams=====

Usually, you may not shoot members of your own team. But, there is one exception to this rule, called the '''rogue''' team. '''Rogue''' tanks are black in the view window, and yellow on the radar. They may shoot their "teammates", and gain points for it. This is because '''rogue''' tanks are each on a one-man team of their own. '''Rogue''' tanks are usually found on '''Free For All''' maps, but are occasionally found on '''CTF''' maps.
|-Rogue.
|

=====Flags=====
There are four different kinds of flags on an average server:
* Team flags are colored to correspond with the teams on the map. The idea is to grab the other team's flag and bring it back to your base.
* Superflags are "power ups" for your tank. Some examples of superflags can be '''Guided Missile''' (Allows your tank to lock onto and shoot others), '''laser''' (Allows your tank to shoot an infinitely fast and long laser beam), and '''Stealth''' (Your tank does not appear on radar).
* Bad Flags restrict the movement or actions of your tank. Some bad flags are ''''No Jumping, Obesity, Trigger Happy,''' and '''Left turn only.'''
* Antidote flags are flags that appear only when you have a bad flag. Driving over an antidote flag removes the bad flag from your tank.
|-
|

=====Customizing Controls=====
You can alter most of the controls in the menu (or, if you prefer, by editing the BZFlag config file.)
In the menu it is located at Options > Input settings > Key mapping

To assign a keystroke, mouse button or joystick button to a particular command select the command with Up or Down arrows, press Enter and press the keystroke or button you wish to associate with that command.
You can assign two different keystrokes/buttons to a given command, by repeating the assignment process.

Note: you can assign a keystroke or button already in use for a different command, but if you do remember that the old command will be unmapped..

To delete an assignment select the command with Up or Down arrows and press Delete.
If the command has two assignments, the first (leftmost) assignment is deleted, and the second (rightmost) assignment takes its place.

|-
|

=====Interface Elements=====
Most of the interface elements can be changed in the GUI settings, or by editing the config file.
|-
|

======Scoreboard======
Once a player has joined a server, they should notice a number of things, including the scoreboard.

Internet games commonly feature between 5 and 20 players. The names of these players will be listed in the scoreboard on the left hand side of the screen. The scoreboard can be hidden and shown by using the ''S'' key. The scoreboard is usually set up to show a players name, score, teamkills, email string, flag, kills/deaths, and the amount of kills/deaths you have scored against that player. For example, in this scoreboard, player "Andrey" has a score of 2, 0 teamkills, and email string of "Andrey@andreypc", has the SW (shock wave) flag, has 8 kills, 6 deaths, and has been killed by player "me1" 0 times, and has killed player "me1" once. Flags whose names are in white are powerful flags. Team flags are always the color of that team on the scoreboard. Other flags are just the same color as the player using them.

|[[Image:Scoreboard.jpg|right|thumb|300px|The Scoreboard]]
|-
|
======Team Scoreboard======
There is also a scoreboard for team scores. In FFA this shows the kills, deaths, and overall score. In CTF this shows the amount of flags that team has captured, and the amount of times their flag was captured, and the score. Also, to the right is the amount of players on that team. The rogue team is never included on the team scoreboard.
|[[Image:Teamscoreboard.jpg|right|thumb|300px|The Team Scoreboard]]
|-
|

======Radar======
The [[Radar]] (In the bottom left), shows a bird's eye, 2d view of the map. This is useful for dodging bullets, and seeing where other players are in relation to the users' tank. The user's tank is displayed in the center of the radar, in white. Two lines from the user's "blip" on the radar represent the user's FOV (Field of view). The user's bullets are also displayed in white. Other teams are shown on the radar in their respective color, red shown in red, green shown in green, etc. The rogue team is shown in yellow. Flags are shown as little white x's, and team flags as colored x's. A square is also around each radar "blip." This represents height. The larger the square, the higher something is. If a "blip" has an X through it, that tank has a flag.

|[[Image:Radar.jpg|right|thumb|300px|The Radar]]
|-
|

====Sportsmanship====

When playing BZFlag, it is important to keep a few simple rules in mind:

* Players should never shoot tanks on their own team (except for the rogue players).
* Players should be civil to other players in all respects.

|[[Image:Screenshot1.jpg|right|thumb|300px|A Screenshot of a standard 2.0.9 client playing on Missile War 2]]
|}

Category:Development

2011-07-25T04:07:39Z

A11: Undo revision 7880 by 88.198.240.139 (talk)

==Overview==
BZFlag is developed as an open source distributed development process by a number of developers all over the world.

==Organization==
The development community has a loose organizational structure but there are a few groups of developers that are responsible for various aspects of development.

===Maintainer===
Tim Riker (TimRiker) is the copyright holder and intellectual property manager for the project. He is responsible for the overall direction of the project and manages it's various legal operations.

===Release Managers===
Scott Wichser (Blast007) and Jeffery Myers (JeffM) are the release managers. They are responsible for the day to day development and planing of the various releases of BZFlag. They maintain the [[BZFlag Source]] Code, [[BZFlag_SVN|SVN]] repository, and ensure that development of features in a release are completed on time.

===Service Managers===
Scott Wichser (Blast007) and Joe Vano (JoeVano) manage the public services that BZFlag clients and servers use such as the [[List Server]] and [[Global Registration]] System.

====Forum Administrators====
A number of people maintain the [[BZFlag Forums]] including;

* L4m3r
* DTRemenak
* Learner
* Blast007
* TimRiker
* Bryjen
* joevano
* Bullet Catcher
* Constitution

==Communications==
Development communications mostly happens in the [[BZFlag_on_IRC|BZFlag IRC channel]]. There are development mailing lists on the sourceforge site but they are rarely used. Many developers are often on the IRC channel and are more then willing to discuss things relating to bzflag development.

==Coding Policy==
BZFlag has a documented coding policy that is in the DEVINFO file that is included with every source code release.

==Resources==
[[SVN]] repository stored on sourceforge.

[[BZFlag Source]] Information on the source code for the game.

[[BZFS API]] Information on the API for plug-in development.

[http://sourceforge.net/tracker/?group_id=3248&atid=303248 SourceForge Patch Tracker] where code changes from new developers are submitted.

[http://sourceforge.net/tracker/?group_id=3248&atid=103248 SourceForge Bug Tracker] where users report bugs or problems in the game.

[http://sourceforge.net/tracker/?group_id=3248&atid=353248 SourceForge Feature Requests] where users request new features ( pending approval).

==Helping Out==
BZFlag can always use new developers. Users that wish to become more involved in the development process are encouraged to join the IRC channel and talk to the developers and players there.

The next step is to submit patches to the patch tracker so the new developer can get the hang of how the codebase works and so that project management can evaluate the coding ability/style of the new developer.

If a new developer fits into the project well and is productive they will often be given '''commit access''' to the SVN system so they may make changes directly to the code.

==Versions==
The current shipping version is based on the 2.0.x branch '''branches/release_maint/v2_0''' in svn

The current development version is 2.3 to be released as 2.4.0.0 it is located in '''trunk/bzflag''' in svn.

Category:Development

2011-07-25T04:07:07Z

A11: Undo revision 7881 by 173.236.27.154 (talk)

==Oferfyew==
BzzFlag ys defeloped as an open source dystrybuted defelopment process by a number of defelopers all ofer the world.

==Organyzzatyon==
The defelopment communyty has a loose organyzzatyonal structure but there are a few groups of defelopers that are responsyble for faryous aspects of defelopment.

===Mayntayner===
Tym Ryker (TymRyker) ys the copyryght holder and yntellectual property manager for the project. He ys responsyble for the oferall dyrectyon of the project and manages yt's faryous legal operatyons.

===Release Managers===
Scott Wychser (Blast007) and Jeffery Myers (JeffM) are the release managers. They are responsyble for the day to day defelopment and planyng of the faryous releases of BzzFlag. They mayntayn the [[BzzFlag Source]] Code, [[BzzFlag_SfN|SfN]] reposytory, and ensure that defelopment of features yn a release are completed on tyme.

===Serfyce Managers===
Scott Wychser (Blast007) and Joe fano (Joefano) manage the publyc serfyces that BzzFlag clyents and serfers use such as the [[Lyst Serfer]] and [[Global Regystratyon]] System.

====Forum Admynystrators====
A number of people mayntayn the [[BzzFlag Forums]] yncludyng;

* L4m3r
* DTRemenak
* Learner
* Blast007
* TymRyker
* Bryjen
* joefano
* Bullet Catcher
* Constytutyon

==Communycatyons==
Defelopment communycatyons mostly happens yn the [[BzzFlag_on_yRC|BzzFlag yRC channel]]. There are defelopment maylyng lysts on the sourceforge syte but they are rarely used. Many defelopers are often on the yRC channel and are more then wyllyng to dyscuss thyngs relatyng to bzzflag defelopment.

==Codyng Polycy==
BzzFlag has a documented codyng polycy that ys yn the DEfyNFO fyle that ys yncluded wyth efery source code release.

==Resources==
[[SfN]] reposytory stored on sourceforge.

[[BzzFlag Source]] ynformatyon on the source code for the game.

[[BzzFS APy]] ynformatyon on the APy for plug-yn defelopment.

[http://sourceforge.net/tracker/?group_yd=3248&atyd=303248 SourceForge Patch Tracker] where code changes from new defelopers are submytted.

[http://sourceforge.net/tracker/?group_yd=3248&atyd=103248 SourceForge Bug Tracker] where users report bugs or problems yn the game.

[http://sourceforge.net/tracker/?group_yd=3248&atyd=353248 SourceForge Feature Requests] where users request new features ( pendyng approfal).

==Helpyng Out==
BzzFlag can always use new defelopers. Users that wysh to become more ynfolfed yn the defelopment process are encouraged to joyn the yRC channel and talk to the defelopers and players there.

The next step ys to submyt patches to the patch tracker so the new defeloper can get the hang of how the codebase works and so that project management can efaluate the codyng abylyty/style of the new defeloper.

yf a new defeloper fyts ynto the project well and ys productyfe they wyll often be gyfen '''commyt access''' to the SfN system so they may make changes dyrectly to the code.

==fersyons==
The current shyppyng fersyon ys based on the 2.0.x branch '''branches/release_maynt/f2_0''' yn sfn

The current defelopment fersyon ys 2.3 to be released as 2.4.0.0 yt ys located yn '''trunk/bzzflag''' yn sfn.

==Organization==
The development community has a loose organizational structure but there are a few groups of developers that are responsible for various aspects of development.

===Maintainer===
Tim Riker (TimRiker) is the copyright holder and intellectual property manager for the project. He is responsible for the overall direction of the project and manages it's various legal operations.

===Release Managers===
Scott Wichser (Blast007) and Jeffery Myers (JeffM) are the release managers. They are responsible for the day to day development and planing of the various releases of BZFlag. They maintain the [[BZFlag Source]] Code, [[BZFlag_SVN|SVN]] repository, and ensure that development of features in a release are completed on time.

===Service Managers===
Scott Wichser (Blast007) and Joe Vano (JoeVano) manage the public services that BZFlag clients and servers use such as the [[List Server]] and [[Global Registration]] System.

====Forum Administrators====
A number of people maintain the [[BZFlag Forums]] including;

* L4m3r
* DTRemenak
* Learner
* Blast007
* TimRiker
* Bryjen
* joevano
* Bullet Catcher
* Constitution

==Communications==
Development communications mostly happens in the [[BZFlag_on_IRC|BZFlag IRC channel]]. There are development mailing lists on the sourceforge site but they are rarely used. Many developers are often on the IRC channel and are more then willing to discuss things relating to bzflag development.

==Coding Policy==
BZFlag has a documented coding policy that is in the DEVINFO file that is included with every source code release.

==Resources==
[[SVN]] repository stored on sourceforge.

[[BZFlag Source]] Information on the source code for the game.

[[BZFS API]] Information on the API for plug-in development.

[http://sourceforge.net/tracker/?group_id=3248&atid=303248 SourceForge Patch Tracker] where code changes from new developers are submitted.

[http://sourceforge.net/tracker/?group_id=3248&atid=103248 SourceForge Bug Tracker] where users report bugs or problems in the game.

[http://sourceforge.net/tracker/?group_id=3248&atid=353248 SourceForge Feature Requests] where users request new features ( pending approval).

==Helping Out==
BZFlag can always use new developers. Users that wish to become more involved in the development process are encouraged to join the IRC channel and talk to the developers and players there.

The next step is to submit patches to the patch tracker so the new developer can get the hang of how the codebase works and so that project management can evaluate the coding ability/style of the new developer.

If a new developer fits into the project well and is productive they will often be given '''commit access''' to the SVN system so they may make changes directly to the code.

==Versions==
The current shipping version is based on the 2.0.x branch '''branches/release_maint/v2_0''' in svn

The current development version is 2.3 to be released as 2.4.0.0 it is located in '''trunk/bzflag''' in svn.

Category:Map Making

2011-07-25T04:04:50Z

A11: Undo revision 7879 by 93.174.93.145 (talk) Vandalism

BZFlag uses its own map file format, [[BZW]] (BZ World). BZW files are text based and contain a list of objects and map options that are read by the [[BZFS]] server. There is a [[Map FAQ]] that deals with several frequently asked map making questions.

==Map Creation Methods==
BZFlag has several well practiced methods for the design of maps, from simple text editing, custom editors, to exporters for 3D modeling software. While basic dedicated map editors, such as BZEdit, can often only create simple objects, 3D modeling software can create complex custom [[mesh]] objects, but have a much steeper learning curve.

===Dedicated Map editors===
Dedicated BZFlag map editors (i.e. written specifically for graphically editing BZW files) generally go by the name BZEdit. There are a number of versions of BZEdit that have been developed over the years. Each editor has its own level of support for various map features. At this time there is no custom editor that supports every feature of the BZW format. In general, these will only support simple version 1.10 objects, like boxes, pyramids, bases, and teleporters.

Editors supporting BZW 1.10 features:
*[[BZEdit]]
*[[BZEditWin32]]
*[[BZFed]]

Editors supporting some BZW 2.0 features.
*[[iBZEdit]]
*[[pyBZEdit]]

===Non-dedicated editors===
Technically, you can use any 3D modeling package that can export to .obj format. You can then either use [[modeltool]] or Wings3D to convert that file to BZW format.

====Blender====
The [http://www.blender.org/ blender] 3D modeling application features a plug-in called [[BZWTools]], which enables blender to read and write the BZW file format and to create BZW specific objects. Tutorials on using blender (not specific to BZFlag) can be found on the [http://www.blender.org/tutorials-help/tutorials/ blender web tutorials] pages.

====Wings 3D====
[http://www.wings3d.com/ Wings 3D] is a good modeler to use if you're new modeling. It has a much smaller learning curve than Blender, although it doesn't have as many features. The [[BZW Exporter for Wings3D]] allows you to export wings objects to a BZW file. Tutorials on using wings (not specific to BZFlag) can be found on the [http://www.wings3d.com/tutorials.php wings web tutorials] pages, as well as a useful tutorial on [http://www.geocities.com/peterchov/BarrelUV.html UV mapping]

====Getting Maps In .obj Format====
It is not widely known that you can export a bzflag map from the actual bzflag client in .obj format. To do so, you must connect to a server hosting the BZW map you would like to download and type ''/saveworld -o "mapname.obj"''. This will allow you to then import the .obj file into a modeler and edit the map.

===Creating BZW files via scripting or trivial programming===
Several of the existing BZFlag maps are created using a trivial application custom created for the purpose of generating each map. The application/program consists of print statements that output BZW file primitives. This method, using Perl, visual basic or C, allows re-use of the print statements with variables, for relatively fast creation of nearly identical objects. Once a coder creates a box primitive, for instance, another box can be created with a simple call to the same set of print statements but with different size or location arguments. The sets of print statements are then collected by the coder to create a library of available primitives (box, cylinder, fancy-teleporter, cage) that can be used again and again. The library of primitives may then be used to create additional maps but without all of the original work required to make the first map. The flaws in using this method compared to a graphical modeler or even BZEdit are:
*Representation of the work are not available without first launching a BZFlag client to look at the map
*Errors in the library or in calls might make the map unusable but with only visual basic, Perl or C compiler output as a clue

The advantage of this method is that the library is relatively easy to improve compared to bzedit and new features of bzflag are easily applied. In addition, the ability to replicate structures in a for-next loop context allow for repetitive or stepped structures with more rapidity than other mapping methods.

===Editing by Hand===
The last method of creating maps is simply coding them by hand as text files using the raw BZW structures. This is still one of the most common ways that people create and edit maps, and can be very fun and challenging. This is easily done in any text editor, for example NotePad on Windows, and TextEdit on Mac OS X.

Most maps made by hand tend to be fairly simple, though experienced mappers have made some extraordinary maps in this way. The reason for the popularity of the "hand made" approach is partly because of the simple structure of the BZW code, but also the fact that, until recently, there were no graphical editors available for operating systems like Mac OS X. A detailed explanation about creating a map by hand can be found on the [[Editing by Hand]] page.

Maps that contain 2.0 objects (such as [[mesh]]) tend to have been either completely made in a text editor, or partly modeled in 3D modeling software, and later manipulated in text format.

[[Category:Server]]

BZAdmin

2011-07-25T04:03:11Z

A11: Undo revision 7884 by 173.236.27.154 (talk)

[[BZAdmin]] is a text-only client for [[BZFlag]]. It is primarily meant to be a tool for server administrators, but it can also be used for other things. Read the man page for more details.

When you start [[BZAdmin]] without any command line options other than callsign and hostname a simple curses-based user interface will be started (unless you built [[BZAdmin]] without curses support). This interface is divided into three rectangles; the output window (which covers almost all of the terminal), the target window, and the input window.

The curses user interface also has a simple menu system where you can edit the server variables (if you are an admin) and see a player list. If you are an admin you can also see the IP addresses in the player list, if you have sent a /playerlist command. The menu shows up when you hit the F2 key. It only covers the upper half of the screen, so you can still see what's going on in the game. You can navigate through the menu with the up and down arrow keys, and use the enter key to select submenus and other menu items. If you hit F2 again the command prompt will regain keyboard focus, but the menu will still be visible. If you hit F2 a third time the menu will go away.

== Mac ==
Open up a terminal (Terminal.app) and type:
{|
|
/Applications/BZFlag*/Contents/MacOS/bzadmin callsign[:password]@server[:port]
|}
Example:
{|
|
/Applications/BZFlag2.0.8/Contents/MacOS/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158
|}
NOTE: The password and/or port are optional. The default port is 5154.

== Windows ==
Open up a command prompt (start -> run -> "cmd") and type:
{|
|
"C:\Program Files\BZFlag*\bzadmin.exe" callsign[:password]@server[:port]"
|}
Example:
{|
|
"C:\Program Files\BZFlag2.0.8\bzadmin.exe" brad:imanidiot@tankwar.gamesunited.de:5158"
|}
NOTE: The password and/or port are optional. The default port is 5154.

== Unix ==
Open up a terminal and type:
{|
|
/usr/local/bin/bzadmin callsign[:password]@server[:port]
|}
Example:
{|
|
/usr/local/bin/bzadmin brad:imanidiot@tankwar.gamesunited.de:5158
|}
NOTE: The password and/or port are optional. The default port is 5154.

== Other Command Line Options ==

'''-help'''

This will display a help message including a list of command line options.

'''-hide msgtype{,msgtype}*'''

Tell bzadmin not to show these message types. The available message types are: chat, join, kill, leave, pause, ping, rabbit, and spawn. By default chat, join, kill, leave, pause, and rabbit are shown.

'''-show msgtype{,msgtype}*'''

Tell bzadmin to show these message types. See -hide for a list of available message types. If a message type is listed both in -show and -hide it will not be shown.

'''-ui {curses | stdboth | stdin | stdout}'''

Select the user interface that you want. The curses interface is the default, and it is described above. The stdin interface reads user commands from the standard in stream and sends them to the server. All server output is ignored. The stdout interface prints all server output to the standard out stream. All user input is ignored. The stdboth interface is a combination of stdin and stdout - it prints server output to the standard out stream, and reads user commands from the standard in stream.

== Other Examples ==
Join the game on localhost, port 5154, using the callsign 'admin'.
{|
|
bzadmin admin@localhost:5154
|}
Connect to the server at localhost and ban the IP 192.168.0.2 for 2 hours.
{|
|
bzadmin admin@localhost "/password secretpass" "/ban 192.168.0.2 2h test"
|}
Connect to bzserver.org and print all server messages that contain 'magicword'.
{|
|
bzadmin -ui stdout spy@bzserver.org | grep magicword
|}
[[Category:Client]]