BZFlagWiki - User contributions [en]

Leagues

2025-11-02T17:41:03Z

Blast: Reverted edit by Red rider (talk) to last revision by Zehra

== Active Leagues ==

To join a league click on one of the links below and register your callsign. Some leagues may require that you be added to a list by an admin before you are allowed to talk/spawn on match servers. Please use the same callsign for matching that you have register on the league site. Most of the IRC channels for each league are situated on the [http://freenode.net/ freenode] network. Please refer to [[BZFlag on IRC]] for help on using IRC.

=== [[Leagues United]] ===
Website: [http://leaguesunited.org/ http://leaguesunited.org/]

IRC Channel: [irc://irc.freenode.net/##leaguesunited ##leaguesunited]

Match Length: 15, 20 or 30 minutes

Rules: various based on different maps.

:Babel: 3 shots, jumping , ricochet, CTF, Babel.
:Ducati: 2 shots, no jumping, ricochet, CTF, randomly generated map.
:DucatiMini: Same as regular [[Ducati]].
:Dupi: 2 shots, no jumping, ricochet, CTF.
:HiX: 3 shots, jumping, ricochet, CTF, [[HiX]] map.
:Pillbox: 3 shots, no jumping, no ricochet, CTF, [[Pillbox]] map.

=== 1vs1 League ===
Website: [http://1vs1.bzflag.net/ http://1vs1.bzflag.net/]

IRC Channel: None.

Match Length: First to 10 kills.

Rules:
:classic & fancy style: -> FFA mode, 2 shots, ricochet, no jumping, no superflags, small randomly generated map
:hix style -> FFA mode, 3 shots, ricochet, jumping, no superflags, hix map

== Defunct Leagues ==

=== [[Ducati|Ducati League]] ===
Website: [http://league.bzflag.net/ http://league.bzflag.net/]

IRC Channel: [irc://irc.freenode.net/##ducleague ##ducleague]

Match Length: 15, 20 or 30 minutes

Rules: 2 shots, no jumping, ricochet, CTF, randomly generated map.

=== [[GU League]] ===
Website: [http://www.guleague.org/ http://www.guleague.org/]

IRC Channel: [irc://irc.freenode.net/##guleague ##guleague]

Match Length: 30 minutes.

Rules: 3 shots, jumping, ricochet, CTF, [[HiX]] map.

=== Open League ===
Website: [http://openleague.net/ http://openleague.net/]

IRC Channel: [irc://irc.freenode.net/#openleague.net ##openleague]

Match Length: 15, 20, 30, 45 or 60 minutes.

Rules: 3 shots, jumping , ricochet, CTF, Babel or a map that changes every week (which can have different rules).

=== Pillbox League ===
Website: [http://pillbox.bzleague.com/ http://pillbox.bzleague.com/]

IRC Channel: [irc://irc.freenode.net/#pillbox #pillbox]

Match Length: 15, 20 or 30 minutes.

Rules: 3 shots, no jumping, no ricochet, CTF, [[Pillbox]] map.

=== Fun League ===
Website: [http://fun.bzleague.com/ http://fun.bzleague.com/]

IRC Channel: None.

Match Length: Depends on the map which one plays on.

Rules: Depends on the map which one plays on.

=== BZSoccer League ===

Website: [http://bzsoccer.bzleague.com/ http://bzsoccer.bzleague.com/]

IRC Channel: ##divi

Match length: 15 minutes

Rules: 2 shots, jumping, ricochet, soccer field map.

=== Plosileague ===

Website: [http://bzfx.net/league/ http://bzfx.net/league/]

IRC Channel: [irc://irc.freenode.net/#plosileague #plosileague]

Match Length: 30 minutes or first to 5 caps and ahead of the other team by at least 2 caps

Rules: 3 shots, jumping, ricochet, CTF, overlord or Babel map.

=== LavaHiX League ===
Website: [http://lavahix.wtwrp.de/ http://lavahix.wtwrp.de/]

IRC Channel: None.

Match Length: 15 minutes.

Rules: 3 shots, jumping, ricochet, CTF, [[HiX]] map with "lava" ground.

[[Category:Leagues]]

Different Mouse Settings

2025-11-02T12:53:55Z

Blast: Undo revision 9601 by Red rider (talk)

{{inaccurate}}
The cursor movement controls the [[Tank]]. The drivers are given different set-up possibilities. This article covers some of these.

== Overview ==
The acceleration of your tank can be controlled by moving the cursor in the little box on the [[HUD]]. This determines the acceleration rate of a tank. Maximum velocity is attained by putting the cursor outside the box, and zero velocity is attained by putting it inside the smaller box.

Administrators and mapmakers may set the following variables to determine the maximum velocity and angular velocity: _tankSpeed and _tankAngVel.

== Different Mousebox Sizes==

{|{{Prettytable}}
|-
| {{Hl3}} |'''Mousebox size'''
| {{Hl3}} |'''Pros'''
| {{Hl3}} |'''Cons'''
|-

|Big Mousebox
|Gives more precise control over the tank. Good for climbing on buildings and avoiding falling from buildings.
|The cursor takes longer to travel around the whole box. This leads to the tank accelerating slower into the next direction => you can dodge bullets, but with |greater difficulty and effort
|-
|Little Mousebox
| It enables you to dodge bullets with much less movement, therefore faster dodging is possible.
|It is also much easier to accidentally fall down from buildings.
|-
|Middle Mousebox Size
|A happy medium of precision and reaction speed. Can be used to dodge bullets relatively well. Falling down from buildings is much rarer than when using a miniscule mousebox
|You end up getting neither the absolute control nor the best reaction time.
|}

== Different Cursor Settings ==
{|{{Prettytable}}
|-
| {{Hl3}} |'''Cursor movement'''
| {{Hl3}} |'''Pros'''
| {{Hl3}} |'''Cons'''
| {{Hl3}} |'''Good Mousebox in combination'''
|-
|Fast Cursor
|Very good to dodge bullets.
|Risky to drive around on buildings.
|Big or middle mousebox. Only use a small mousebox if you don't jump often.
|-
|Slow Cursor
|Good for doing complicated jumps.
|Hard to dodge incoming bullets.
|Small or middle mousebox. A big mousebox is suicide!
|-
|Middle Cursor Speed
|Can be used to dodge many incoming bullets. Driving on buildings is not dangerous.
|Occasionally you can't dodge or fall down from a building.
|Big, middle and small mouseboxes can be used.
|}

== Platform differences ==

=== Cursor Speed ===
Speed is a linear factor added to your cursor movement. The cursor is constantly faster/slower.

=== Cursor Acceleration ===
Acceleration is a multiplier to your cursor movement. Has a high impact to cursor movement when moving the mouse fast, slower impact when moving the mouse slower.

=== I'm on Mac OS X - Others seem to have an advantage ===

The only real advantage they have is the agility flag. Other platforms use different acceleration parameters; thus, they may find it easier to drive a straight line and then jump with the agility flag so that they can escape easier. With the Mac's mouse acceleration you gain some other advantages against the other player, like you will always be able to react quicker than them and can move more precisely when you move your cursor slower.

Both Macs and PCs use mouse acceleration; they simply use different functions to calculate the mouse position. In addition, different versions of the same platform can also have different acceleration. There are tools available for both platforms for configuring the acceleration, if you don't like the defaults.

All that talk about acceleration and speed may sound strange to you - with drivers like [http://plentycom.jp/en/steermouse/ SteerMouse] and [http://www.usboverdrive.com/ USBOverdrive] you can quickly get a feeling for the difference. If you are using Windows®, you can tweak the parameters by editing the registry keys in HKEY_CURRENT_USER\Control Panel\Mouse.

A good mouse and mousepad might also make a difference; a wired optical mouse will usually perform better than a ball mouse or a wireless mouse. A quality gaming mouse might be helpful, but in general, you need to consider whether the additional cost (often hundreds of dollars) is really worth it.

=== I'm on Linux - How to tweak that beast ===

For USB mice you could use a small progamm called lomoco (search it for your distribution) and thereafter xset.

"xset m 22 && bzflag-e && xset m 5 " from a comandline, give a nice fast mouse.

In case your mouse is an old style PS/2, use "xset 7 1" or instead of 7, use 6, 9, 5, whatever suits you most. Just try what is best for you.

[[Category:Gameplay]]
[[Category:Tactics]]
[[Category:Client]]

Tank

2025-11-02T12:48:51Z

Blast: Reverted edit by Red rider (talk) to last revision by Zehra

The tank is the primary avatar of the player in BZFlag.[[image:Blue_tank_small.png|right]]

==2.0.10 and earlier==
This Classic BZFlag tank model has been in the game since its inception, and is an integral part of game play. This tank model has received few graphical upgrades over the years, and looks today much the same as it has since the first version of the game.

The classic tank model is [http://en.wikipedia.org/wiki/Hardcoded hard coded] as a series of [http://en.wikipedia.org/wiki/OpenGL OpenGL] instructions in the [[BZFlag Source]] code. The model may not be changed externally without modifications to the game client itself.

The 2.0.10 tank model has been exported from the code, and can be found as a wavefront obj file at https://bzflag.svn.sourceforge.net/svnroot/bzflag/trunk/bzflag/misc/tank.obj This model is licensed under the LGPL as it is pulled from the bzflag sources.
This can be imported into most 3d modeling packages.

===Appearance===
The tank model has 7 different colors, or "skins", that it can appear in. The color of the tank results from the team in which the tank is playing, or some other game logic (such as Hunters and Rabbits in [[Rabbit Hunt]])
The 7 tank colors are as follows:
<gallery>
image:Red_tank.png‎|Red Team Tank
image:Blue_tank.png‎|Blue Team Tank
image:Green_tank.png‎|Green Team Tank
image:Purple_tank.png‎|Purple Team Tank
image:Black_tank.png‎|Rogue (black) Team Tank
image:Orange_tank.png‎|Hunter Team Tank
image:White_tank.png‎|Rabbit Team Tank
</gallery>

Depending on an individual client's graphical settings, the tank may have animated treads and spinning wheels. The tanks shown are the most basic version of the tank.

===Dimensions===
[[image:Tank_sizes.png|frame|right|Tank dimensions in [[world units]]]]
The Tank's visible model is 8.04 [[world units]] long, 2.8 [[World units|units]] wide, and 2.05 [[World units|units]] tall as shown in the image. If one assumes that one [[World units|world unit]] is equivalent to one real world meter, then the tank would be 26 feet 4.5 inches long, 9 feet 2 inches wide, and 6 feet 10 inches tall.

The tank bounding box (used in collisions with world objects) is 6 [[world units]] long, 2.8 [[World units|units]] wide, and 2.05 [[World units|units]] tall, and does not include the barrel forward of the tip of the treads. The muzzle of the barrel is 1.57 (visually only 1.53) [[World units|world units]] from the ground, meaning that a tank can shoot over a box 1.5 [[World units|units]] high.

===History===
The tank model was originally created by '''Tamar Cohen''' for the first versions of BZFlag and has since been extended and modified by the BZFlag developers.

==Future Versions==
The tank model will most likely be redone for a future version. [[Image:3 0 tank test render.png]]

It will be an external loaded model and have the same basic dimensions as the older tank.

[[Category:Concepts]]
[[Category:Map Making]]

Single Player Mode

2025-11-02T12:40:20Z

Blast: Reverted edit by Loymdayddaud (talk) to last revision by Zehra

Single Player Mode is a term (misnomer) often used to describe the act of playing BZFlag on a local server using the computer-controlled player (bots) of a client. BZFlag itself is designed to be a multiplayer game.

=Overview=
Using bots on a local server is a way to play the game without an internet connection, or to gain experience in playing without the need for other human players. Bots are currently only run by the game client and can be run on any server. The term "Single Player Mode" is most commonly used to describe a single client that is logged in to a local server with a number of bots. It is mostly used to test maps, as the simple robots do not offer any real gameplay challenge.

Bots can be used on remote servers, but many of the owners of public servers do not allow bots to join with players. Use of bots on public servers is not recommended and can lead to being banned from the server.

=Starting a Single Player Session=
The basic idea behind starting a single player session is the following.
#Start a local server, ether by using the in-game menu, or via the command line.
#Start the game client using the '''-solo''' [[BZFS Command Line Options| command line option]].
#Join the local server using the client and begin play.

==Starting a local server==
The simplest way to start a local server is to use the in-game '''Start Server''' menu. This menu is found on the [[Join Game Menu]] at the very bottom. This menu gives a number of settings for the server, including shot counts, and world options such as [[jumping]] and [[ricochet]]. Specific flags or more advanced options can not be set via the '''Start Server''' menu.

To set additional options one must run [[BZFS]] manually and enter in a number of [[BZFS Command Line Options| command line options]]. See [[Creating A Server|creating a server]] for more options. To keep the server local, do not use the '''-public''' option.

==Starting the client with bots==
The game client must be started with a command-line option to enable bots. Bots can not be enabled from within the game menus.

===Linux and Unix===
On Linux or other Unix-like systems the game client can be started with command line options directly from the terminal.
{|
|
bzflag -solo ##
|}
Where <nowiki>##</nowiki> is the number of bots you want to run.

===Microsoft Windows===
Microsoft Windows users can follow the following steps to create a shortcut that starts the game client with bots.
# Locate the BZFlag shortcut installed in the programs section of the start menu.
# Drag the BZFlag shortcut with the right mouse button on to the desktop.
# Pick the "Copy here" item from the context menu that pops up when the drag is complete.
# Click on the Copied shortcut with the right mouse button and pick the "properties" item.
# Find the "Target" field in the shortcut properties window that is opened, and click in it.
# Use the right arrow key to find the end of the text in the target field. It will end in bzflag.exe".
# After the last quote(") add a space and then '''-solo''' <nowiki>##</nowiki>. Where <nowiki>##</nowiki> is the number of bots you wish to have.
# Save the changes by hitting the OK button at the bottom.

Running this shortcut will now start the server with bot support.

===Mac OS X===
The Mac OS X method for starting the game with bot support is the same as the Linux method, but the path to the bzflag client is required. If you installed BZFlag in your applications folder, then the command that needs to be typed into terminal will be along the lines of:
{|
|
/Applications/BZFlag.app/Contents/MacOS/bzflag -solo <nowiki>##</nowiki>
|}
Where <nowiki>##</nowiki> is the number of bots you want to run.

==Joining the Local Server==
Once the client is started with bot support you must do the following to join the local server
# Go to the Join Game menu.
# Enter "127.0.0.1" in the server name field. This is called "localhost".
# Enter "5154" in the port field.
# Choose the "Connect" item to join the server.

This will connect to the local server with the number of bots specified to with the '''-solo''' option.

=Autopilot=
The aforementioned bot method creates what may be called 'simple' bots, which simply shoot and attempt to dodge bullets.
A feature called autopilot, is activated when you press the "9" key on your keyboard while in-game, although as stated earlier, many servers do not allow this.
Some players may decide they want to open up 5 or 10 clients and place them on autopilot. When they do, it allows them to be able to jump, grab flags, and are slightly smarter than the 'simple' bots.

==See also==
* [[Creating A Server]]
* [[BZFS Command Line Options]]

[[Category:Concepts]]
[[Category:Client]]
[[Category:Tutorials]]

CustomTanks

2025-11-02T12:37:38Z

Blast: Reverted edit by Red rider (talk) to last revision by Zehra

==Overview==
This feature is intended to allow players to add some level of customization to tank avatars

==Idea==
Instead of making the tank be a single hard coded model, the tank can be built up out of a number of predefined "parts" put together in a user specified order. The ordering info will be sent to the game server and out to all other clients to allow the remote representation of each players tank layout.

This gets around the problems that full model uploads have, inappropriate models, and invalid models. Also there does not need to be an "approval" process for models, and maintains a consistent art style for the game.

Servers can disallow specific parts if they wish. And a global update system could be created to add new parts as they are created, or limit specific parts/textures to specific groups ( league flags, developer parts, etc..)

==Part Categories==
Parts will be broken up in to three categories, Base, Turret, and Rear Option, Top Option. The Base and Turret parts will be required, while the two options will be optional.

===Bases===

====Covered====
[[image:Treads_Covered.png|250px|Covered]]

Normal "covered" treads like we have now

====Open====
[[image:Treads_Open.png|250px|Open]]

Norm "open" treads like we have now

====Big Front====
[[image:Treads_BigFront.png|250px|Big Front Concept]]

Treads where there are 2 rollers to the front of the tank and one in the rear.

====Double====
[[image:Treads_Double.png|250px|Double Treads]]

Each side has small front and rear treads with a gap in the middle of the body

====Triple====
Each side has a thinner set of double treads with a third tread outside the gap to the bounding box.

====Squish 8====
[[image:Tread_Squish8.png|250px|Squish 8 concept]] [[image:MetalSlugTank.jpg|250px|Metal Slug like tank]]

Open treads that get pinched in the middle by an armor plate

====Hover====
Jets at each corner.

====BigWheel====
Large off-road wheels instead of tracks

====Half-track====
Wheels in the front, treads in the back.

====Batman====
[[image:Popsci_robotank.png|250px|Image from a popular science article on robot tanks]]

Large rear wheels to edge, smaller front wheels in an "inside fork" configuration

===Turrets===

====Long Smoothbore====
Current

====Long Split====
Turret with mussle break

====Double====
a pair of smaller barrels

====Quad====
4 machine gun style barrels

====Offset====
Barrel offset to the side, sci-fi style

====Square Long====
Sci-fi squared off barrel

====Square Short====
Like above but shorter.

====Short====
[[image:Popsci_robotank.png|250px|More Futuristic turret design]]

Round short barrel, no brake

====Pug====
super short wide barrel

===Rear Options===

====Cans====
Fuel cans

====Bundle====
Tarp with shovels.

====Minigun====
Gatling cannon.

====Missile====
Box of missiles

====Empty====
Nothing

====Radar====
A radar dish, which could be removed in the case of -noradar

===Top Options===

Mostly small team and group flags.

Main Page

2025-11-01T10:45:52Z

Blast:

__NOTOC__
[[Image:BZFlag_2010_shiny.png|center]]
{|style="width:100%;margin-top:+.7em;background-color:#fcfcfc;border:1px solid #ccc"
|style="width:56%;color:#000"|
{|style="width:280px;border:solid 0px;background:none"
|-
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
[[Image:Bzflag-48x48.png|left]]
<div style="font-size:175%;border:none;margin: 0;padding:.1em;color:#000">Welcome to the BZFlag Wiki,</div>
<div style="top:+0.2em;font-size: 95%">The source for community information on most things related to BZFlag!</div>
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">The BZFlag Wiki motto: [[BZFlagWiki:Be_bold|'''Be Bold!!''']]</div>
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">[[Special:Statistics|{{NUMBEROFARTICLES}}]] articles available</div>
|}
|style="width:15%;font-size:95%"|
[[Image:Bzflag-48x48.png|right]]
*[https://forums.bzflag.org/ The Forums]
*[https://github.com/BZFlag-Dev BZFlag on GitHub]

|}

{|style="width:100%;margin-top:+.7em;background-color:#B0E0E6;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">News</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">The developers of BZFlag are very proud to announce the general release of BZFlag 2.4.30, which is available for [https://www.bzflag.org/downloads/ download].</div>
|}

Welcome to the BZFlag Wiki. The number of articles is growing, but there is much more to do. Please see the section '''Things To Do''' at the bottom of this page if you would like to help. The intention of this site is to draw together all of the great information about BZFlag and BZFlag related items that is currently scattered in many different places. Bringing all of this information together will make it easier for people to understand and answer all of the questions they have about running a server (options, permissions, set-up, etc.), configuring their client, coding plug-ins, compiling the source code, and anything else they can think of. All are welcome to contribute and may edit most pages. With everyone's help we can make this site a great resource to the BZFlag community. Please remember the BZFlag Wiki's new motto, [[BZFlagWiki:Be_bold|'''Be Bold''']] (click the link for a full explanation of the motto), when editing articles.

If you are unsure of how to edit or add pages, there is always a link to the [[Help:Contents|'''Help''']] section on the links to the left no matter where you are on the site. Don't be shy; give editing the site a try and be proud of your contributions! You can edit whether or not you have an account created. The advantage of having an account is that you will be credited with the contribution on the ''History'' link/tab of the page. Please take a look at the [[BZFlagWiki:Content Policy|Content Policy]] page for an overview of adding articles.

==General Information==
*[http://bzflag.org/documentation/getting_started Getting Started]
*[http://bzflag.org/help Getting Help]
*[[:Category:BZFlagWiki_Policy|BZFlag Wiki Policy]]

==Areas of Interest==
*[[:Category:Client|Client]]
*[[:Category:Compiling|Compiling]]
*[[:Category:Concepts|Concepts]]
*[[:Category:Development|Development]]
*[[:Category:Gameplay|Gameplay]]
*[[:Category:Installing|Installing]]
*[[Leagues]]
*[[Map Making]]
*[[:Category:Maps|Maps]]
*[[:Category:Plug-Ins|Plug-ins]]
*[[Releases]]
*[[:Category:Server|Server]]
*[[:Category:Support|Support]]
*[[Tactics]]
*[[Versions]]

==Things To Do==
*[[:Category:Stubs|Stubs]] These are short pages. You can help by expanding the content and adding more detail.
*[[:Special:Wantedpages|Wanted pages]] These are pages which don't exist yet but are pointed to from other pages. You can help by creating them.
*[[:Category:Items to be merged|Pages to merge]] These are pages which are similar. It is suggested that similar pages be merged. You can help by reviewing the pairs of pages and commenting on any proposals by using the "Discussion" tab at the top of each page.
*[[:Category:Old|Pages with old info]] You can help by updating these pages.
*[[:Category:Inaccurate|Inaccurate pages]] You can help by updating these pages.
*[[:Category:Pending Deletions|Pending deletions]] These are pages which have been nominated for deletion. You can help by reviewing these pages and commenting on any proposals by using the "Discussion" tab at the top of each page.

BZFS2 prototype

2017-02-12T14:13:29Z

Blast: Reverted edits by Zehra (talk) to last revision by JeffM2501

{{IdeaDesign}}
''This is an overview of the BZFS2 prototype released 4/22/2007.''
''This document describes a proof of concept rewrite of BZFS, it does not represent the current state of any release or version of the main project code.''
==The New Paradigms==
'''Channel''' - Channels are for transmitting various data at different priorities and with different rights. Players 'tune in' and 'tune out' of channels depending on the state they are in and the rights that are conferred to them.

The channel model has a super channel which every client is connected to immediately upon connecting to the server. Then, there are one or more game channels where the game is actually played, and any game-related data is sent within this channel. There is at least one admin channel which authenticated users are tuned in to for admin-specific data.

'''Group''' - The new security model is a layered grouping model. All entities (players, channels, other groups), are within a group, and rights for any entity depend on the rights of a group and all it's ancestor groups.

'''Task''' - Tasks can be running tasks or timed tasks, and can be registered either from the server, or from plug-ins.
==Networking==
Networking is now separate from player data. The base class is Client (Similar to the NetConnectedPeer), with children LocalClient and RemoteClient (RelayClient is planned). The Client abstracts the network implementation away from the server. RemoteClient uses basic sockets, ENetRemoteClient will use ENet, SDLRemoteClient will use SDL-Net.

Message are queued and directed by the Channel. Broadcast messages are broadcast to clients tuned to the channel. Only messages broadcast on the super channel are guaranteed to reach every connected client.

'''Relay Servers''' - One method of handling latency over long distances is a relay server, which clients local to the this relay connect to it, and the relay connects to the main server. Messages both ways are batched and fewer packets are sent between a relay and the main than between the main and a direct client player.
==Game State==
This server engine is designed to allow game state to be kept by the server in an abstracted form. How this will be implemented is yet to be decided.
==Plug-ins==
Several functions that are part of the current BZFS have been removed to be implemented as plug-ins instead. This includes admin functions and voting. This means the server would be packaged with several default plug-ins that add core functionality.

==API==
Additional API is required to support the admin function plugin, and allow plug-ins to register tasks and commands. By and large, the API does remain the same.

User:Flak 18

2016-11-26T21:10:58Z

Blast: Blast moved page User:Flak 18 to User:Zehra: Automatically moved page while renaming the user "Flak 18" to "Zehra"

#REDIRECT [[User:Zehra]]

User:Zehra

2016-11-26T21:10:58Z

Blast: Blast moved page User:Flak 18 to User:Zehra: Automatically moved page while renaming the user "Flak 18" to "Zehra"

Hi and welcome to the homepage of ''Flak 18''

If you have any questions or comments please leave them on my talk page or send me a forum pm.

==== BZFlag forums profile ====
Here's my official [https://forums.bzflag.org/memberlist.php?mode=viewprofile&u=57773 BZFlag forums profile] feel free to contact me here.
===== Interests =====
Ducati, DucatiMini, Mini Ducati, DuPi, and PillBox.

Installing on Linux

2016-07-04T15:03:47Z

Blast:

There are various packages of BZFlag available to many different distributions.

== Compiling from Source ==
This document is not designed to cover information about compiling.

{{main|Compiling}}

== Installing from tarball ==
You extract it and run the install script as root.

tar -vzxf package.tar.gz
cd bzflag-2.4.2
./configure --prefix=/install/path
make
sudo make install

== Installing using a package manager ==
This depends on your distribution. Different distributions use different package managers.

To understand the command lines please understand:
$ ''indicates a user shell''
# ''indicates a root shell''

$ sudo ''is replaceable by'' #

=== Graphical Package Managers ===
Search for "BZFlag" and install it.<br />
BZFlag will most likely be sorted to the Games category.

=== Fedora / Red Hat / Mandriva===
$ sudo yum install bzflag

For the server package:
$ sudo yum install bzflag-server

=== openSUSE ===
$ sudo zypper install bzflag

For the server package:
$ sudo zypper install bzflag-server

=== Native RPM ===
$ sudo rpm -ivh bzflag.x86.208.rpm

=== Ubuntu / Debian ===
$ sudo apt-get install bzflag

For the server package:
$ sudo apt-get install bzflag-server

=== Arch ===

# pacman -S bzflag

=== Gentoo ===

# emerge bzflag

== External Links ==
* [http://bzflag.org/downloads Download page for the latest binaries and source]

[[Category:Installing]]
[[Category:Tutorials]]

Installing on Linux

2016-07-04T15:02:45Z

Blast:

There are various packages of BZFlag available to many different distributions.

== Compiling from Source ==
This document is not designed to cover information about compiling.

{{main|Compiling}}

see also [[ubuntu_and_bzflag_2.4]]

== Installing from tarball ==
You extract it and run the install script as root.

tar -vzxf package.tar.gz
cd bzflag-2.4.2
./configure --prefix=/install/path
make
sudo make install

== Installing using a package manager ==
This depends on your distribution. Different distributions use different package managers.

To understand the command lines please understand:
$ ''indicates a user shell''
# ''indicates a root shell''

$ sudo ''is replaceable by'' #

=== Graphical Package Managers ===
Search for "BZFlag" and install it.<br />
BZFlag will most likely be sorted to the Games category.

=== Fedora / Red Hat / Mandriva===
$ sudo yum install bzflag

For the server package:
$ sudo yum install bzflag-server

=== openSUSE ===
$ sudo zypper install bzflag

For the server package:
$ sudo zypper install bzflag-server

=== Native RPM ===
$ sudo rpm -ivh bzflag.x86.208.rpm

=== Ubuntu / Debian ===
$ sudo apt-get install bzflag

For the server package:
$ sudo apt-get install bzflag-server

=== Arch ===

# pacman -S bzflag

=== Gentoo ===

# emerge bzflag

== External Links ==
* [http://bzflag.org/downloads Download page for the latest binaries and source]

[[Category:Installing]]
[[Category:Tutorials]]

Getting Started

2016-07-04T14:58:47Z

Blast:

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 [http://bzflag.org/download download] the software for a number of different [http://en.wikipedia.org/wiki/Operating_system|operating systems], or [[Compiling|build]] the current code from the [[BZFlag_Git|Git repository]]

====Windows====
The most common operating system for players is Microsoft Windows. The official installer can be found at http://bzflag.org/downloads . 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://bzflag.org/downloads . Since BZ flag was not downloaded from the app store you might have trouble playing the game.
'''1. Go to finder
2. Find BZ flag and right click
3. Click on open
4. A page will show up'''
5. Click OK
6. You're playing!

====Linux====
The project does not distribute a pre-made binary package for Linux, but many Linux distributions have BZFlag in their package management systems (URPMI, APT, YUM, emerge, etc). Linux users can always build the game from the source code. Please see the [http://bzflag.org/download download] 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 [https://forums.bzflag.org/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 motto 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 BZFlag 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. Once you have selected a server to join, you can choose the '''Connect''' item.

|[[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, its 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. Another game type is '''Open Free For All''', abbreviated as ''OFFA''. Regardless of the color of the players, any tank can shoot and kill any other tank. This is a free for all death match in relation to other first person shooting type games.

'''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]]
|}

Compiling

2016-07-04T14:56:50Z

Blast:

==Overview==
Compiling BZFlag is the act of building executable applications for a target system using the raw source code..

==Obtaining sources==
In order to compile a user must have his or her own copy of the [[BZFlag_Source|Source Code]]. The code can be obtained from a source archive from the [http://bzflag.org/download download] page, or from [[BZFlag_Git|Git]].

==README files==
Users should always read the README files for the appropriate operating system. These files are located in the root directory of the source code tree.

==Compilers==
BZFlag is capable of being built on a number of compilers. The compiler used will depend in some way on the operating system of the computer doing the build.

* Windows computers can use the Visual C++ compiler, or the MinGW compiler (based on GCC). Windows is the most popular client OS and nearly all clients are built with the Visual C++ compiler, including the official binaries.
* Macintosh OS X computers use the Xcode compiler (or optionally gcc, see notes). OS X is the second most popular client OS, official builds are built with Xcode, not GCC.
* Linux and BSD computers use the GCC compiler. Linux is the third most common client OS and packages for distributions are built using GCC.

===Visual C++===
The most common way to build on windows to to use the Visual C++ 2010 compiler (Both Express and Retail versions are supported).
The current free Express version of Visual C++ can be found at [http://www.microsoft.com/express/vc/ http://www.microsoft.com/express/vc/]

===GCC===
If the required dependencies are installed, the user must then run the following commands from at root level of the source tree

./autogen.sh
./configure
make
make install

Please note that depending on permissions levels the '''make install''' command may need to be run as an administrator or root. On Macintosh OS X, do not run make install when building with GCC. Run the program from the source directory or install it manually as desired instead.

===Xcode===
The Xcode system uses the '''Xcode/BZFlag.xcodeproj''' project. Building is fairly straightforward. Follow the instructions in the README.MacOSX file.

==Dependencies==
In order to compile BZFlag, some third party libraries may be required depending on the operating system being built for. The readme file for each OS will contain the current dependencies for each OS and should be consulted before attempting any build.

The following is a general dependency list for version 2.4.

===Windows (Visual Studio)===
The only third party dependency required to build the client is the DirectX SDK that is available from Microsoft. A download is available at http://www.microsoft.com/en-us/download/details.aspx?id=6812.

If a user wishes to build a full set of windows installers, they will need to install the NSIS installer system, available from http://nsis.sourceforge.net.

All other dependencies are included.

===Linux (GCC)===
====Required Libraries====
* SDL development libraries (1.2.10 or greater)
* SDL-sound development libraries (1.2.10 or greater)
* libtool
* automake
* autoconf
* g++
* mesa development libraries (gl, and glu)
* mesa development libraries

====Optional Libraries====
These libraries are included with the source tree but users may have better results using ones included with a Linux distribution.

* curl development libraries
* c-ares development libraries
* glew development libraries
* zlib development libraries

===Macintosh OS X (Xcode or GCC)===
====Required Libraries====
* SDL framework 1.2 (1.3 may not work on all versions of OSX)

==Other build systems==
Other build systems may be supported in the various readme files (minGW, IRIX, SOLARIS,etc..) see the [[Compiling/Solaris_Notes]] page for more info.

[[Category:Development]]
[[Category:Compiling]]
[[Category:Tutorials]]

Main Page

2016-07-04T14:52:37Z

Blast:

__NOTOC__
[[Image:BZFlag_2010_shiny.png|center]]
{|style="width:100%;margin-top:+.7em;background-color:#fcfcfc;border:1px solid #ccc"
|style="width:56%;color:#000"|
{|style="width:280px;border:solid 0px;background:none"
|-
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
[[Image:Bzflag-48x48.png|left]]
<div style="font-size:175%;border:none;margin: 0;padding:.1em;color:#000">Welcome to the BZFlag Wiki,</div>
<div style="top:+0.2em;font-size: 95%">The source for community information on most things related to BZFlag!</div>
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">The BZFlag Wiki motto: [[BZFlagWiki:Be_bold|'''Be Bold!!''']]</div>
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">[[Special:Statistics|{{NUMBEROFARTICLES}}]] articles available</div>
|}
|style="width:15%;font-size:95%"|
[[Image:Bzflag-48x48.png|right]]
*[https://forums.bzflag.org/ The Forums]
*[https://github.com/BZFlag-Dev BZFlag on GitHub]

|}

{|style="width:100%;margin-top:+.7em;background-color:#B0E0E6;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">News</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">The developers of BZFlag are very proud to announce the general release of BZFlag 2.4.6, which is available for [http://bzflag.org/download download].</div>
|}

{|style="width:100%;margin-top:+.7em;background-color:#E0B0B0;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Account Registration</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">Wiki account registration is disabled at this time due to spam. If you wish to create a wiki account, drop by the #bzflag [[IRC]] channel.</div>
|}

Welcome to the BZFlag Wiki. The number of articles is growing, but there is much more to do. Please see the section '''Things To Do''' at the bottom of this page if you would like to help. The intention of this site is to draw together all of the great information about BZFlag and BZFlag related items that is currently scattered in many different places. Bringing all of this information together will make it easier for people to understand and answer all of the questions they have about running a server (options, permissions, set-up, etc.), configuring their client, coding plug-ins, compiling the source code, and anything else they can think of. All are welcome to contribute and may edit most pages. With everyone's help we can make this site a great resource to the BZFlag community. Please remember the BZFlag Wiki's new motto, [[BZFlagWiki:Be_bold|'''Be Bold''']] (click the link for a full explanation of the motto), when editing articles.

If you are unsure of how to edit or add pages, there is always a link to the [[Help:Contents|'''Help''']] section on the links to the left no matter where you are on the site. Don't be shy; give editing the site a try and be proud of your contributions! You can edit whether or not you have an account created. The advantage of having an account is that you will be credited with the contribution on the ''History'' link/tab of the page. Please take a look at the [[BZFlagWiki:Content Policy|Content Policy]] page for an overview of adding articles.

==General Information==
*[[Getting Started|Quick Start]]
*[[Getting Help]]
*[[:Category:BZFlagWiki_Policy|BZFlag Wiki Policy]]

==Areas of Interest==
*[[:Category:Client|Client]]
*[[:Category:Compiling|Compiling]]
*[[:Category:Concepts|Concepts]]
*[[:Category:Development|Development]]
*[[:Category:Gameplay|Gameplay]]
*[[:Category:Installing|Installing]]
*[[:Category:Leagues|Leagues]]
*[[:Category:Map Making|Map Making]]
*[[:Category:Maps|Maps]]
*[[:Category:Plug-Ins|Plug-ins]]
*[[Releases]]
*[[:Category:Server|Server]]
*[[:Category:Support|Support]]
*[[:Category:Tactics|Tactics]]
*[[Versions]]

==Things To Do==
*[[:Category:Stubs|Stubs]] These are short pages. You can help by expanding the content and adding more detail.
*[[:Special:Wantedpages|Wanted pages]] These are pages which don't exist yet but are pointed to from other pages. You can help by creating them.
*[[:Category:Items to be merged|Pages to merge]] These are pages which are similar. It is suggested that similar pages be merged. You can help by reviewing the pairs of pages and commenting on any proposals by using the "Discussion" tab at the top of each page.
*[[:Category:Old|Pages with old info]] You can help by updating these pages.
*[[:Category:Inaccurate|Inaccurate pages]] You can help by updating these pages.
*[[:Category:Pending Deletions|Pending deletions]] These are pages which have been nominated for deletion. You can help by reviewing these pages and commenting on any proposals by using the "Discussion" tab at the top of each page.

Webadmin

2016-07-03T21:21:03Z

Blast:

Webadmin is a server [[Plug-ins|plug-in]] that allowed for server management via a standard web browser interface (HTTP). Webadmin was being developed for [[BZFlag 2.99|v2.99.x]], but was not backported to 2.4 when development of 2.99.x ceased, and hasn't yet been included in an actual release.

==Usage==
When the Webadmin is loaded it must have take a [[Plug-ins#Parameters|parameter]] that tells the system where the html templates are. The default templates dir is ./ (current working dir). Since webadmin is an HTTPD plug-in the [[HTTPServer(plugin)|HTTPServer plugin]] must be in the same directory as webadmin, or have been previously loaded.

The usage is:

-loadplugin the/path/to/the/plugin/webadmin,the/path/to/the/templates

or in an already running game:

/loadplugin the/path/to/the/plugin/webadmin,the/path/to/the/templates

Examples:
-loadplugin "/plugins/webadmin/webadmin.so,/plugins/webadmin/templates"

==Templates==
Webadmin uses templates to define the various pages that are returned. 2 types of templates are used, include templates, and page templates. Both types use the same [[BZFS_HTTP_Template]] system. These templates can be customized if needed.

====Navigation====
The standard header provides links to all the standard pages.

===Pages===
Page templates always end in .page and are automatically scanned by the plug-in and shown in the default navigation header.

A number of default pages are provided with the distribution;

====Main====
This page provides a basic overview of the current server, it shows
* A player list
* Current Scoring
* Current Map
* Bandwith?
* Number of reports
* Current Polls

====Logs====
This page shows a list of server events with time stamps, including;
* Player Join/Part
* Player Spawn/Die
* Team Flag Captures
* Flag Pickups
* Kick/Ban events
* Report events

====Players====
This page provides more detailed info about the players, it contains the following info per player;
* Name
* Lag
* IP/Host
* Game stats
* Groups and Permissions
* Login/out history
* Flag history
* Chat text

====Vars====
This page provides a list of server vars with values, and allows them to be set.

====Bans====
This page provides a list server bans, allowing them to be reviewed, added, or removed.

====Chat====
This page shows the chat on the server with an automatic update. It allows the admin to send out chat text as a server message.

====Help Messages====
This pages shows the current help files, and allows them to be edited. (Is this useful?)

====Groups====
This pages shows the current groups, and allows them to be edited.

====Reports====
This pages shows the current reports, and allows them to be cleared.

===Includes===
Include templates are generaly used by the page templates or the plug-in for various common tasks. They are not scanned and listed in the default navigation header.

These templates are most commonly used for consistent page headers and footers as well as error pages.

==History==
Webadmin was initially started as part of the 2008 Google summer of code, it's design documents can be found at [[Webadmin_SOC2008]]. The plug-in has been rewritten significantly since the end of the Summer of Code.

[[Category:Development]]
[[Category:Plug-Ins]]

Main Page

2016-02-28T00:06:13Z

Blast: Update for 2.4.4

__NOTOC__
[[Image:BZFlag_2010_shiny.png|center]]
{|style="width:100%;margin-top:+.7em;background-color:#fcfcfc;border:1px solid #ccc"
|style="width:56%;color:#000"|
{|style="width:280px;border:solid 0px;background:none"
|-
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
[[Image:Bzflag-48x48.png|left]]
<div style="font-size:175%;border:none;margin: 0;padding:.1em;color:#000">Welcome to the BZFlag Wiki,</div>
<div style="top:+0.2em;font-size: 95%">The source for community information on most things related to BZFlag!</div>
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">The BZFlag Wiki motto: [[BZFlagWiki:Be_bold|'''Be Bold!!''']]</div>
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">[[Special:Statistics|{{NUMBEROFARTICLES}}]] articles available</div>
|}
|style="width:15%;font-size:95%"|
[[Image:Bzflag-48x48.png|right]]
*[https://forums.bzflag.org/ The Forums]
*[https://github.com/BZFlag-Dev BZFlag on GitHub]

|}

{|style="width:100%;margin-top:+.7em;background-color:#B0E0E6;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">News</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">The developers of BZFlag are very proud to announce the general release of BZFlag 2.4.4, which is available for [[Download]].</div>
|}

{|style="width:100%;margin-top:+.7em;background-color:#E0B0B0;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Account Registration</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">Wiki account registration is disabled at this time due to spam. If you wish to create a wiki account, drop by the #bzflag [[IRC]] channel.</div>
|}

Welcome to the BZFlag Wiki. The number of articles is growing, but there is much more to do. Please see the section '''Things To Do''' at the bottom of this page if you would like to help. The intention of this site is to draw together all of the great information about BZFlag and BZFlag related items that is currently scattered in many different places. Bringing all of this information together will make it easier for people to understand and answer all of the questions they have about running a server (options, permissions, set-up, etc.), configuring their client, coding plug-ins, compiling the source code, and anything else they can think of. All are welcome to contribute and may edit most pages. With everyone's help we can make this site a great resource to the BZFlag community. Please remember the BZFlag Wiki's new motto, [[BZFlagWiki:Be_bold|'''Be Bold''']] (click the link for a full explanation of the motto), when editing articles.

If you are unsure of how to edit or add pages, there is always a link to the [[Help:Contents|'''Help''']] section on the links to the left no matter where you are on the site. Don't be shy; give editing the site a try and be proud of your contributions! You can edit whether or not you have an account created. The advantage of having an account is that you will be credited with the contribution on the ''History'' link/tab of the page. Please take a look at the [[BZFlagWiki:Content Policy|Content Policy]] page for an overview of adding articles.

==General Information==
*[[Getting Started|Quick Start]]
*[[Getting Help]]
*[[:Category:BZFlagWiki_Policy|BZFlag Wiki Policy]]

==Areas of Interest==
*[[:Category:Client|Client]]
*[[:Category:Compiling|Compiling]]
*[[:Category:Concepts|Concepts]]
*[[:Category:Development|Development]]
*[[:Category:Gameplay|Gameplay]]
*[[:Category:Installing|Installing]]
*[[:Category:Leagues|Leagues]]
*[[:Category:Map Making|Map Making]]
*[[:Category:Maps|Maps]]
*[[:Category:Plug-Ins|Plug-ins]]
*[[Releases]]
*[[:Category:Server|Server]]
*[[:Category:Support|Support]]
*[[:Category:Tactics|Tactics]]
*[[Versions]]

==Things To Do==
*[[:Category:Stubs|Stubs]] These are short pages. You can help by expanding the content and adding more detail.
*[[:Special:Wantedpages|Wanted pages]] These are pages which don't exist yet but are pointed to from other pages. You can help by creating them.
*[[:Category:Items to be merged|Pages to merge]] These are pages which are similar. It is suggested that similar pages be merged. You can help by reviewing the pairs of pages and commenting on any proposals by using the "Discussion" tab at the top of each page.
*[[:Category:Old|Pages with old info]] You can help by updating these pages.
*[[:Category:Inaccurate|Inaccurate pages]] You can help by updating these pages.
*[[:Category:Pending Deletions|Pending deletions]] These are pages which have been nominated for deletion. You can help by reviewing these pages and commenting on any proposals by using the "Discussion" tab at the top of each page.

Main Page

2016-01-24T16:36:06Z

Blast:

__NOTOC__
[[Image:BZFlag_2010_shiny.png|center]]
{|style="width:100%;margin-top:+.7em;background-color:#fcfcfc;border:1px solid #ccc"
|style="width:56%;color:#000"|
{|style="width:280px;border:solid 0px;background:none"
|-
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
[[Image:Bzflag-48x48.png|left]]
<div style="font-size:175%;border:none;margin: 0;padding:.1em;color:#000">Welcome to the BZFlag Wiki,</div>
<div style="top:+0.2em;font-size: 95%">The source for community information on most things related to BZFlag!</div>
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">The BZFlag Wiki motto: [[BZFlagWiki:Be_bold|'''Be Bold!!''']]</div>
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">[[Special:Statistics|{{NUMBEROFARTICLES}}]] articles available</div>
|}
|style="width:15%;font-size:95%"|
[[Image:Bzflag-48x48.png|right]]
*[https://forums.bzflag.org/ The Forums]
*[https://github.com/BZFlag-Dev BZFlag on GitHub]

|}

{|style="width:100%;margin-top:+.7em;background-color:#B0E0E6;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">News</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">The developers of BZFlag are very proud to announce the general release of BZFlag 2.4.2 . BZFlag 2.4.2 is currently available for [[Download]]. Please note that the BZFlag 2.4.2 client will only connect to BZFlag 2.4.x servers.</div>
|}

{|style="width:100%;margin-top:+.7em;background-color:#E0B0B0;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Account Registration</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">Wiki account registration is disabled at this time due to spam. If you wish to create a wiki account, drop by the #bzflag [[IRC]] channel.</div>
|}

Welcome to the BZFlag Wiki. The number of articles is growing, but there is much more to do. Please see the section '''Things To Do''' at the bottom of this page if you would like to help. The intention of this site is to draw together all of the great information about BZFlag and BZFlag related items that is currently scattered in many different places. Bringing all of this information together will make it easier for people to understand and answer all of the questions they have about running a server (options, permissions, set-up, etc.), configuring their client, coding plug-ins, compiling the source code, and anything else they can think of. All are welcome to contribute and may edit most pages. With everyone's help we can make this site a great resource to the BZFlag community. Please remember the BZFlag Wiki's new motto, [[BZFlagWiki:Be_bold|'''Be Bold''']] (click the link for a full explanation of the motto), when editing articles.

If you are unsure of how to edit or add pages, there is always a link to the [[Help:Contents|'''Help''']] section on the links to the left no matter where you are on the site. Don't be shy; give editing the site a try and be proud of your contributions! You can edit whether or not you have an account created. The advantage of having an account is that you will be credited with the contribution on the ''History'' link/tab of the page. Please take a look at the [[BZFlagWiki:Content Policy|Content Policy]] page for an overview of adding articles.

==General Information==
*[[Getting Started|Quick Start]]
*[[Getting Help]]
*[[:Category:BZFlagWiki_Policy|BZFlag Wiki Policy]]

==Areas of Interest==
*[[:Category:Client|Client]]
*[[:Category:Compiling|Compiling]]
*[[:Category:Concepts|Concepts]]
*[[:Category:Development|Development]]
*[[:Category:Gameplay|Gameplay]]
*[[:Category:Installing|Installing]]
*[[:Category:Leagues|Leagues]]
*[[:Category:Map Making|Map Making]]
*[[:Category:Maps|Maps]]
*[[:Category:Plug-Ins|Plug-ins]]
*[[Releases]]
*[[:Category:Server|Server]]
*[[:Category:Support|Support]]
*[[:Category:Tactics|Tactics]]
*[[Versions]]

==Things To Do==
*[[:Category:Stubs|Stubs]] These are short pages. You can help by expanding the content and adding more detail.
*[[:Special:Wantedpages|Wanted pages]] These are pages which don't exist yet but are pointed to from other pages. You can help by creating them.
*[[:Category:Items to be merged|Pages to merge]] These are pages which are similar. It is suggested that similar pages be merged. You can help by reviewing the pairs of pages and commenting on any proposals by using the "Discussion" tab at the top of each page.
*[[:Category:Old|Pages with old info]] You can help by updating these pages.
*[[:Category:Inaccurate|Inaccurate pages]] You can help by updating these pages.
*[[:Category:Pending Deletions|Pending deletions]] These are pages which have been nominated for deletion. You can help by reviewing these pages and commenting on any proposals by using the "Discussion" tab at the top of each page.

MediaWiki:Sidebar

2016-01-24T16:35:23Z

Blast:

Main Page

2016-01-24T16:30:28Z

Blast:

__NOTOC__
[[Image:BZFlag_2010_shiny.png|center]]
{|style="width:100%;margin-top:+.7em;background-color:#fcfcfc;border:1px solid #ccc"
|style="width:56%;color:#000"|
{|style="width:280px;border:solid 0px;background:none"
|-
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
[[Image:Bzflag-48x48.png|left]]
<div style="font-size:175%;border:none;margin: 0;padding:.1em;color:#000">Welcome to the BZFlag Wiki,</div>
<div style="top:+0.2em;font-size: 95%">The source for community information on most things related to BZFlag!</div>
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">The BZFlag Wiki motto: [[BZFlagWiki:Be_bold|'''Be Bold!!''']]</div>
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">[[Special:Statistics|{{NUMBEROFARTICLES}}]] articles available</div>
|}
|style="width:15%;font-size:95%"|
[[Image:Bzflag-48x48.png|right]]
*[https://forums.bzflag.org/ The Forums]
*[https://github.com/BZFlag-Dev/bzflag/ BZFlag on GitHub]

|}

{|style="width:100%;margin-top:+.7em;background-color:#B0E0E6;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">News</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">The developers of BZFlag are very proud to announce the general release of BZFlag 2.4.2 . BZFlag 2.4.2 is currently available for [[Download]]. Please note that the BZFlag 2.4.2 client will only connect to BZFlag 2.4.x servers.</div>
|}

{|style="width:100%;margin-top:+.7em;background-color:#E0B0B0;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Account Registration</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">Wiki account registration is disabled at this time due to spam. If you wish to create a wiki account, drop by the #bzflag [[IRC]] channel.</div>
|}

Welcome to the BZFlag Wiki. The number of articles is growing, but there is much more to do. Please see the section '''Things To Do''' at the bottom of this page if you would like to help. The intention of this site is to draw together all of the great information about BZFlag and BZFlag related items that is currently scattered in many different places. Bringing all of this information together will make it easier for people to understand and answer all of the questions they have about running a server (options, permissions, set-up, etc.), configuring their client, coding plug-ins, compiling the source code, and anything else they can think of. All are welcome to contribute and may edit most pages. With everyone's help we can make this site a great resource to the BZFlag community. Please remember the BZFlag Wiki's new motto, [[BZFlagWiki:Be_bold|'''Be Bold''']] (click the link for a full explanation of the motto), when editing articles.

If you are unsure of how to edit or add pages, there is always a link to the [[Help:Contents|'''Help''']] section on the links to the left no matter where you are on the site. Don't be shy; give editing the site a try and be proud of your contributions! You can edit whether or not you have an account created. The advantage of having an account is that you will be credited with the contribution on the ''History'' link/tab of the page. Please take a look at the [[BZFlagWiki:Content Policy|Content Policy]] page for an overview of adding articles.

==General Information==
*[[Getting Started|Quick Start]]
*[[Getting Help]]
*[[:Category:BZFlagWiki_Policy|BZFlag Wiki Policy]]

==Areas of Interest==
*[[:Category:Client|Client]]
*[[:Category:Compiling|Compiling]]
*[[:Category:Concepts|Concepts]]
*[[:Category:Development|Development]]
*[[:Category:Gameplay|Gameplay]]
*[[:Category:Installing|Installing]]
*[[:Category:Leagues|Leagues]]
*[[:Category:Map Making|Map Making]]
*[[:Category:Maps|Maps]]
*[[:Category:Plug-Ins|Plug-ins]]
*[[Releases]]
*[[:Category:Server|Server]]
*[[:Category:Support|Support]]
*[[:Category:Tactics|Tactics]]
*[[Versions]]

==Things To Do==
*[[:Category:Stubs|Stubs]] These are short pages. You can help by expanding the content and adding more detail.
*[[:Special:Wantedpages|Wanted pages]] These are pages which don't exist yet but are pointed to from other pages. You can help by creating them.
*[[:Category:Items to be merged|Pages to merge]] These are pages which are similar. It is suggested that similar pages be merged. You can help by reviewing the pairs of pages and commenting on any proposals by using the "Discussion" tab at the top of each page.
*[[:Category:Old|Pages with old info]] You can help by updating these pages.
*[[:Category:Inaccurate|Inaccurate pages]] You can help by updating these pages.
*[[:Category:Pending Deletions|Pending deletions]] These are pages which have been nominated for deletion. You can help by reviewing these pages and commenting on any proposals by using the "Discussion" tab at the top of each page.

DevelopmentPlans/2.6.0

2015-06-14T22:26:41Z

Blast:

==Overview==

2.6.0 will be a new breaking release that is not compatible with the 2.4.x line. A strong focus of this release should be improving the user experience and improving the flexibility of the user interface.

==Goals==

This list covers the major goals of this release, and the features related to each goal.

* Tutorial Mode (1.1.1, 1.1.2, 4.1, 4.2, 4.3, 5.1, 5.2, 5.3, 6.1, 6.2, 6.3, 7.1, 7.2)
* Easier polling system (1.1.2, 2.1, 2.2)
* Useful MOTD (1.1.1, 3.1, 3.2)
* Better localized messages (4.1, 4.2, 4.3, 5.1, 7.1)
* Additional mapping features (5.1, 5.2, 5.3)

==Features==

# Add new UI elements
## [[DevelopmentPlans/Dialogs|Dialogs]]
### Modal dialogs are featured front and center, and require being dismissed by the user. They support hotkeys, server-specified buttons, or freeform menu items. Keyboard, mouse (including clicking items), and joystick interaction is supported.
### Unobtrusive dialogs show up as smaller semi-transparent boxes towards the edge of the screen and support only hotkeys (keyboard, mouse button, joystick button) for interaction.
# Revamp the poll system
## Add an actual message type to the protocol for the poll system (MsgPoll and MsgVote, perhaps, or just build it with generic dialog message types)
## Add an unobtrusive dialog for polls with support for both the old style /vote command and polling/dialog key bindings.
# Revamp the MOTD
## Update client MOTD code to send the client version and other system information (operating system and similar) to the server. The MOTD server would then use this information to send appropriate MOTD entries.
## Have the MOTD code detect when there is a new MOTD and pop up a modal dialog. Include a MOTD menu item for later access.
# Font system and language support
## New font system (FTGL or similar)
## Add the additional fonts and better translations from 2.99.x.
## Send the client locale to the server so that the server could localize messages sent to the client
# Map features
## Text object (from 2.99.x)
## BZDB controlled attributes
## Mesh bases/teleporters
## Better define/group support
### Links (with relative and absolute names)
### World weapons and entry zones (with transforms)
### Physics drivers (with transforms and copying)
### Texture matrices, dynamic colors, transforms, materials
# Server Side Players
## Server-side shot path tracking
## Shared client logic library used in both the client and server.
## Ability to spawn and control SSPs from a plugin.
# Other
## Add a per-player name/value pair system. This would be used for data like:
##* Motto
##* Locale
## Implement MsgAllow from 2.99.x (or should this be part of the per-player name/value pair system?)
## [[DevelopmentPlans/ShotIDCleanup|Shot ID cleanup]]
## Make client aware of shot limit so it can display count and can know when the flag is going to drop
## Allow switching teams without rejoining
## Rework the joining process
### Handle all ban checks (including DNS resolution and hostban checks) before allowing the player to pull the world or enter.
### Move team selection to after the join (start off in observer, and have a dialog)
## List server indication of game options that are per object or zone ( rico, jump, etc..)
## Generic server-controlled marker and hunt system.
## Use BZID for all saved user identifiers not names.

==Misc==

# Clean up platform code. For instance:
## Make the ResInfo class also contain a depth value so that Windows doesn't have to have it's own custom Resolution class, and then sort based on the ResInfo items instead of platform specific sorting methods (Windows and Linux platform code have their own very similar methods).
## Make the Linux platform code build again (which may be solved by just doing the ResInfo change). Note that SDL is the normal platform for Linux systems, so the 'Linux' platform code is for Linux systems without SDL.

[[Category:Development Plans]]

DevelopmentPlans/2.4.4

2015-05-23T19:43:30Z

Blast:

==Overview==
2.4.4 will be the second maintenance release of the 2.4.x compatibility line. It may never happen but, here is what we didn't do in 2.4.2
==Tasks==

===Bugs To Be Fixed===

=====Primary=====
* <strike>The bzadmin client in the 2.4.0 and 2.4.2 Windows installer was not built with PDCurses</strike> (Fixed as of r22627)
* <strike>timeout does not work with multiple team flags https://sourceforge.net/tracker/?func=detail&aid=3368409&group_id=3248&atid=103248</strike> (Fixed 26/01/12 DTR)
* <strike>line numbers in drawinfo errors https://sourceforge.net/tracker/?func=detail&aid=2139541&group_id=3248&atid=103248</strike> (Fixed as of r22646)
* <strike>stats not tracking https://sourceforge.net/tracker/?func=detail&aid=1433676&group_id=3248&atid=103248</strike> (Fixed as of r22668)
* time limiter and agility https://sourceforge.net/tracker/?func=detail&aid=3368408&group_id=3248&atid=103248
* z buffer issues https://sourceforge.net/tracker/?func=detail&aid=3368245&group_id=3248&atid=103248
* eval "configure should test and enable the fudged acosf atanf asinf" from old TODO.

=====Secondary=====

===Features===
* <strike>Graphic tank on radar at high zoom</strike> (Fixed as of r22664)
* <strike>BZFScron (implement as backport from 2.99)</strike> (BTH)
* <strike>Push Stats ( finish backend )</strike> (postponed to a later time)
* Joystick fixes (DTR?)
* CIDR/subnet bans from Filter.cxx (Make a common ban check/resolution function/class?)

==Known Bugs==

==Feature Requests to Eval==
* <strike>Pause the console https://sourceforge.net/tracker/index.php?func=detail&aid=3464640&group_id=3248&atid=353248</strike> (Fixed as of r22811)

[[Category:Development Plans]]

World units

2015-03-02T11:12:49Z

Blast: Reverted edits by 173.192.81.187 (talk) to last revision by Yrogirg

A world unit is the basic unit of measure when dealing with BZFlag. World units have no real-world counterpart, as they are a purely virtual concept, but they can be though of to be equivalent to about 1 meter in length if you assume a roughly real world sized [[tank]].

All coordinates in the map file are specified in World Units. Many [[Server Variables]] are specified in terms of world units or world units per second as well.

==Origin==
The origin for the World coordinate system is the center of the map.

==Orientation==
World Units are oriented in a normal right hand rule coordinate system with positive Z being the "UP" direction.

===North===
"north" on the in game radar is the positive Y direction in map coordinates.

===Figure 1===
This image shows a typical map, with the origin and axis directions clearly marked out.
[[Image:MapCoordinateSystem.png]]

== Some useful measures at default settings ==
<div align="center">
{| cellpadding="0" cellspacing="0" border="1" width="60%"
|-
|width="60%"|Jump height limit (next to impossible)
|width="20%"|See below
|width="10%"|18.42
|-
|Common jump height
|See below
|17.0
|-
|Tank length
|_tankLength
|6.0
|-
|Tank width
|_tankWidth
|2.8
|-
|Tank height
|_tankHeight
|2.05
|-
|Barrel height
|_muzzleHeight
|1.57
|-
|Drivable bump height
|_bumpHeight
|0.33
|-
|}
</div>

== Calculating jump height ==
Jump height is determined by the gravity and jump velocity settings on the server (see [[Server Variables]] for details). Note that the jump velocity and gravity may be altered by flags including [[Flag List|Low Gravity]] and [[Flag List|Wings]].

:Max jump height = -(_jumpVelocity)<sup>2</sup> / (2 * (_gravity))

A typical BZFlag player can reliably jump a bit more than 90% of the maximum jump height.

[[Category:Map Making]]
[[Category:Concepts]]

Getting Started

2014-11-12T03:00:23Z

Blast: /* Join Game Menu */

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], or [[Compiling|build]] the current code from the [[SVN|Subversion repository]]

====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.2/bzflag-2.4.2_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.2/BZFlag-2.4.2.zip/download . Since BZ flag was not downloaded from the app store you might have trouble playing the game.
'''1. Go to finder
2. Find BZ flag and right click
3. Click on open
4. A page will show up'''
5. Click OK
6. You're playing!

====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 motto 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 BZFlag 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. Once you have selected a server to join, you can choose the '''Connect''' item.

|[[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, its 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. Another game type is '''Open Free For All''', abbreviated as ''OFFA''. Regardless of the color of the players, any tank can shoot and kill any other tank. This is a free for all death match in relation to other first person shooting type games.

'''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]]
|}

BZFS

2014-07-08T02:15:16Z

Blast: /* Command line options and Config files */

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

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

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

==Command line options and Config files==
BZFS uses [[BZFS Command Line Options|command line options]] to set the various modes and options for a game. These options can be specified from the command line prompt of the host OS or inside a plain text configuration file. The path (relative or absolute) to the config file is specified with the '''-conf''' option.

See the [[Sample_conf|sample configuration]] for some examples of command line options. However, it is recommended that you create a configuration file from scratch, and test it every few lines. This will help in the case of configuration errors as you will have only modified a few lines that introduced the error.

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

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

==See also==
[[BZFS Command Line Options]]

[[BZFS API]]

[[Plug-ins]]

[[Sample conf|Sample Config File]]

[[Category:Server]]

MediaWiki:Privacypage

2014-07-02T01:14:54Z

Blast:

bzflaghome:privacy

MediaWiki:Privacypage

2014-07-02T01:06:22Z

Blast: Created page with "http://bzflag.org/privacy"

http://bzflag.org/privacy

MediaWiki:Sidebar

2014-07-02T01:04:13Z

Blast:

Main Page

2013-07-25T14:43:45Z

Blast:

__NOTOC__
[[Image:BZFlag_2010_shiny.png|center]]
{|style="width:100%;margin-top:+.7em;background-color:#fcfcfc;border:1px solid #ccc"
|style="width:56%;color:#000"|
{|style="width:280px;border:solid 0px;background:none"
|-
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
[[Image:Bzflag-48x48.png|left]]
<div style="font-size:175%;border:none;margin: 0;padding:.1em;color:#000">Welcome to the BZFlag Wiki,</div>
<div style="top:+0.2em;font-size: 95%">The source for community information on most things related to BZFlag!</div>
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">The BZFlag Wiki motto: [[BZFlagWiki:Be_bold|'''Be Bold!!''']]</div>
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">[[Special:Statistics|{{NUMBEROFARTICLES}}]] articles available</div>
|}
|style="width:15%;font-size:95%"|
[[Image:Bzflag-48x48.png|right]]
*[http://my.bzflag.org/bb The Forums]
*[http://my.bzflag.org BZFlag Stats]
*[http://sourceforge.net/projects/bzflag/ BZFlag on SourceForge]

|}

{|style="width:100%;margin-top:+.7em;background-color:#B0E0E6;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">News</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">The developers of BZFlag are very proud to announce the general release of BZFlag 2.4.2 . BZFlag 2.4.2 is currently available for [[Download]]. Please note that the BZFlag 2.4.2 client will only connect to BZFlag 2.4.x servers.</div>
|}

{|style="width:100%;margin-top:+.7em;background-color:#E0B0B0;border:1px solid #ccc"
|style="width:100%;text-align:left;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Account Registration</div>
<div style="margin-left:1em;margin-right:1em;margin-bottom:+.5em;top:+0.8em;font-size: 105%">Wiki account registration is disabled at this time due to spam. If you wish to create a wiki account, drop by the #bzflag [[IRC]] channel.</div>
|}

Welcome to the BZFlag Wiki. The number of articles is growing, but there is much more to do. Please see the section '''Things To Do''' at the bottom of this page if you would like to help. The intention of this site is to draw together all of the great information about BZFlag and BZFlag related items that is currently scattered in many different places. Bringing all of this information together will make it easier for people to understand and answer all of the questions they have about running a server (options, permissions, set-up, etc.), configuring their client, coding plug-ins, compiling the source code, and anything else they can think of. All are welcome to contribute and may edit most pages. With everyone's help we can make this site a great resource to the BZFlag community. Please remember the BZFlag Wiki's new motto, [[BZFlagWiki:Be_bold|'''Be Bold''']] (click the link for a full explanation of the motto), when editing articles.

If you are unsure of how to edit or add pages, there is always a link to the [[Help:Contents|'''Help''']] section on the links to the left no matter where you are on the site. Don't be shy; give editing the site a try and be proud of your contributions! You can edit whether or not you have an account created. The advantage of having an account is that you will be credited with the contribution on the ''History'' link/tab of the page. Please take a look at the [[BZFlagWiki:Content Policy|Content Policy]] page for an overview of adding articles.

==General Information==
*[[Getting Started|Quick Start]]
*[[Getting Help]]
*[[:Category:BZFlagWiki_Policy|BZFlag Wiki Policy]]

==Areas of Interest==
*[[:Category:Client|Client]]
*[[:Category:Compiling|Compiling]]
*[[:Category:Concepts|Concepts]]
*[[:Category:Development|Development]]
*[[:Category:Gameplay|Gameplay]]
*[[:Category:Installing|Installing]]
*[[:Category:Leagues|Leagues]]
*[[:Category:Map Making|Map Making]]
*[[:Category:Maps|Maps]]
*[[:Category:Plug-Ins|Plug-ins]]
*[[Releases]]
*[[:Category:Server|Server]]
*[[:Category:Support|Support]]
*[[:Category:Tactics|Tactics]]
*[[Versions]]

==Things To Do==
*[[:Category:Stubs|Stubs]] These are short pages. You can help by expanding the content and adding more detail.
*[[:Special:Wantedpages|Wanted pages]] These are pages which don't exist yet but are pointed to from other pages. You can help by creating them.
*[[:Category:Items to be merged|Pages to merge]] These are pages which are similar. It is suggested that similar pages be merged. You can help by reviewing the pairs of pages and commenting on any proposals by using the "Discussion" tab at the top of each page.
*[[:Category:Old|Pages with old info]] You can help by updating these pages.
*[[:Category:Inaccurate|Inaccurate pages]] You can help by updating these pages.
*[[:Category:Pending Deletions|Pending deletions]] These are pages which have been nominated for deletion. You can help by reviewing these pages and commenting on any proposals by using the "Discussion" tab at the top of each page.

BZFlag SVN

2013-05-14T01:05:39Z

Blast: /* External Links */

BZFlag SVN, is the [http://en.wikipedia.org/wiki/Subversion_(software) Subversion Revision Control System] used by the development team to maintain and store the [[BZFlag Source]] code. The SVN system is hosted by [http://www.sourceforge.net SourceForge] and is accessible by anyone with the proper software. The SVN system replaces the [[BZFlag CVS]] system that was used in the past.

==SVN clients==
To access the source code via SVN , you will need a SVN client. Most unix/linux type operating systems have the command line SVN client as an installable option. Windows users must download the Windows native [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 SVN command line utility] or a third party SVN client, such as [http://tortoisesvn.tigris.org/ the Tortoise Graphical SVN Client] (highly recommended). SVN is also available to Windows users via [http://cygwin.com/ Cygwin] with SVN and other common Devel tools selected during installation.

==Getting code from SVN Access==
===Command line===
The simplest way to get the bzflag source code is to use the URL for the current ( or TRUNK ) bzflag module.

svn co <nowiki>svn://svn.code.sf.net/p/bzflag/code/trunk/bzflag</nowiki>

This will get you the current bzflag source code for the development version.

If you want the SVN code for the 2.0.x compatible version use the URL

svn co <nowiki>svn://svn.code.sf.net/p/bzflag/code/branches/release_maint/v2_0/bzflag</nowiki>

If you wish to get all of our source code in one step, you can get the entire repository with the command.

svn co <nowiki>svn://svn.code.sf.net/p/bzflag/code/</nowiki> bzflag

This will get all modules, branches, tags, and subdirs. Beware! This is a very large amount of data (make sure you have at least 2.7 GB of disk space available) and will take a while and will be rather useless, as it is the code for every version of bzflag. Most users will only need the code for one specific version.

The '''best''' way, is to only get the subdir for the module you are interested in. This is much more efficient and suitable for most users. The most common module to get is the bzflag module, as it is the actual game.

Please see the sections below for more information about the URLs to use for branches and modules.

===TortoiseSVN===

Windows users that use the Tortoise Graphical SVN Client simply enter the URL of the SVN path they wish to check out in the field marked ''URL of repository''. For the current version of all modules simply use the /trunk path. Note, if you want your code to be checked out into a new folder, be sure to enter that folder name in the ''Checkout directory'' field.

If you wish to get only a single module subdir, or a revision, simply use the URL specified in the sections below.

==Committing Code to SVN==

Project developers that need write access to the source code to make changes ( or [[commits]] ) need to provide their sourceforge username and password when doing a SVN commit. A sourceforge account is required for developer access, as well as approval from a project administrator.

Please make sure that your svn config file includes the correct [[Auto-props]]. If you get a [[Mime-types]] error, you either didn't enable the correct auto-props setting in your subversion config file or you need to manually set file properties.

===Command Line===
Using the command
svn commit
in a directory that has code changes will commit any changed code back to the repository. The svn client will prompt you for your username and password.

===TortoiseSVN===
Windows users that use the Tortoise Graphical SVN Client can simply choose the SVN commit item, and enter their username and password when prompted.

Tortoise users may set auto-props from the General Settings property page; click the Edit button and paste the auto-props into the correct section, then un-comment the "enable-auto-props = yes" line above it.

==Updating code from SVN to the current version==

===Command Line===
Using the command
svn up
in the directory that has checked out code will cause subversion to update that code to the current version for that branch.

===TortoiseSVN===
Windows users that use the Tortoise Graphical SVN Client can simply choose the SVN update item from their right click menus.

==Reverting local code to the server's version==

===Command Line===
Using the command
svn revert
svn up
in the directory that has checked out code will cause subversion to set flags on all modified local files, then update the code to match the code on the server. NOTE: This has the effect of wiping out all local changes, so use with caution!

===TortoiseSVN===
Right click on the file or directory you would like to revert and from the TortoiseSVN submenu, select '''Revert...'''. The menus is context sensitive, so there must be code that has been modified for the menu choice to be available.

==Module sub directories==

The source code in SVN is broken up into a number of modules for ease of use and management. When requesting the source code from the SVN system a sub-directory may be specified to limit the code that is accessed.

The current SVN modules are:
*bzflag : The main module that includes the game [[BZFlag 2.0.8|client]], [[BZFS|server]], [[plug-ins]], and [[BZAdmin]].
*admin : The [[Master Ban]] list
*bzedit : The linux version of the BZFlag map editor [[BZEdit]]
*bzeditw32 : The windows version of the BZFlag map editor [[BZEditWin32]]
*web : The main website at http://www.bzflag.org
*db : Files related to the website http://my.bzflag.org and the [[Global Registration]] system.
*pybzflag : an abandoned python implementation of BZFlag
*bzworkbench : The source code for [[BZWorkBench]]
*bzwgen: The source code for the automatic city generator.

to get the current version of a module, you would add
/trunk/MODULE_NAME
after the normal SVN URL.

so to get the current version of just the bzflag module, the URL would be

<nowiki>svn://svn.code.sf.net/p/bzflag/code/trunk/bzflag/</nowiki>

From the command line

svn co <nowiki>svn://svn.code.sf.net/p/bzflag/code/trunk/bzflag</nowiki>

==Branches==
Branches in subversion are simply subfolders.
All branches are in the /branches subdirectory off the root level of the SVN tree, listed [http://bzflag.svn.sourceforge.net/viewvc/bzflag/branches/ here].
To get the code in a branch, you simply use the branch URL in your svn client.

To get the 2.0.x branch of the BZFlag module, you'd use the following URL.
svn://svn.code.sf.net/p/bzflag/code/branches/release_maint/v2_0/bzflag/

==Useful Tools==

===Windows===

'''Tortoise Graphical SVN Client''': integrates subversion into the windows explorer shell. http://tortoisesvn.tigris.org/

'''Ankh Subversion''': integrates subversion into Visual C++ as a native source control provider. http://ankhsvn.tigris.org/

'''WinMerge''': visual merge and diff tool for windows. http://winmerge.org/

==See also==
[[Versions]]

==External Links==
[https://sourceforge.net/p/bzflag/code/HEAD/tree/ BZFlag SVN Web Interface]

[[Category:Development]]
[[Category:Compiling]]
[[Category:Versions]]

DevelopmentPlans/2.6.0

2013-04-28T17:08:37Z

Blast: /* Features */

DevelopmentPlans/Dialogs

2013-04-28T17:08:08Z

Blast: Created page with "{{DesignDocument}} ==Features== * Modal dialogs ** Keyboard, mouse, and joystick navigation ** Takes over the controls ** Provide the ability to have popup menus that can be na..."

{{DesignDocument}}

==Features==

* Modal dialogs
** Keyboard, mouse, and joystick navigation
** Takes over the controls
** Provide the ability to have popup menus that can be navigated.
** Use for starting polls, team selection, player stats (the 'home' key screen), and as a replacement for the 'o' menu
** Allow the server to specify customized buttons or menu items
* Unobtrusive dialogs
** Keyboard, mouse, and joystick hotkeys (hotkeys default to only being on the keyboard, but could be configured on other devices)
** Use for voting in polls and notifications
** Allow them to be positioned on the left, center, and right
* Server controlled and configurable
** Replace some current forms of interaction with dialogs so that the server can improve or customize these operations.
** Enable plugins to trigger dialogs
* Dialog priority
** Modal dialogs take priority, and should gray out the background. Additionally, hotkeys on any unobtrusive dialogs should be hidden when a modal dialog is shown.
* Handle dismissing dialogs on the server (though provide a dismiss option on some dialogs). This would allow dialogs to be closed when they are no longer relevant (such as when a poll is completed/vetoed) or when a specific amount of time has passed.

==Dialog Management==

The server should be the manager of the dialogs. The client should just show what it was told to display, and should send which hotkey was pressed. This way, the server will know when a user has viewed/dismissed a dialog and can accurately set timeouts on dialogs that were not focused on yet (such as when multiple unobtrusive/modal dialogs were shown, or when a modal dialog obscured an unobtrusive dialog).

==Protocol==

This is a possible idea for how the protocol could be laid out.

Unobtrusive Dialog:
* GUID
* Dialog Type (set to unobtrusive)
* Alignment (left, right, center)
* Message

Modal Dialog with text:
* GUID
* Dialog Type (set to modal text)
* Title
* Message
* Item Count (Number of buttons)
* Item Labels ('''Item Count''' number of strings, labels for the buttons)

Modal Dialog with menu:
* GUID
* Dialog Type (set to modal menu)
* Title
* Message (Can be a zero length string)
* Item Count (Number of menu rows)
* Item Labels ('''Item Count''' number of strings, labels for the menu items)

==Mockups==

Unobtrusive dialog:

[[Image:DevelopmentPlans_Dialog_Unobtrusive.png|640px]]

File:DevelopmentPlans Dialog Unobtrusive.png

2013-04-28T16:29:12Z

Blast:

DevelopmentPlans/2.6.0

2013-04-28T15:34:14Z

Blast: /* Goals */

==Overview==

2.6.0 will be a new breaking release that is not compatible with the 2.4.x line. A strong focus of this release should be improving the user experience and improving the flexibility of the user interface.

==Goals==

This list covers the major goals of this release, and the features related to each goal.

* Tutorial Mode (1.1.1, 1.1.2, 4.1, 4.2, 4.3, 5.1, 5.2, 5.3, 6.1, 6.2, 6.3, 7.1, 7.2)
* Easier polling system (1.1.2, 2.1, 2.2)
* Useful MOTD (1.1.1, 3.1, 3.2)
* Better localized messages (4.1, 4.2, 4.3, 5.1, 7.1)
* Additional mapping features (5.1, 5.2, 5.3)

==Features==

# Add new UI elements
## Dialogs
### Modal dialogs are featured front and center, and require being dismissed by the user. They support hotkeys, server-specified buttons, or freeform menu items. Keyboard, mouse (including clicking items), and joystick interaction is supported.
### Unobtrusive dialogs show up as smaller semi-transparent boxes towards the edge of the screen and support only hotkeys (keyboard, mouse button, joystick button) for interaction.
# Revamp the poll system
## Add an actual message type to the protocol for the poll system (MsgPoll and MsgVote, perhaps, or just build it with generic dialog message types)
## Add an unobtrusive dialog for polls with support for both the old style /vote command and polling/dialog key bindings.
# Revamp the MOTD
## Update client MOTD code to send the client version and other system information (operating system and similar) to the server. The MOTD server would then use this information to send appropriate MOTD entries.
## Have the MOTD code detect when there is a new MOTD and pop up a modal dialog. Include a MOTD menu item for later access.
# Font system and language support
## New font system (FTGL or similar)
## Add the additional fonts and better translations from 2.99.x.
## Send the client locale to the server so that the server could localize messages sent to the client
# Map features
## Text object (from 2.99.x)
## BZDB controlled attributes
## Mesh bases/teleporters
## Better define/group support
### Links (with relative and absolute names)
### World weapons and entry zones (with transforms)
### Physics drivers (with transforms and copying)
### Texture matrices, dynamic colors, transforms, materials
# Server Side Players
## Server-side shot path tracking
## Shared client logic library used in both the client and server.
## Ability to spawn and control SSPs from a plugin.
# Other
## Add a per-player name/value pair system. This would be used for data like:
##* Motto
##* Locale
## Implement MsgAllow from 2.99.x (or should this be part of the per-player name/value pair system?)
## [[DevelopmentPlans/ShotIDCleanup|Shot ID cleanup]]
## Make client aware of shot limit so it can display count and can know when the flag is going to drop
## Allow switching teams without rejoining
## Rework the joining process
### Handle all ban checks (including DNS resolution and hostban checks) before allowing the player to pull the world or enter.
### Move team selection to after the join (start off in observer, and have a dialog)
## List server indication of game options that are per object or zone ( rico, jump, etc..)
## Generic server-controlled marker and hunt system.
## Use BZID for all saved user identifiers not names.

Development RoadMap

2013-04-28T15:32:17Z

Blast: /* 2.8 */

==Overview==
This document discusses the general development road-map for Future BZFlag Releases.

===Features===
Individual features may move up or down the roadmap depending on how/when they get done. Entire releases may be pushed up the roadmap or merged depending on how development goes.

==Current Development Target==
The current development target (trunk) is the [[DevelopmentPlans/2.4.2|2.4.2]] release

==2.4==
'''Goals:''' Get a release out

2.4 will be the next release of BZFlag and is protocol incompatible with all previous versions.
===2.4.0 (Wake the dead)===
Released on 2011/07/03 [[BZFlag 2.4.0]]

===2.4.2===
[[BZFlag_2.4.2]] Release page.

[[DevelopmentPlans/2.4.2|Planning page for 2.4.2]]

2.4.2 was the first maintenance release of the 2.4.x compatibility line. It does contain some bug fixes but it's primary function is to provide an updated package for the debian system. It does include non breaking items that were not ready during the initial release including:

* Fastmap

===2.4.4===
[[DevelopmentPlans/2.4.4|Planning page for 2.4.4]]

2.4.4 will be a bug fix maintenance release of the 2.4.x compatibility line. Its primary function is to fix bugs found in the 2.4.0/2 releases and to include non breaking items that were not ready during the initial release including:

* Ensure bzadmin on Windows gets built with PDCurses
* All the horrible things we missed
* BZFScron
* Push Stats
* Joystick fixes
* CIDR/subnet bans from Filter.cxx

===2.4.6===
* New Death effects
* HTTP Management plugins
* Bug fixes
* New Font System
* New Server List
* New Translations
* Download Authorization Dialog
* GM lock-on markers on the radar.
* Fix mac .app build system (make it just use a script not xcode?)
* Sever side IP/Host/callsign (not perm base) mute
* Evaluate rabbit logic.
* how to deal with third party libs in plugins, specialy ones we build optionaly.
* command line options that have -set <name> <value> equivalents should be reviewed and possibly eliminated
* bzfs should error out if no users or groups have SPAWN
* Teach Roger not to drive into deadly physics drivers
* Test anti permissions.
* Translation update push.
* Set app icon for as many OSs as possible (SDL does not do this)
* Case insensitive bans.
* Block spamers on rejoin (using BZID?)
* Max chat rate (using filters?) with auto scilence. (maybe a plugin?)
* Windows BZAdmin cleanup ( eval if it works the same as linux)
* Sanity check list server input ( players over limit, etc..)
* Extend player name cycling (like on /kick and /ban) to /poll kick and /poll ban
* When game is over, autoboot everyone after some time, so server cannot be blocked forever by one player just sitting there.

===2.4.x (Maintenance)===
Continuing releases to fix critical bugs. New features should go into 2.6 at this point.

==2.6 (Next Breaking Release)==
[[DevelopmentPlans/2.6.0|Planning page for 2.6.0]]

This release will focus on improving the user experience and the user interface.

* Tutorial Mode
* Easier polling system
* Useful MOTD
* Better localized messages
* Additional mapping features

See the planning page for details about the planned features

==2.8==

'''Goals:''' Continue Development and cleanup gameplay.

This version may be rolled into the 3.0 release if that code base is still usable. If the code is extended from 2.4 it may have these features;
* Acceleration changes
* Flag Drop "Zone" feature
* XFire ?
* OpenAL/Support, OGG, Hardware mixing and 3d (replace platform audio?)
* Solution for dropped shots (TCP? confirm message? logging?)
* Tank parts? Customization? [[CustomTanks]]
* More colors in OFFA?
* Eval ID and ID label markers (MMO style? Always show teammates?)
* Graphics settings cleanup, optimize for GF2 or newer. Make low good for GMA chipsets.
* Server List showing that games require ID ( cool little icon?)
* Extern cleanup
* Vector class use instead of float[3]
* Incorporate the player's handicap value and physic drivers into the check calculations.
* Decide what a GM is and how it should behave when guided when the user has or does not have the flag, and how the lock should work with ST and CL
* evaluate -noSelfKills server option at [https://sourceforge.net/tracker/?func=detail&aid=3537226&group_id=3248&atid=353248 tracker]
* evaluate -w server option wings instead of jumping [https://sourceforge.net/tracker/?func=detail&aid=3599568&group_id=3248&atid=353248 tracker]

==3.0 (Next Major)==
'''Goals:''' Get back to where V3 wanted to be.

Using the 2.99 continuing branch, or the 2.6 branch with a lot of back-ports depending on code-base stability.

* Lua (Client side)
* Have BZFS convert all world objects into mesh representations for consistent client collisions.
* Point in Polyhedron tests to remove inside/outside points.
* New Simulation
* Shot Type/Flag Type split
* Things added in previous versions that were not back-ported from the codebase this release uses.
* Lobby
* Support additional map objects inside definitions ([https://sourceforge.net/tracker/?func=detail&aid=2938335&group_id=3248&atid=103248 SF Bug 2938335])

===3.0.2===
'''Goals:''' End user experience

Compatible release ( if possible ) that makes the game easier for new users to play and for servers to manage players.
* UI Cleanup
* New Group and User Management.
* In game registration
* Tutorials
* Option to kick to observer.
* Make the texture manager give out IDs and have everyone use the ID, not the image pointer, as it can change. Or make the image pointer self updating.
* Binding keys to multiple actions (lua macros?)

==3.2==
'''Goals:''' Modernization

Goals for this release are to bring the game's networking and simulation system up to par with modern games.
* Lag compensation
* Threaded Networking
* Threaded Simulation
* UI customization
* General Resource Updates and Downloads (sounds, scripts etc..)?
* HTF as real mode
* IPV 6

==3.4==
'''Goals:''' Server State

* Server Side Radar
* Server Side Shots (Iterative octree cell shot collision detection)
* Server Side Deaths
* Server Side Bot API and good bot samples
* Removal of Client Side Logic
* Generic Simulation serialization for recordings that are independent of network format.
* Third party networking?

==4.0==
'''Goals:''' Graphics Upgrades

* Third party graphics engine? Ogre? Irrlicht? lightfeather?
* Patching?
* Shader/Material Support?
* OpenGL 2+?
* Better Lighting, light objects in maps ( shaders or projected textures?)
* A library of "smart server side bots"

==5.0==
'''Goals:''' Extensibility

* Server defined game logic and settings
* Game mode plug-ins/scripts on the server
* Server defined graphics elements ( shots, models, etc)
* List server separation by game mode
* Require Registration and limit server choices until verified?
* Social Components for players ( player ratings, facebooklike stuff?)
* League Integration

[[Category:Development_Plans]]

DevelopmentPlans/2.6.0

2013-04-28T15:31:25Z

Blast:

==Overview==

2.6.0 will be a new breaking release that is not compatible with the 2.4.x line. A strong focus of this release should be improving the user experience and improving the flexibility of the user interface.

==Goals==

* Tutorial Mode (1.1.1, 1.1.2, 4.1, 4.2, 4.3, 5.1, 5.2, 5.3, 6.1, 6.2, 6.3, 7.1, 7.2)
* Easier polling system (1.1.2, 2.1, 2.2)
* Useful MOTD (1.1.1, 3.1, 3.2)
* Better localized messages (4.1, 4.2, 4.3, 5.1, 7.1)
* Additional mapping features (5.1, 5.2, 5.3)

==Features==

# Add new UI elements
## Dialogs
### Modal dialogs are featured front and center, and require being dismissed by the user. They support hotkeys, server-specified buttons, or freeform menu items. Keyboard, mouse (including clicking items), and joystick interaction is supported.
### Unobtrusive dialogs show up as smaller semi-transparent boxes towards the edge of the screen and support only hotkeys (keyboard, mouse button, joystick button) for interaction.
# Revamp the poll system
## Add an actual message type to the protocol for the poll system (MsgPoll and MsgVote, perhaps, or just build it with generic dialog message types)
## Add an unobtrusive dialog for polls with support for both the old style /vote command and polling/dialog key bindings.
# Revamp the MOTD
## Update client MOTD code to send the client version and other system information (operating system and similar) to the server. The MOTD server would then use this information to send appropriate MOTD entries.
## Have the MOTD code detect when there is a new MOTD and pop up a modal dialog. Include a MOTD menu item for later access.
# Font system and language support
## New font system (FTGL or similar)
## Add the additional fonts and better translations from 2.99.x.
## Send the client locale to the server so that the server could localize messages sent to the client
# Map features
## Text object (from 2.99.x)
## BZDB controlled attributes
## Mesh bases/teleporters
## Better define/group support
### Links (with relative and absolute names)
### World weapons and entry zones (with transforms)
### Physics drivers (with transforms and copying)
### Texture matrices, dynamic colors, transforms, materials
# Server Side Players
## Server-side shot path tracking
## Shared client logic library used in both the client and server.
## Ability to spawn and control SSPs from a plugin.
# Other
## Add a per-player name/value pair system. This would be used for data like:
##* Motto
##* Locale
## Implement MsgAllow from 2.99.x (or should this be part of the per-player name/value pair system?)
## [[DevelopmentPlans/ShotIDCleanup|Shot ID cleanup]]
## Make client aware of shot limit so it can display count and can know when the flag is going to drop
## Allow switching teams without rejoining
## Rework the joining process
### Handle all ban checks (including DNS resolution and hostban checks) before allowing the player to pull the world or enter.
### Move team selection to after the join (start off in observer, and have a dialog)
## List server indication of game options that are per object or zone ( rico, jump, etc..)
## Generic server-controlled marker and hunt system.
## Use BZID for all saved user identifiers not names.

Development RoadMap

2013-04-28T14:50:30Z

Blast:

==Overview==
This document discusses the general development road-map for Future BZFlag Releases.

===Features===
Individual features may move up or down the roadmap depending on how/when they get done. Entire releases may be pushed up the roadmap or merged depending on how development goes.

==Current Development Target==
The current development target (trunk) is the [[DevelopmentPlans/2.4.2|2.4.2]] release

==2.4==
'''Goals:''' Get a release out

2.4 will be the next release of BZFlag and is protocol incompatible with all previous versions.
===2.4.0 (Wake the dead)===
Released on 2011/07/03 [[BZFlag 2.4.0]]

===2.4.2===
[[BZFlag_2.4.2]] Release page.

[[DevelopmentPlans/2.4.2|Planning page for 2.4.2]]

2.4.2 was the first maintenance release of the 2.4.x compatibility line. It does contain some bug fixes but it's primary function is to provide an updated package for the debian system. It does include non breaking items that were not ready during the initial release including:

* Fastmap

===2.4.4===
[[DevelopmentPlans/2.4.4|Planning page for 2.4.4]]

2.4.4 will be a bug fix maintenance release of the 2.4.x compatibility line. Its primary function is to fix bugs found in the 2.4.0/2 releases and to include non breaking items that were not ready during the initial release including:

* Ensure bzadmin on Windows gets built with PDCurses
* All the horrible things we missed
* BZFScron
* Push Stats
* Joystick fixes
* CIDR/subnet bans from Filter.cxx

===2.4.6===
* New Death effects
* HTTP Management plugins
* Bug fixes
* New Font System
* New Server List
* New Translations
* Download Authorization Dialog
* GM lock-on markers on the radar.
* Fix mac .app build system (make it just use a script not xcode?)
* Sever side IP/Host/callsign (not perm base) mute
* Evaluate rabbit logic.
* how to deal with third party libs in plugins, specialy ones we build optionaly.
* command line options that have -set <name> <value> equivalents should be reviewed and possibly eliminated
* bzfs should error out if no users or groups have SPAWN
* Teach Roger not to drive into deadly physics drivers
* Test anti permissions.
* Translation update push.
* Set app icon for as many OSs as possible (SDL does not do this)
* Case insensitive bans.
* Block spamers on rejoin (using BZID?)
* Max chat rate (using filters?) with auto scilence. (maybe a plugin?)
* Windows BZAdmin cleanup ( eval if it works the same as linux)
* Sanity check list server input ( players over limit, etc..)
* Extend player name cycling (like on /kick and /ban) to /poll kick and /poll ban
* When game is over, autoboot everyone after some time, so server cannot be blocked forever by one player just sitting there.

===2.4.x (Maintenance)===
Continuing releases to fix critical bugs. New features should go into 2.6 at this point.

==2.6 (Next Breaking Release)==
[[DevelopmentPlans/2.6.0|Planning page for 2.6.0]]

This release will focus on improving the user experience and the user interface.

* Tutorial Mode
* Easier polling system
* Useful MOTD
* Better localized messages
* Additional mapping features

See the planning page for details about the planned features

==2.8==

'''Goals:''' Continue Development and cleanup gameplay.

This version may be rolled into the 3.0 release if that code base is still usable. If the code is extended from 2.4 it may have these features;
* [[DevelopmentPlans/ShotIDCleanup|Shot ID Cleanup]]
* Shot limits from server with display of remaining shots on HUD (solve GM lock problem).
* Acceleration changes
* Flag Drop "Zone" feature
* XFire ?
* OpenAL/Support, OGG, Hardware mixing and 3d (replace platform audio?)
* Solution for dropped shots (TCP? confirm message? logging?)
* Tank parts? Customization? [[CustomTanks]]
* Team After Join?
* More colors in OFFA?
* Dialogs and prompts?
* Eval ID and ID label markers (MMO style? Always show teammates?)
* Graphics settings cleanup, optimize for GF2 or newer. Make low good for GMA chipsets.
* List server indication of game options that are per object or zone ( rico, jump, etc..)
* Server List showing that games require ID ( cool little icon?)
* Use BZID for all saved user identifiers not names.
* Cleanup MOTD into optimal system ( using db?).
* Grouping for links (with relative and absolute names)
* Grouping for weapons and entry zones (with transforms)
* Grouping for physics drivers (with transforms and copying)
* Grouping for texture matrices, dynamic color, xforms, and materials
* Extern cleanup
* Vector class use instead of float[3]
* Incorporate the player's handicap value and physic drivers into the check calculations.
* Decide what a GM is and how it should behave when guided when the user has or does not have the flag, and how the lock should work with ST and CL
* evaluate -noSelfKills server option at [https://sourceforge.net/tracker/?func=detail&aid=3537226&group_id=3248&atid=353248 tracker]
* evaluate -w server option wings instead of jumping [https://sourceforge.net/tracker/?func=detail&aid=3599568&group_id=3248&atid=353248 tracker]

==3.0 (Next Major)==
'''Goals:''' Get back to where V3 wanted to be.

Using the 2.99 continuing branch, or the 2.6 branch with a lot of back-ports depending on code-base stability.

* Lua (Client side)
* Have BZFS convert all world objects into mesh representations for consistent client collisions.
* Point in Polyhedron tests to remove inside/outside points.
* New Simulation
* Shot Type/Flag Type split
* Things added in previous versions that were not back-ported from the codebase this release uses.
* Lobby
* Support additional map objects inside definitions ([https://sourceforge.net/tracker/?func=detail&aid=2938335&group_id=3248&atid=103248 SF Bug 2938335])

===3.0.2===
'''Goals:''' End user experience

Compatible release ( if possible ) that makes the game easier for new users to play and for servers to manage players.
* UI Cleanup
* New Group and User Management.
* In game registration
* Tutorials
* Option to kick to observer.
* Make the texture manager give out IDs and have everyone use the ID, not the image pointer, as it can change. Or make the image pointer self updating.
* Binding keys to multiple actions (lua macros?)

==3.2==
'''Goals:''' Modernization

Goals for this release are to bring the game's networking and simulation system up to par with modern games.
* Lag compensation
* Threaded Networking
* Threaded Simulation
* UI customization
* General Resource Updates and Downloads (sounds, scripts etc..)?
* HTF as real mode
* IPV 6

==3.4==
'''Goals:''' Server State

* Server Side Radar
* Server Side Shots (Iterative octree cell shot collision detection)
* Server Side Deaths
* Server Side Bot API and good bot samples
* Removal of Client Side Logic
* Generic Simulation serialization for recordings that are independent of network format.
* Third party networking?

==4.0==
'''Goals:''' Graphics Upgrades

* Third party graphics engine? Ogre? Irrlicht? lightfeather?
* Patching?
* Shader/Material Support?
* OpenGL 2+?
* Better Lighting, light objects in maps ( shaders or projected textures?)
* A library of "smart server side bots"

==5.0==
'''Goals:''' Extensibility

* Server defined game logic and settings
* Game mode plug-ins/scripts on the server
* Server defined graphics elements ( shots, models, etc)
* List server separation by game mode
* Require Registration and limit server choices until verified?
* Social Components for players ( player ratings, facebooklike stuff?)
* League Integration

[[Category:Development_Plans]]

DevelopmentPlans/2.6.0

2013-04-28T14:47:11Z

Blast: /* Overview */

==Overview==

2.6.0 will be a new breaking release that is not compatible with the 2.4.x line. A strong focus of this release should be improving the user experience and improving the flexibility of the user interface.

==Goals==

* Tutorial Mode (1.1.1, 1.1.2, 4.1, 4.2, 4.3, 5.1, 5.2, 5.3, 6.1, 6.2, 6.3, 7.1, 7.2)
* Easier polling system (1.1.2, 2.1, 2.2)
* Useful MOTD (1.1.1, 3.1, 3.2)
* Better localized messages (4.1, 4.2, 4.3, 5.1, 7.1)
* Additional mapping features (5.1, 5.2, 5.3)

==Features==

# Add new UI elements
## Dialogs
### Modal dialogs are featured front and center, and require being dismissed by the user. They support hotkeys, server-specified buttons, or freeform menu items. Keyboard, mouse (including clicking items), and joystick interaction is supported.
### Unobtrusive dialogs show up as smaller semi-transparent boxes towards the edge of the screen and support only hotkeys (keyboard, mouse button, joystick button) for interaction.
# Revamp the poll system
## Add an actual message type to the protocol for the poll system (MsgPoll and MsgVote, perhaps, or just build it with generic dialog message types)
## Add an unobtrusive dialog for polls with support for both the old style /vote command and polling/dialog key bindings.
# Revamp the MOTD
## Update client MOTD code to send the client version and other system information (operating system and similar) to the server. The MOTD server would then use this information to send appropriate MOTD entries.
## Have the MOTD code detect when there is a new MOTD and pop up a modal dialog. Include a MOTD menu item for later access.
# Font system and language support
## New font system (FTGL or similar)
## Add the additional fonts and better translations from 2.99.x.
## Send the client locale to the server so that the server could localize messages sent to the client
# Map features
## Text object (from 2.99.x)
## BZDB controlled attributes
## Mesh bases/teleporters
# Server Side Players
## Server-side shot path tracking
## Shared client logic library used in both the client and server.
## Ability to spawn and control SSPs from a plugin.
# Other
## Add a per-player name/value pair system. This would be used for data like:
##* Motto
##* Locale
## Implement MsgAllow from 2.99.x (or should this be part of the per-player name/value pair system?)

DevelopmentPlans/2.6.0

2013-04-28T14:27:00Z

Blast: Created page with "==Overview== 2.6.0 will be a new major release that is not compatible with the 2.4.x line. A strong focus of this release should be improving the user experience and improving t..."

==Overview==

2.6.0 will be a new major release that is not compatible with the 2.4.x line. A strong focus of this release should be improving the user experience and improving the flexibility of the user interface.

==Goals==

* Tutorial Mode (1.1.1, 1.1.2, 4.1, 4.2, 4.3, 5.1, 5.2, 5.3, 6.1, 6.2, 6.3, 7.1, 7.2)
* Easier polling system (1.1.2, 2.1, 2.2)
* Useful MOTD (1.1.1, 3.1, 3.2)
* Better localized messages (4.1, 4.2, 4.3, 5.1, 7.1)
* Additional mapping features (5.1, 5.2, 5.3)

==Features==

# Add new UI elements
## Dialogs
### Modal dialogs are featured front and center, and require being dismissed by the user. They support hotkeys, server-specified buttons, or freeform menu items. Keyboard, mouse (including clicking items), and joystick interaction is supported.
### Unobtrusive dialogs show up as smaller semi-transparent boxes towards the edge of the screen and support only hotkeys (keyboard, mouse button, joystick button) for interaction.
# Revamp the poll system
## Add an actual message type to the protocol for the poll system (MsgPoll and MsgVote, perhaps, or just build it with generic dialog message types)
## Add an unobtrusive dialog for polls with support for both the old style /vote command and polling/dialog key bindings.
# Revamp the MOTD
## Update client MOTD code to send the client version and other system information (operating system and similar) to the server. The MOTD server would then use this information to send appropriate MOTD entries.
## Have the MOTD code detect when there is a new MOTD and pop up a modal dialog. Include a MOTD menu item for later access.
# Font system and language support
## New font system (FTGL or similar)
## Add the additional fonts and better translations from 2.99.x.
## Send the client locale to the server so that the server could localize messages sent to the client
# Map features
## Text object (from 2.99.x)
## BZDB controlled attributes
## Mesh bases/teleporters
# Server Side Players
## Server-side shot path tracking
## Shared client logic library used in both the client and server.
## Ability to spawn and control SSPs from a plugin.
# Other
## Add a per-player name/value pair system. This would be used for data like:
##* Motto
##* Locale
## Implement MsgAllow from 2.99.x (or should this be part of the per-player name/value pair system?)

Master-ChildAccountSystem

2013-02-10T03:57:03Z

Blast: /* Database Design */

{{DesignDocument}}

==Overview==
The main goal of the Master/Child account system is twofold;
# To limit or remove the liability of project services under the COPPA laws [http://en.wikipedia.org/wiki/Children%27s_Online_Privacy_Protection_Act]
# To provide additional features for parents to use when managing a child's time online.

==Concept==
In order to support children that current authentication system will be converted into what will be known as "master accounts". These master accounts will only be given out to users who are 13 years of age or older and will store personally identifiable information such as an e-mail address. Users who sign up for an master account must agree to the site terms and be 13 or older. Any user who has a master account and is found to be under the age of 13 will have the account delete and all saved data flushed from the system.

Master accounts will be have the option of creating a fixed number of "child" accounts that are linked to the master account. These child accounts will NOT store any identifying information and will only contain a callsign and a randomly generated password. A parent can then allow his/her children to use these accounts for play. A user who creates a child account will agree to a separate set of site terms that will grant the server the rights to store the call-sign and randomly generated password.

Since a parent is required to create the child account and no personal information for the child is store, this will limit the liability for the project under COPPA.

==Additional Features==
Since the child accounts will be linked to a master account we can add a number of parental control features based on the child account, including

# Listing the servers and log-in times or linked accounts
# Limiting what servers the child accounts are shown in the list server based on parent defined filters
# Preventing child accounts from authenticating on forbidden servers based on parent defined filters.
# Preventing authentication based on parent defined time-frames.
# Allowing the master account to reset the child password to a new random password, or revoking access to the account.

==Other uses==
Players that wish to play under multiple callsigns could also create child accounts to use. This would prevent the large number of account renames that happen and limit the number of times an account gets "stolen" during a name change.

==Implementation==
===General Plan===
The initial implementation can be built upon the current authentication system. Child accounts would be stored in a separate database or table and tied to the BZID of the master account. Child accounts would be given a BZID in a specific range so they would not collide with the normal BZID system (use negative numbers, or a prefix?). A website would be made to allow users who authenticate with Weblogin to create and manage child accounts. The list server would be modified to check the child user list if the callsign was not found in the master password database.

When this is complete the current COPPA group on BZBB would be mass emailed and asked to provide proof that they are over 13 years of age. Those users who provide proof would be removed from the COPPA group and made normal users. The users who were left would all be notified that they now need to have a parent create a child account for them and the current accounts will be deleted. This will let us purge the COPPA group of users who are no longer too young.

When the COPPA group is purged the forum system will be changed to disallow users under 13 from registering new accounts and direct them to the child account system.

===Specifics===
# Child accounts should never be able to set a password, they must always use the password set by the master account. This password will be defaulted to a randomly generated password for enhanced security against weak passwords.
# A separate table would need to store a record that stored the data from every master user that created a child account. This includes the Child account name, date, IP address used, and a flag indicting that the user checked the "I agree" checkbox on the new child account form. This table is the proof that the user is agreeing to let us store the data for the child.
# The current PHPBB system will need to be modified to check the child account list when creating new accounts to know what names are invalid.
# Child accounts should not be allowed to login to webauth and only be allowed to authenticate in game by default. The master account can enable web logins if it desires.
# Child accounts should be added to a special "group" on the list server to identify them as child accounts. This will let servers know if the account is a child and they can set permissions appropriately.
# A method should exist for converting a child account to a master account with the master account's permission. This can be used when a child turns 13 and is capable of maintaining there own account. The master account would be asked to agree to a set of terms that state that the new user is of age.

===Database Design===

[[Image:BZ_Child_Accounts_DB.png]]

===GUI Design===
The GUI should be done in a manner that can be extended into a full user manager.

'''Main log-in page.'''

This page should look as similar as possible to the current weblogin system to show consistency and trust. Eventually the same log-in page should be used for both systems.

[[image:Users_BZFlag_Org_Login_Mockup.png|450px]]

'''Child account page.'''

This page will list the child accounts that the master currently has. Here they can add/remove and edit the child accounts. On creation the user will be asked for the child account name, and a randomly generated password will be show in the password field after the account is created. Normally the password field will be blank and will only be used if/when the user wishes to set the password manually or use the Random button to generate a new random password. The system will NOT store the password, only a hash to it.

[[image:Users_BZFlag_Org_ChildAccounts_Mockup.png|450px]]

File:BZ Child Accounts DB.png

2013-02-10T03:56:45Z

Blast: moved File:BZ Child Accoutns DB.png to File:BZ Child Accounts DB.png: Typo

Overview of the database design for the Master-Child account system.
public domain.

MediaWiki:Currentevents-url

2013-02-02T21:28:53Z

Blast: Created page with "Current events"

Current events

DevelopmentPlans/2.4.4

2013-01-27T19:39:13Z

Blast:

==Overview==
2.4.4 will be the second maintenance release of the 2.4.x compatibility line. It may never happen but, here is what we didn't do in 2.4.2
==Tasks==

===Bug To Be Fixed===

=====Primary=====
* <strike>The bzadmin client in the 2.4.0 and 2.4.2 Windows installer was not built with PDCurses</strike> (Fixed as of r22627)
* timeout does not work with multiple team flags https://sourceforge.net/tracker/?func=detail&aid=3368409&group_id=3248&atid=103248 (Fixed 26/01/12 DTR)
* time limiter and agility https://sourceforge.net/tracker/?func=detail&aid=3368408&group_id=3248&atid=103248
* z buffer issues https://sourceforge.net/tracker/?func=detail&aid=3368245&group_id=3248&atid=103248
* line numbers in drawinfo errors https://sourceforge.net/tracker/?func=detail&aid=2139541&group_id=3248&atid=103248
* stats not tracking https://sourceforge.net/tracker/?func=detail&aid=1433676&group_id=3248&atid=103248
* eval "configure should test and enable the fudged acosf atanf asinf" from old TODO.

=====Secondary=====

===Features===
* BZFScron (implement as backport from 2.99) (BTH)
* Push Stats ( finish backend )
* Joystick fixes (DTR?)
* CIDR/subnet bans from Filter.cxx (Make a common ban check/resolution function/class?)

==Known Bugs==

==Feature Requests to Eval==
* Pause the console https://sourceforge.net/tracker/index.php?func=detail&aid=3464640&group_id=3248&atid=353248

[[Category:Development Plans]]

Development RoadMap

2013-01-27T19:36:22Z

Blast:

==Overview==
This document discusses the general development road-map for Future BZFlag Releases.

===Features===
Individual features may move up or down the roadmap depending on how/when they get done. Entire releases may be pushed up the roadmap or merged depending on how development goes.

==Current Development Target==
The current development target (trunk) is the [[DevelopmentPlans/2.4.2|2.4.2]] release

==2.4==
'''Goals:''' Get a release out

2.4 will be the next release of BZFlag and is protocol incompatible with all previous versions.
===2.4.0 (Wake the dead)===
Released on 2011/07/03 [[BZFlag 2.4.0]]

===2.4.2===
[[BZFlag_2.4.2]] Release page.

[[DevelopmentPlans/2.4.2|Planning page for 2.4.2]]

2.4.2 was the first maintenance release of the 2.4.x compatibility line. It does contain some bug fixes but it's primary function is to provide an updated package for the debian system. It does include non breaking items that were not ready during the initial release including:

* Fastmap

===2.4.4===
[[DevelopmentPlans/2.4.4|Planning page for 2.4.4]]

2.4.4 will be a bug fix maintenance release of the 2.4.x compatibility line. Its primary function is to fix bugs found in the 2.4.0/2 releases and to include non breaking items that were not ready during the initial release including:

* Ensure bzadmin on Windows gets built with PDCurses
* All the horrible things we missed
* BZFScron
* Push Stats
* Joystick fixes
* CIDR/subnet bans from Filter.cxx

===2.4.6===
* New Death effects
* HTTP Management plugins
* Bug fixes
* New Font System
* New Server List
* New Translations
* Download Authorization Dialog
* GM lock-on markers on the radar.
* Fix mac .app build system (make it just use a script not xcode?)
* Sever side IP/Host/callsign (not perm base) mute
* Graphic tank on radar at high zoom
* Evaluate rabbit logic.
* how to deal with third party libs in plugins, specialy ones we build optionaly.
* command line options that have -set <name> <value> equivalents should be reviewed and possibly eliminated
* bzfs should error out if no users or groups have SPAWN
* Teach Roger not to drive into deadly physics drivers
* Test anti permissions.
* Translation update push.
* Set app icon for as many OSs as possible (SDL does not do this)
* Case insensitive bans.
* Block spamers on rejoin (using BZID?)
* Max chat rate (using filters?) with auto scilence. (maybe a plugin?)
* Windows BZAdmin cleanup ( eval if it works the same as linux)
* Sanity check list server input ( players over limit, etc..)
* Extend player name cycling (like on /kick and /ban) to /poll kick and /poll ban
* When game is over, autoboot everyone after some time, so server cannot be blocked forever by one player just sitting there.

===2.4.x (Maintenance)===
Continuing releases to fix critical bugs. New features should go into 2.6 at this point.

==2.6 (Next Breaking Release)==
'''Goals:''' Continue Development and cleanup gameplay.

This version may be rolled into the 3.0 release if that code base is still usable. If the code is extended from 2.4 it may have these features;
* [[DevelopmentPlans/ShotIDCleanup|Shot ID Cleanup]]
* Shot limits from server with display of remaining shots on HUD (solve GM lock problem).
* Lua (Client side)
* Acceleration changes
* Flag Drop "Zone" feature
* XFire ?
* OpenAL/Support, OGG, Hardware mixing and 3d (replace platform audio?)
* Solution for dropped shots (TCP? confirm message? logging?)
* Tank parts? Customization? [[CustomTanks]]
* Team After Join?
* More colors in OFFA?
* Dialogs and prompts?
* Eval ID and ID label markers (MMO style? Always show teammates?)
* Graphics settings cleanup, optimize for GF2 or newer. Make low good for GMA chipsets.
* List server indication of game options that are per object or zone ( rico, jump, etc..)
* Server List showing that games require ID ( cool little icon?)
* Use BZID for all saved user identifiers not names.
* Cleanup MOTD into optimal system ( using db?).
* Grouping for links (with relative and absolute names)
* Grouping for weapons and entry zones (with transforms)
* Grouping for physics drivers (with transforms and copying)
* Grouping for texture matrices, dynamic color, xforms, and materials
* Extern cleanup
* Vector class use instead of float[3]
* Incorporate the player's handicap value and physic drivers into the check calculations.
* Decide what a GM is and how it should behave when guided when the user has or does not have the flag, and how the lock should work with ST and CL
* evaluate -noSelfKills server option at [https://sourceforge.net/tracker/?func=detail&aid=3537226&group_id=3248&atid=353248 tracker]
* evaluate -w server option wings instead of jumping [https://sourceforge.net/tracker/?func=detail&aid=3599568&group_id=3248&atid=353248 tracker]

==3.0 (Next Major)==
'''Goals:''' Get back to where V3 wanted to be.

Using the 2.99 continuing branch, or the 2.6 branch with a lot of back-ports depending on code-base stability.

* Have BZFS convert all world objects into mesh representations for consistent client collisions.
* Point in Polyhedron tests to remove inside/outside points.
* New Simulation
* Shot Type/Flag Type split
* Things added in previous versions that were not back-ported from the codebase this release uses.
* Lobby
* Support additional map objects inside definitions ([https://sourceforge.net/tracker/?func=detail&aid=2938335&group_id=3248&atid=103248 SF Bug 2938335])

===3.0.2===
'''Goals:''' End user experience

Compatible release ( if possible ) that makes the game easier for new users to play and for servers to manage players.
* UI Cleanup
* New Group and User Management.
* In game registration
* Tutorials
* Option to kick to observer.
* Make the texture manager give out IDs and have everyone use the ID, not the image pointer, as it can change. Or make the image pointer self updating.
* Binding keys to multiple actions (lua macros?)

==3.2==
'''Goals:''' Modernization

Goals for this release are to bring the game's networking and simulation system up to par with modern games.
* Lag compensation
* Threaded Networking
* Threaded Simulation
* UI customization
* General Resource Updates and Downloads (sounds, scripts etc..)?
* HTF as real mode
* IPV 6

==3.4==
'''Goals:''' Server State

* Server Side Radar
* Server Side Shots (Iterative octree cell shot collision detection)
* Server Side Deaths
* Server Side Bot API and good bot samples
* Removal of Client Side Logic
* Generic Simulation serialization for recordings that are independent of network format.
* Third party networking?

==4.0==
'''Goals:''' Graphics Upgrades

* Third party graphics engine? Ogre? Irrlicht? lightfeather?
* Patching?
* Shader/Material Support?
* OpenGL 2+?
* Better Lighting, light objects in maps ( shaders or projected textures?)
* A library of "smart server side bots"

==5.0==
'''Goals:''' Extensibility

* Server defined game logic and settings
* Game mode plug-ins/scripts on the server
* Server defined graphics elements ( shots, models, etc)
* List server separation by game mode
* Require Registration and limit server choices until verified?
* Social Components for players ( player ratings, facebooklike stuff?)
* League Integration

Web Services: Player Portal

2013-01-23T22:34:34Z

Blast:

{{DesignDocument}}

==Overview==

The Player Portal will consist of user management, group management, and server key management. It will also contain the weblogin page. It may or may not be secured via SSL.

==Design Overview==

* Player portal
** User management
*** Registration
*** User profile
*** Enable various other services (forum, wiki, API)
** Weblogin System
** Group management
*** Create/modify/remove groups
*** View where groups are being used (?)
*** View group membership
** Server key management

==Detailed Objective==

This section will detail the expected final product in the ideal implementation. This may, of course, need to change in the future to accommodate limitations.

===User Management===

From this area, new users will be able to register global accounts for use in the game and with the various web services. The registration will require a unique email address, a password, and the first game callsign. Additionally, it needs to handle COPPA for users under the age of 13. Registration will be protected via at least one anti-spam system, such as KeyCAPTCHA, a question, and DNSBLs.

It will be possible to update the user's email, password, and callsigns using the user portal. Some operations, such as changing the email address, will require that the user confirm the request before it will be applied. In the case of changing the email, this will make it less likely that a user will change their email incorrectly and lose access to their account.

It will also be possible to enable other services and have them be tied to this global account. For instance, the user could enable a forum or wiki account. Once an additional service is enabled, it would not be possible to disable. If the user profile is updated, any associated data in the enabled web services will be updated as well.

This area will also contain the weblogin system. Currently we allow users to enable automatic logins for a specific host. However, we do not provide a way to remove this automatic login. Users currently have to manually delete the cookie that we create. In this player portal, the user should be able to control automatic logins and remove them if they wish.

===Group Management===

Groups are used primarily for assigning user rights to specific users in-game. They are also used by various web services when checking a token generated from weblogin.

Group names consist of two parts. The format is ORGANIZATION.GROUP with the period separating the two parts. There will be two or three reserved organizations. The DEVELOPERS organization is reserved for official BZFlag developers. The LOCAL organization is reserved for local groups on individual servers. This organization cannot be managed through the web interface. The last one that may be reserved is the BZFLAG organization. However, there is already several groups that are using that namespace, so that would have to be worked out with the owner of those groups.

The organization will be registered first and will then be reserved for use by that user. The user that registers a organization will be the '''founder''' of that organization. They can add additional '''co-founders''' or even transfer the founder right to another user.

Once an organization is registered, groups can be created within the organization. These will be created by the founder or co-founders. Once created, each group can be assigned one or more '''managers''' that will be able to add or remove users from the groups.

There will be various options for each group which the founders can modify. The founders can rename the group, add a description, and delete a group. There will also be a visibility setting and a setting to control how users can join the group.

For the visibility setting, there will be two options: public, protected, and private. If the group is public, anyone can see the group and the member list. If the group is protected, anyone can see the group, but only members can see the member list. If the group is private, only members can see the group and the member list.

There will also be settings to control how users can be added to or removed from the group. For this, there will be three modes: open, request, and closed. If the group is set to open, users can join or leave the group without any interaction from the organization founders or the group managers. The request mode requires users to request to be added to a group, but they can leave or cancel their request at any time. The founders or managers can approve or deny the user's request. The last mode is closed, which allows only the founders or managers to add or remove users from the group.

This may differ slightly from the original plan for the [[Group Management System]].

===Server Key Management===

Starting with BZFlag 3.0.0 (technically, with 2.99.x) and 2.4.x, a list server key is required to host a server on the official server list. Typically, the owner of the server will generate this key. Keys are tied to a hostname or an IP address. The website will provide management for these keys. A registered user can create new keys and delete existing keys.

There is more information on the [[ServerAuthentication]] wiki page.

==Planned Milestones==

In order to complete this section of the web services, a number of things need to happen. It is infeasible to complete them all at once, so a gradual process is expected. These milestones will be fleshed out a bit more later.

===Milestone 1 - Planning and Design===

Goals:
* Determine the data that will be stored
* Describe any specific restrictions or limitations that should be in place
* Create a complete set of database schema for all areas of the portal
* Determine the kind of queries that will be run and plan indexes and other optimizations as needed.

It should be determined what data needs to be stored, how it references other data, and what kind of data is necessary to integrate with systems such as MediaWiki and phpBB3. There should be some planning for the future to reduce the likelihood/necessity of major database structure changes later. For instance, we should ensure that IPv4 and IPv6 addresses can be stored in any area that tracks IP addresses. PostgreSQL supports storing network addresses, so that may be something to look into. We should also have any restrictions (such as limiting the characters and length of callsigns) clearly defined. This will enable us to create a consistent experience across all web services and in the game itself.

The schema we generate should be database agnostic as it is not yet known what data will be stored in what database. It may be MySQL, OpenLDAP, a mix of the two, or some other database that we have not tried yet (such as PostgreSQL).

We should also determine the types of queries that will be run in order to determine ways to optimize performance. For instance, we will be looking up a specific user by callsign quite often. So it would make sense to have an index on the callsign.

Of course, it's not possible to think of everything right away, so it's inevitable that we will have to make some changes later.

===Milestone 2 - Weblogin and Server Authentication===

Goals:
* Migrate the server authentication key system
* Migrate the weblogin system

The easiest thing to migrate over is the server key management system and weblogin. These items are not tied in to many other areas like groups and registration are.

The server key management code is currently in SVN under [http://bzflag.svn.sourceforge.net/viewvc/bzflag/trunk/web/listkeymgr/ /trunk/web/listkeymgr]. Parts of this code could be adapted or used with the player portal. This will still need to integrate with the existing list server (or vice versa) until the list server is heavily updated or rewritten.

The weblogin system will just be the current weblogin.php script. This may retain the same visual look or we may integrate the look into the rest of the website. A long term goal is to have all our web services have the same visual look.

===Milestone 3 - Group Management===

Goals:
* Create the group management system
* Migrate the organizations/groups from the forum into the new group management system

...

===Milestone 4 - Registration===

Goals:
* Create the registration system
* Allow users to modify their profile from the player portal
* Enable activation of a forum account

...

===Milestone 5 - ...===

...

Talk:BZWTools

2012-07-23T11:03:59Z

Blast:

It seems the BZWTools website is dead. Perhaps that should be noted in the page, instead of leaving it contradicting itself as it is now. The dead links should likely be removed or updated. [[User:Ratfink|Ratfink]] 21:55, 2 June 2010 (EDT)

Is this tool still being maintained? I've been mucking around with my own plugin out of impatience since the listed site seems to be dead. So far I have it exporting mesh objects with full color materials (but not textures yet), handling single or double-sided faces (repeats each face inside-out if mesh is double-sided in Blender), adding child Empty objects as inside points, and creating a group for each mesh datablock before making use of it with an "object" group with shift, spin, and scale (for the same kind of re-use of mesh data as Blender uses). The next step would be to create custom objects that export as box, arc, pyramid, etc. and display in Blender using appropriate geometry. Is it worth continuing? How does this compare to the functionality of BZWTools? --[[User:Prestidigitator|Prestidigitator]] 07:15, 23 July 2012 (UTC)

From what I understand, this tool hasn't been updated in quite some time. While it might be interesting to create a replacement, there is also a program called BZWorkBench that's goal was to be the official map editor for BZFlag. It is located in our SVN repository under /trunk/bzworkbench/ and is written in C/C++. In the long term, it might be better to work on that tool instead.
--[[User:Blast|blast007]] 11:03, 23 July 2012 (UTC)

Creating a server

2012-07-23T01:21:37Z

Blast: /* Getting your server on the public list */

Creating a server is the process of using [[BZFS]] software to host a game for users to play on.

==Overview==
Running a server can be done in both [[public]] or [[private]] modes. It involves running the server software [[BZFS]] on some host computer. For [[public]] servers this host computer must be connected to the internet, and be able to accept incoming connections on a fixed port.

== Planning a Server ==

Before you create a server, you need to decide what you want your server will be like. There are a few requirements in creating a server. First, you need a good connection. If you are on a high end DSL or higher connection you will be able to host a few players. With really fast connections, such as T1 or related, you could host dozens (although you may not want to do so).

You must provide an address to connect to. You will specify this address when you run the server (more on this below). The address may be your IP address (something like 192.12.193.123), or the domain name pointing to your computer (e.g. BZFlag.ducati.org). If your server is going to be on a machine that is connected via DSL or Cable, figure out if your provider is giving you a dynamic or a static IP. If the IP address is static, your life will be a little easier since you can specify that address once and forever. If the IP is dynamic, this means that your internet provider will change the address once in a while (without warning). In this case you probably want to "[[Alias Your IP Address]]" to a static name (click on the link for how to).

Next you need to have an idea of how your server is going to look: you are probably already familiar with the game style (CTF, Rabbit) from playing on existing servers. You may specify a map or ask your server to create a random one. You will also be able to specify many details of the game play (how many good and bad flags, jumping, ricochet, etc...). All of this is accomplished in the next step.

== Configure your Server ==

In this step, you specify all the server options. The cleanest way to accomplish this is to create a configuration file. Fortunately, the BZFlag installation provides you with a sample configuration file that you can modify according to your wishes. You will find this file in the directory where you installed BZFlag under a subdirectory called <code>misc</code>. The file is named <code>bzfs.conf</code>. Open <code>bzfs.conf</code> in a text editor (in windows, notepad will be just fine; in GNU/Linux, Unix, Debian, etc.. : vi would work nice).

Read through <code>bzfs.conf</code> to understand all the options. Remove the # sign on the lines corresponding to the options you want to set. Add # at the beginning of the line if you don't want that option. After you have finished your changes, you can save that file with a different name (this will be helpful if you want to run server with different configurations: just save many files with different names).

Note also that recent BZFlag installations come with a "nice" web-based configuration builder that lets you create a configuration using a simple web form. Run it by selecting "BZFS configuration builder" from the BZFlag folder in the start menu. Your web browser will pop up with a web form that will prompt you for several configuration choices. Please note that the form will not save the configuration file for you: you will still have to copy and paste the text generated by the web form into your configuration file.

Here is an incomplete list of things you must or can specify in the configuration file.

* Choose a password for administrative purposes. With this password, you can use the administrative operations, such as changing the lag kick threshold or setting environment variables. This is done by adding the following line to your configuration : <code>-passwd PASS</code> (replacing PASS with a password of your choice). Once the server is running, run your client and login as an administrator by entering "<code>/password PASS</code>" (without quotes "") as a chat message.
* If the server is to be public, you must specify the server people should connect to. The option is added with the following line "<code>-publicaddr server.name.com:5154</code>" (without quotes), or "<code>-publicaddr 111.111.111.111:5154</code>" where you should replace <code>111.111.111.111:5154</code> with your IP address. <code>5154</code> is the port the server will listen to. Make sure it is the same number as the one specified in a line starting with <code>-p 5154</code>. You can change the port but don't do that if you don't know what you are doing. We recommend you use port numbers that are proven to work in other servers.
* Specify other options. For example, if you want to allow jumping, then your conf file should have a line starting with <code>-j</code>. Other options are: ricochet, which needs a line starting with <code>+r</code>. Read through <code>bzfs.conf</code> and you'll find out how to specify the game style (rabbit, ctf, etc...), the number of flags, etc.... If you want to run different configurations you can create as many conf files as you like (with different names of course). Just specify the correct configuration file you want to invoke in the bat file mentioned in the previous paragraph. One of the options that you can set in the configuration file is a map the server should use.
* You can choose whether to use a custom map or a random one. If you use a random one, decide whether or not to include teleporters. If you want to include them, add (again, to your configuration) the option "<code>-t</code>". If you are playing CTF and you want a random map, use "<code>-cr</code>" instead of standard "<code>-c</code>", in addition to "<code>-t</code>". For a custom server, use: <code>-world "MAP_NAME"</code> ; replacing <code>MAP_NAME</code> with the file name of the map, which must be in the BZFS directory. You have probably seen that when you visit other server, one of the menus has the "save map" option. That means you can save that map for use on your server. Just save it somewhere in your pc, and specify the location of the map in the configuration file, next to the line that starts with <code>-world</code>
* You can choose the max number of players (for example <code>-mp 10</code> says there can't be more than 10 players). But just because you can host many, decide if you really want to. The more players on your server, the higher the overall latency will be and the more bandwidth your server will consume. Moreover, more than 4 players per team on a ctf or more than 6 players on a rabbit style is just not fun. Experiment if you plan to host a lot, otherwise don't worry. Not only latency that matters, but many players will make the field busy. Tanks will get killed often and there would be a lot of action. This is good, and bad. Good in that it is a lot of fun! But bad in that the average alive time may only be a few seconds.
* A server description would be nice. Note that there is a small limit on how many characters you can put for description, and it gets smaller based on how long the server address is. Add a description by adding option: <code>-public DESCRIPTION</code>
* You can choose what flags, if any, to include or restrict. You must be familiar with the flag abbreviations, which are listed using command "<code>bzfs -help</code>" near the end of the help message. Add flags to the server using "<code>+f ABBR</code>" and restrict flags using "<code>-f ABBR</code>" replacing <code>ABBR</code> with the flag abbreviation.

This should get you started, but there are many more options you can set. Some of them are explained below in the section "Good Administration". In any event, most of the options can be understood by reading the file bzfs.conf provided with the installation.

== Getting your server on the public list ==

BZFlag has a central list server that keeps track of all the public servers. Using the <code>-public "some text"</code> command line argument will tell your local server to attempt to register itself on the public server. This is normally all that is required to get your server listed.

The list server will need to be able to access your server just as other players will. This is done by connecting back to the public IP address where your server is running. The list server only checks the tcp connection back to your server at present, though players will also try udp on the same IP address and port number.

You can view the raw [http://my.bzflag.org/db/?action=LIST server list] in your web browser. If you do not see your server, then your server is firewalled or misconfigured and the list server cannot contact it. You will need to resolve this if you want your server to be publicly accessible.

Note: when you run the bzflag client on the same network as a server it should discover the server by using a broadcast ping. If your server shows up in the list, but without the description next to it, this means that you found it through broadcast discovery, and '''not from the public list server'''. If the server description that you included on the <code>-public "this text"</code> command line option is there, then your server is correctly listed on the public server list.

Using multiple <code>-d</code> options to the server will result in some useful (and some useless) messages from the server.
{|
|
bzflag@phoenix:~/bzflag-1.10$ src/bzfs/bzfs -d -d -d -i 24.1.104.25 -p 51540 -public "My Server Name"
style: 0
There is a voting arbiter with the following settings:
vote time is 60 seconds
veto time is 10 seconds
votes required are 3
vote percentage necessary is 50.099998
vote repeat time is 300 seconds
available voters is initially set to 200
Running a public server with the following settings:
public address is 24.1.104.25:51540
listening on 24.1.104.25:51540
with title of "My Server Name"
Sent ADD message to list server
GET /db/?action=ADD&nameport=24.1.104.25:51540&version=BZFS1910&gameinfo=0000000100000000000000000000c800c800c800c800c800c800c8&
build=1.10.7.20040809-RELEASE-linux-gnu&title=My+Server+Name HTTP/1.1
Host: my.BZFlag.org
Cache-Control: no-cache

Player [0] accept() from 24.1.104.25:50579 on 6
Player [0] on 6 removed: Disconnected
|}
* the -i parameter is used here to force an IP address. This server happens to have more than one IP address. This is not required on most servers.
* the -p parameter is used to pick a different port number than the default. If you are only running one server, it is recommended that you leave this off and use the default port number.
* notice the debug line that starts with "<code>GET</code>". This is the request that was sent to the bzflag list server to attempt to get listed
* notice the "<code>Player [0]</code>" lines. This indicates that the list server connected back and then disconnected. If you don't see this then it is likely that your server is firewalled and the list server is unable to connect back and so will '''not''' list your server.

== Running the server ==

There are different ways to run a server. On both Windows and *nix, the program (BZFS) is in the directory where you installed BZFlag (most likely: "<code>C:/Program Files/BZFlag2.0.0</code>", or on your usr account). The program containing the server is BZFS.exe. Double clicking on it will run a server with default options, but clearly you want to specify your own options, for example those you saved in the configuration file generated in the previous step. One way to do it is to specify all the commands for the server in a batch file, so you can just double click on it to start a server. On other systems such as Linux, create an executable with the commands, or a shell script, or see if there are any related ways to store console/text based command interface commands in a "shortcut" style.

On Windows: Here is a [SampleBatchFile]. Open notepad or any other text editor, copy the content of the file, make the changes that you need to change (notably: the location of BZFS and the config file bzfs.conf). Save the file with a nice name and extension .bat (for example: nicename.bat) on your desktop or a window of your choice. You probably understand what the batch file is doing: the lines beginning with "set" specify the content of some variables, such as the location of BZFS and the configuration files. The server is started on the line next to last (before "pause").

If you don't want to have a batch file or for some reason your batch file doesn't work, here is a procedure that always works: from the start menu in your windows machine, look for the "command prompt" and click on it. A black window will open up. Type: <code>cd "c:\Program Files\BZFlag2.0.0"</code> (this should work in most cases, unless you installed BZFlag in a different directory). Once you are there type: <code>bzfs -conf "C:\Program Files\BZFlag2.0.0\Data\bzfs.conf"</code> (change what is between quotes with the exact location of the configuration file).

On *nix: Use a config file, or a shell script. A config file can be made simply by taking all of your command line options you want to pass to BZFS, and placing them in a config file, one options on each line. An HTML file has been created that is shipped with BZFlag (in /data/ on binary releases, and in /misc/ in source releases or CVS). A shell script can be made the same way. A config file can be used, by changing directory to BZFS, and do "bzfs -conf CONF.conf", replacing CONF.conf with the config file in the same BZFS directory.

Once the server is running, log into it with your client and type /password PASS, where PASS is the password you chose in the configuration step. You'll be greeted by the client as an administrator. The KeysAndCommands and ServerCommands pages list a number of things you can do as an admin (although I don't think either of those pages is complete). If when you type one of those commands you get a "You do not have permission" message on client commands, it means that you forgot to login as admin (or somehow your login failed). Type in your client /password PASS replacing PASS with the password that you specified in the configuration phase. If this doesn't work shut down your server, go back to the configuration step and make sure you are getting the right password.

== Sharing Administration Status ==

Helpful links about this topic:

http://my.bzflag.org/bb/viewtopic.php?t=5960
and
http://my.bzflag.org/bb/viewtopic.php?t=6516

Sometimes people will want to share administrator status. Multiple people can be assigned permissions on a server, and all can do more than the normal DEFAULT group (general public). This allows a server to be better administrated, as when one admin is not watching it, another one can. So how do you do this? This is quite easy to do. First off, configure your server to accept group permissions. This is done through BZFS command "<code>-groupdb FILE</code>". This stores group names and permissions for that group. Its syntax for adding groups is: "GROUPNAME: permissions...", replacing GROUPNAME with the name of the group. Don't worry about adding ADMIN or DEFAULT groups, as those get thrown in automatically. Make one up, but please do not alter ADMIN group, as this is stuff administrators can do, and why limit yourself? Groupnames may not have spaces or quotes. Replace "permissions" with permissions, and take out the backslash in the command. For example, write "lagstats" instead of "/lagstats". So a sample line would be, "JRADMIN: playerlist ban kick". Separate permissions by a space, and DO NOT put permissions on different lines! Make sure the group name and ALL permissions are on the same line!

Now that you have your groups laid out, you must create a pas-swo-rd dat-ab-ase to store nicks and passwords created using "/register", as only registered users may be added to groups. To add people to a group, have them register, and enter BZFlag admin client command "/setgroup CALLSIGN GROUPNAME", replacing CALLSIGN with their callsign, case sensitive (add quotes around it if the callsign has spaces), and GROUPNAME with the name of the group to add them to. And that?s it! Easy as pie! This enables you to have multiple admins on one server. But what if you don't want other admins? Easy, create a smaller admin group, such as JRADMIN, in which they have more privileges than a normal person, but not as many as an admin. One privilege you MUST be very careful in giving a person is /shutdownserver. This is terrible if misused, as it kills the server. Trust wisely. And finally, if your server supports /report, starting in 1.11.*, people with privilege to "/viewreports" can see any reports filed, regardless of whether or not the person with that privilege has the computer that stores the reports.

== Shutting down your server ==

If you have had enough of your server, shut it down by entering /shutdownserver in the client. You can also just terminate BZFS execution, but this is not proper and takes a while for the client server list to realize it was terminated.

Now that the server is running, how does it work? Well, the BZFS window or execution must stay alive to keep the server alive. If you close the BZFS window or halt its execution, the server goes too. It will stay on the server list for a short time if halted suddenly.

Closing the server window, or halting its execution, is somewhat like turning off the power suddenly as a way to shutdown your computer - it is not proper, and is not recommended.

== Good Administration ==

Just because you have a server, that's not all. You must maintain it and keep your players satisfied. Check it often. One way to get feedback is to support the "/report" command.

Enable this using BZFS by setting the configuration option "-reportfile FILENAME" replacing FILENAME with a file to use to write reports to, or "-reportpipe FILENAME" replacing FILENAME with the file to pipe reports to. Reports are made through the client and are simply human messages.

But besides that, you must watch the people that come on your server. Often times people will pause or become "NR", not responding. "Not responding" means that they haven't sent a packet in a while (5 seconds by default). This happens to people with slow connections, or people with messed up connections because their connection simply can't send packets fast enough to be within the threshold. Usually they will be kicked automatically for idling too long, but if not, a kick is suitable. Take action against teamkillers (people who kill their own team on PURPOSE, not by occasional mistake), cheaters (a ban is usually nice :), people who log in/off constantly (people who constantly log on & off to reset their score, a warning is suitable), and any other nasty behavior.

You may want to implement a filter to filter chat or callsigns or both from abusive words. Make a file with a phrase/word that should be filtered on every line, and add it to the server using configuration option "-badwords FILE", replacing FILE with the file name IN QUOTES that is found in the BZFS directory. Then set whether to filter chat, callsigns, or both using "-filterCallsigns" and/or "-filterChat". Sometimes, BZFS will be too strict and filter things that aren't bad. You can make simple exact matches happen using "-filterSimple".

So you have a filter, but what if a bad person comes on? Take reasonable action, a warning to start, a permanent ban at worst. Punishment severity is, in order, a warning (use the chat), a kick (/kick REASON), a temporary ban (/ban IP DURATION REASON), and a permanent ban (/ban IP REASON). IP is delinquent's IP address (found using "/playerlist" admin command), DURATION is the amount of time in minutes (do not put a number alone if to ban forever), and REASON is an optional text string of the reason, which will be sent to the player and recorded in your logs. If you want to just kick a person off the server temporarily, use "/kick REASON", replacing REASON with an optional text string of the reason why. If you want bans to last after you shut down or restart your server, make sure you specified a [[ban file]], which is a file that BZFS can store banned IPs in, using BZFS command-line option "-banfile FILE", where FILE is the name of the file in the BZFS directory.

== World Files ==

World files should have the ".bzw" file extension and be in [[BZW]] format. If world files live in the "<code>worlds</code>" directory under the config directory they will be usable when you start a simple server from inside the client. You should not use this method to run a dedicated server, just for starting a LAN game etc. The "<code>worlds</code>" directory is located:

* "~/.bzf/worlds/" - on Linux and Unix Systems.
* "My Documents\My BZFlag Files\worlds\" - on Microsoft Windows.
* "~/Library/Application Support/BZFlag/worlds" - on Apple Mac OS X.

== Other Information ==

BZFlag has not been carefully audited for buffer overflows and other remote attacks, however, large packets or suspicious packets make the server kick the player that sent it. You should never trust the server to be your guard. It's a good idea to run your BZFlag server as a user with minimal permissions on your machine and to run it in a [[BZFS in a chroot jail|chroot jail]].

== Regarding "cheat" servers ==

While the license for BZFlag allows users to run any server modification that they wish, or to modify the code in any way, the project administration asks that users do not publish or host "cheat" type clients or servers. These cheats ruin the game for the average player, when they are mixed in with the normal game servers and clients. We understand the desire to expand and modify the game and it's sources, so it is requested that anyone wishing to run a game that uses modified code or logic to do so using a different network protocol than the current public release. This will let modified games be played, and prevent modified clients from being used on public unmodified games, as they would be incompatible. The BZFlag project administrators reserve the right to remove the public listings of any game servers that do not adhere to this rule. Administrators also reserve the right to remove any global accounts or access to public services at any time.

==See also==
[[Commands]]<br>
[[Server Variables]] <br>
[[BZFS in a chroot jail]]<br>
[[Known Cheats]]

==External Links==
http://my.bzflag.org/bb/viewtopic.php?t=2915 post on the BZFlag Forums

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

Bz resetTeamScores

2012-06-02T18:54:47Z

Blast:

{{apicall
| name = bz_resetTeamScores
| description = Resets all team scores. (v2.4)
| returntype = void
}}

Bz setTeamLosses

2012-06-02T18:54:07Z

Blast:

{{apicall
| name = bz_setTeamLosses
| description = Sets the losses of a team. (v2.4)
| param1 = team
| param1type = bz_eTeamType
| param1desc = The team to set the losses for.
| param2 = losses
| param2type = int
| param2desc = Amount of losses for the team.
| returntype = void
}}

Bz setTeamWins

2012-06-02T18:53:55Z

Blast:

{{apicall
| name = bz_setTeamWins
| description = Sets the wins of a team. (v2.4)
| param1 = team
| param1type = bz_eTeamType
| param1desc = The team to set the wins for.
| param2 = wins
| param2type = int
| param2desc = Amount of wins for the team.
| returntype = void
}}

Functions (API)

2012-06-02T18:00:12Z

Blast: Undo revision 8297 by 24.255.56.220 (talk)

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future API functions.
}}

{{BZFS_API_Doc}}

== Overview ==

The BZFS API provides a number of functions to plug-ins for use in querying the current game state. Functions are used both to get information about the game, and to trigger in game actions, such as activating a world weapon.

== Function Groups ==
Functions are broken into a series of groups based on the type of action or information they deal with.

=== Event Registration ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team );
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
?
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
2.3+
BZF_API bool [[bz_setPlayerWins]] ( int playerId, int wins );
BZF_API bool [[bz_setPlayerLosses]] ( int playerId, int losses );
BZF_API bool [[bz_setPlayerTKs]] ( int playerId, int tks );
BZF_API bool [[bz_resetPlayerScore]] ( int playerId );
BZF_API int [[bz_getPlayerWins]] ( int playerId );
BZF_API int [[bz_getPlayerLosses]] ( int playerId );
BZF_API int [[bz_getPlayerTKs]] ( int playerId );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

=== Latency Information ===
2.3+
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]] ( const char* group, const char* perm );

=== Chat Messages ===
2.3+
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
?
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] ( int playerID, bz_eTeamType = eNoTeam );
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();
?
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Rabbit Hunt ===
?
BZF_API void [[bz_newRabbit]] ( int player, bool swap );
BZF_API void [[bz_removeRabbit]] ( int player );

=== Map Management ===
2.3+
BZF_API void [[bz_setClientWorldDownloadURL]] ( const char* URL );
BZF_API const [[bz_ApiString]] [[bz_getClientWorldDownloadURL]] ( void );
BZF_API bool [[bz_saveWorldCacheFile]] ( const char* file );

=== Flag Management ===
2.3+
BZF_API bool [[bz_givePlayerFlag]] ( int playerID, const char* flagType, bool force );
BZF_API bool [[bz_removePlayerFlag]] ( int playerID );
BZF_API void [[bz_resetFlags]] ( bool onlyUnused );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3] );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
?
BZF_API bool [[bz_setPlayerShotType]] ( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
2.3+
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt, bz_eTeamType shotTeam = eRogueTeam );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt, bz_eTeamType shotTeam = eRogueTeam );

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]] ( const char* variable );
BZF_API bool [[bz_getBZDBBool]] ( const char* variable );
BZF_API int [[bz_getBZDBInt]] ( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPesistent]] ( const char* variable );
BZF_API bool [[bz_BZDBItemExists]] ( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]] ( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]] ( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]] ( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]] ( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]] ( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]] ( void );

=== Logging ===
2.3+
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]] ( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

=== Server Administration ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

BZF_API int [[bz_getLagWarn]] ( void );
BZF_API bool [[bz_setLagWarn]] ( int lagwarn );
BZF_API bool [[bz_pollActive]] ( void );
BZF_API bool [[bz_pollVeto]] ( void );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
BZF_API bool [[bz_setTimeLimit]] ( float timeLimit );
BZF_API float [[bz_getTimeLimit]] ( void );
BZF_API bool [[bz_isTimeManualStart]] ( void );
BZF_API bool [[bz_isCountDownActive]] ( void );
BZF_API bool [[bz_isCountDownInProgress]] ( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands ===
2.3+
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

=== Plug-in Management ===
2.3+
BZF_API int [[bz_getLoadedPlugins]] ( [[bz_APIStringList]] * list );
BZF_API bool [[bz_loadPlugin]] ( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]] ( const char* path );
BZF_API const char* [[bz_pluginBinPath]] ( void );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
?
BZF_API bool [[bz_stopAllURLJobs]] ( void );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
BZF_API bool [[bz_saveRecBuf]] ( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]] ( void );
BZF_API bool [[bz_stopRecBuf]] ( void );

=== Map Management ===
==== Map Information ====
?
BZF_API void [[bz_getWorldSize]] ( float *size, float *wallHeight );
BZF_API unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== Map Collisions ====
?
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

==== Custom Map Objects ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

=== Utility ===
2.3+
BZF_API const char *[[bz_MD5]] ( const char* str );
BZF_API const char *[[bz_MD5]] ( const void* data, size_t size );
BZF_API const char *[[bz_getServerVersion]] ( void );
BZF_API const char *[[bz_getProtocolVersion]] ( void );

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

== See also ==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]