This wiki is archived and useful information is being migrated to the main website

Map making

From BZFlagWiki
Revision as of 16:38, 8 February 2017 by Zehra (Talk | contribs) (Map Objects: added template)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

Map Creation Methods[edit]

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

Dedicated Map editors[edit]

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

Editors supporting BZW 1.10 features:

Editors supporting some BZW 2.0 features.

Non-dedicated editors[edit]

Technically, you can use any 3D modeling package that can export to .obj format. You can then either use modeltool or Wings3D to convert that file to BZW format.


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

Wings 3D[edit]

Wings 3D is a good modeler to use if you're new modeling. It has a much smaller learning curve than Blender, although it doesn't have as many features. Wings3D allows you to export wings objects to a BZW file. Tutorials on using wings (not specific to BZFlag) can be found on the wings web tutorials pages, as well as a useful tutorial on UV mapping

Getting Maps In .obj Format[edit]

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

Creating BZW files via scripting or programming[edit]

Writing programs to output map files can be a very effective and efficient way of creating maps. One may, for instance, use variables to represent key heights or distances within maps (so that, for example, anyone at a given level may shoot someone at the same level), or to create composites based on collections of basic objects, co-located programmatically. Basic objects may be stretched/scaled to fit specific spaces; they may be programmatically varied in texture, color, and position; software may (internally) represent objects and work with them so that they don't collide or overlap. AI-based software may compose maps based on specific design principles, aiming for particular play styles or tactical challenges.

The core of software map generation is the creation of the basic BZFlag elements, whether the simple boxes, pyramids, etc., or complete meshes, by outputting map element statements to a file. The objects are typically output as sequences of text strings to a .bzw model file, which may then be read by the bzfs server. While simple objects may be fairly easily edited by hand, more complex objects, such as meshes, are more readily generated by software.

Mesh generation, while it may be done with Blender, etc., as above, may be done equally as well by constructing programs to output the faces required within a mesh. For example, a program may take a curve and spin it about an axis to create a 3D surface (a sort of "lathe" in the virtual world), outputting faces at each increment of rotation. Hand-written scripting software may fit irregular polygons together, defining a sequence of mesh objects that seamlessly create, for example a roadway. Writing such software usually requires very careful testing to guarantee that the bzfs server interprets the objects as the author intends.

Software map creation provides the map maker with the ability to customize objects in detail, such as whether the faces of the object allow bullets or tanks to pass, or the level of transparency to assign to any specific face, at a level of detail often hard to achieve within other 3D modeling tools. Abstractions within map generation software are often defined to create basic tactically-relevant map elements - these then may be scaled, shifted, textured, or otherwise modified to fit a particular designer's tastes or constraints.

The disadvantages in using this are that the underlying representation of the work is not available directly from the map file. The underlying intended abstractions are missing because only the resulting object primitives are in the generated map file, and there is no straightforward way to recover this (though software may be used to parse existing map files with the goal of augmenting them). This lack of directly-accessible abstraction is of course true of any tool used to generate a map, there being no standard way to encode this within a .bzw file.

Map making by Hand[edit]

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

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

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

See also[edit]

Map Editors[edit]

BZEdit BZEditWin32 BZFed BZWTools DI-Machine
IBZEdit Modeltool PyBZEdit Wings3D

Map Objects[edit]

Arc Base Box Color(BZW) Cone Define DrawInfo
DynamicColor GroundMaterial Group Include Link Linkmaterial Material
Mesh Meshbox Meshpyr Options (object) Physics Pyramid Sphere
Teleporter Tetra TextureMatrix WaterLevel Weapon (object) World (object) Zone

Helpful links[edit]