BZFlagWiki - User contributions [en]

Category:Map Making

2007-04-07T19:54:15Z

Tadd: /* Creating BZW files via scripting or trivial programming */

[[BZFlag]] uses its own map file format called the [[BZW]] file. [[BZW]] files are text based and contain a list of objects and map options that are read by the [[BZFS]] server.

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

=== Dedicated Map editors ===
Dedicated [[BZFlag]] map editors (i.e. written specifically for graphically editing [[BZW]] files) generally go by the name [[BZEdit]]. There are a number of versions of [[BZEdit]] that have been developed over the years, some of them sharing code, some of them not. 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 map objects such as a [[box]], a [[pyramid]] or a [[teleporter]].

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

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

=== Blender ===
The [http://www.blender.org/ blender] 3d modelling application features a plug-in called [[BZWTools]], which enables blender to read and write the [[BZW]] file format and to create [[BZW]] specific objects. This is the preferred method of creating and editing [[BZW]] 2.0 map files. Tutorials on using blender (not specific to BZFlag) can be found on the [http://www.blender.org/tutorials-help/tutorials/ blender web tutorials] pages.

=== Wings 3D ===
[http://www.wings3d.com/ Wings 3D] is a good modeler to use if you're new modeling. It has a much smaller learning curve than Blender, although it doesn't have as many features. There is also a plugin (which you can download [http://trepan.bzflag.bz/wings3d_to_bzw_1.1.tar.gz here]) created by trepan which allows you to export objects to a [[BZW]] file. It is not widely know 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 [http://www.wings3d.com/ Wings 3D] and edit the map. Then you can use the [http://trepan.bzflag.bz/wings3d_to_bzw_1.1.tar.gz exporter] created by trepan which allows you to export objects to a [[BZW]] file.

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

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

=== Editing by Hand ===
The last method of creating maps is simply coding them by hand as text files using the raw [[BZW]] structures. This is still one of the most common ways that people create and edit maps, and can be very fun and challenging. This is easilly 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.

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

[[Category:Server]]

Category:Map Making

2007-04-07T19:51:25Z

Tadd: add comments about using scripts and C to create maps.

[[BZFlag]] uses its own map file format called the [[BZW]] file. [[BZW]] files are text based and contain a list of objects and map options that are read by the [[BZFS]] server.

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

=== Dedicated Map editors ===
Dedicated [[BZFlag]] map editors (i.e. written specifically for graphically editing [[BZW]] files) generally go by the name [[BZEdit]]. There are a number of versions of [[BZEdit]] that have been developed over the years, some of them sharing code, some of them not. 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 map objects such as a [[box]], a [[pyramid]] or a [[teleporter]].

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

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

=== Blender ===
The [http://www.blender.org/ blender] 3d modelling application features a plug-in called [[BZWTools]], which enables blender to read and write the [[BZW]] file format and to create [[BZW]] specific objects. This is the preferred method of creating and editing [[BZW]] 2.0 map files. Tutorials on using blender (not specific to BZFlag) can be found on the [http://www.blender.org/tutorials-help/tutorials/ blender web tutorials] pages.

=== Wings 3D ===
[http://www.wings3d.com/ Wings 3D] is a good modeler to use if you're new modeling. It has a much smaller learning curve than Blender, although it doesn't have as many features. There is also a plugin (which you can download [http://trepan.bzflag.bz/wings3d_to_bzw_1.1.tar.gz here]) created by trepan which allows you to export objects to a [[BZW]] file. It is not widely know 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 [http://www.wings3d.com/ Wings 3D] and edit the map. Then you can use the [http://trepan.bzflag.bz/wings3d_to_bzw_1.1.tar.gz exporter] created by trepan which allows you to export objects to a [[BZW]] file.

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

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

=== Editing by Hand ===
The last method of creating maps is simply coding them by hand as text files using the raw [[BZW]] structures. This is still one of the most common ways that people create and edit maps, and can be very fun and challenging. This is easilly 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.

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

[[Category:Server]]

Server Permissions

2007-03-31T19:35:44Z

Tadd: add hideAdmin perm

Permissions can be assigned to groups and individual players on a server.
These permissions control what a player may do on the server. Many of the permissions control which [[Client_Commands|commands]] can be used by players.

{|{{Prettytable}}
|-
| {{Hl3}} |'''Permission'''
| {{Hl3}} |'''Description'''
|-
| actionMessages || Allowed to use '''''/me'''''
|-
| adminMessageReceive || Player receives messages sent to the admin channel
|-
| adminMessageSend || Player may send messages to the admin channel
|-
| antiban || Player is immune to '''''/ban'''''
|-
| antideregister || Player cannot be deregistered with '''''/deregister'''''
|-
| antikick || Player is immune to '''''/kick'''''
|-
| antikill || Player is immune to '''''/kill'''''
|-
| antipoll || Player is immune to '''''/poll'''''
|-
| antipollban || Player is immune banning with '''''/poll'''''
|-
| antipollkick || Player is immune kicking with '''''/poll'''''
|-
| antipollkill || Player is immune killing with '''''/poll'''''
|-
| ban || Player may ban other players with '''''/ban'''''
|-
| banlist || Player may list active bans with '''''/banlist'''''
|-
| countdown || Player may issue '''''/countdown'''''
|-
| date || Player may query the date and time from the server with '''''/date'''''
|-
| endGame || Player may issue '''''/endgame'''''
|-
| flagHistory || Player allowed to use '''''/flaghistory'''''
|-
| flagMaster || Player allowed to use '''''/flag give''''' and '''''/flag take'''''
|-
| flagMod || Player allowed to use '''''/flag'''''
|-
| hideAdmin || Player doesn't show @
|-
| idlestats || Player allowed to use '''''/idlestats'''''
|-
| info ||
|-
| kick || Player allowed to use '''''/kick'''''
|-
| kill || Player allowed to use '''''/kill'''''
|-
| lagwarn || Player may use '''''/lagwarn''''' to query or set lagwarn variable
|-
| listPerms ||
|-
| masterban || Player may use '''''/masterban'''''
|-
| mute || Player may use '''''/mute'''''
|-
| playerList || Player may use '''''/playerlist'''''
|-
| poll || Player may use '''''/poll'''''
|-
| pollBan || Player may use '''''/poll ban'''''
|-
| pollFlagReset || Player may use '''''/poll flagreset'''''
|-
| pollKick || Player may use '''''/poll kick'''''
|-
| pollKill || Player may use '''''/poll kill'''''
|-
| pollSet || Player may use '''''/poll set'''''
|-
| privateMessage || Player may send private messages with '.'
|-
| record || Player may use '''''/record'''''
|-
| rejoin || Allows instant rejoin, regardless of '''''_rejoinTime'''''
|-
| removePerms || May remove permissions from players
|-
| replay || Player allowed to use '''''/replay'''''
|-
| requireIdentify || Registered callsigns must identify before they are allowed to spawn
|-
| say || Player allowed to use '''''/say'''''
|-
| sendHelp || Player allowed to use '''''/sendhelp'''''
|-
| setAll || Grants all set* perms
|-
| setPerms || May grant permissions to players
|-
| setVar || Player allowed ot use '''''/set'''''
|-
| shortBan || Allowed bans with limited durations only
|-
| showOthers || May use '''''/showgroup''''' on other callsigns
|-
| shutdownServer || Player allowed to use '''''/shutdownserver'''''
|-
| spawn || Join game as a player. Observers don't need this permission.
|-
| superkill || Player allowed to use '''''/superkill'''''
|-
| talk || Allows player to send messages.
|-
| unban || Player may use '''''/unban'''''
|-
| unmute || Player may use '''''/unban'''''
|-
| veto || Player may use '''''/veto'''''
|-
| viewReports || Player may use '''''/viewreports'''''
|-
| vote || Player may use '''''/vote'''''
|}

[[Category:Server]]