Plug-ins - Revision history

Loymdayddaud: Add section on Plug-in Development

2025-11-02T05:04:33Z

Add section on Plug-in Development

← Older revision		Revision as of 05:04, 2 November 2025
Line 79:		Line 79:

	==Plug-in Development==		==Plug-in Development==
	~~{{DoDoc\|Describe~~ the ~~basics~~ of ~~plug~~-~~in development~~.}}		To begin a plugin, use [https://bzflag-plugin-starter.allejo.org/ allejo's plugin skeleton generator] to create the initial logic.
			Next, look at the [https://bzflag.org/documentation/developer/bzfs_api documentation] and update the event portion of your plugin to perform the desired behavior. A tutorial on creating plugins can be found [https://allejo.io/anthologies/ here].
			Note that the plugin generator adds '''const char *config''' to your plugin Init function. Unless you want command-line options for your plugin, this can be commented out.

	==History==		==History==

Loymdayddaud: Small update

2025-11-02T04:52:04Z

Small update

← Older revision		Revision as of 04:52, 2 November 2025
Line 4:		Line 4:

	==Overview==		==Overview==
	Plug-ins are compiled dynamic link libraries, that are built for the same OS/RuntimeEnvironment as the BZFS server that hosts them. On [http://www.microsoft.com/windows Microsoft Windows] they are built as [http://en.wikipedia.org/wiki/Dynamic-link_library DLL] files. On [http://www.linux.org Linux] and other [http://www.unix.org/ Unix]-like systems they are built as .so files.		Plug-ins are compiled dynamic link libraries, that are built for the same OS/RuntimeEnvironment as the BZFS server that hosts them. On [http://www.microsoft.com/windows Microsoft Windows] they are built as [http://en.wikipedia.org/wiki/Dynamic-link_library DLL] files. On MacOS they are built as .dylib files. On [http://www.linux.org Linux] and other [http://www.unix.org/ Unix]-like systems they are built as .so files.

	==Use==		==Use==
Line 82:		Line 82:

	==History==		==History==
	The plug-in system was added in BZFlag V. 2.0.4 and was initially met with a lukewarm reception by some of the core developers and the maintainer. The community has since embraced the concept and built a multitude of useful modifications, many that have been incorporated into the project as standard plug-ins.		The plug-in system was added in BZFlag v. 2.0.4 and was initially met with a lukewarm reception by some of the core developers and the maintainer. The community has since embraced the concept and built a multitude of useful modifications, many that have been incorporated into the project as standard plug-ins.

	For Version 3.0 major changes to the [[BZFS API]] have been made to increase its lifespan.		For Version 3.0 major changes to the [[BZFS API]] have been made to increase its lifespan.

Zehra: /* Standard plug-ins */ updated content to use template

2017-02-24T22:24:50Z

Standard plug-ins: updated content to use template

@@ Line 22: / Line 22: @@
 These plug-ins are located in the ''/plugins'' directory.
-As of July 2016, [[BZFlag Git|Git]] tree contains the following plug-ins:
+{{Template:Plug-in list}}
 ==Third Party Plug-ins==

Zehra: /* Standard plug-ins */ added link

2017-01-31T18:55:20Z

Standard plug-ins: added link

← Older revision		Revision as of 18:55, 31 January 2017
Line 78:		Line 78:
	\| [[SAMPLE_PLUGIN]]		\| [[SAMPLE_PLUGIN]]
	\|-		\|-
	\| [[serverControl]]		\| [[Server Control\|serverControl]]
	\|-		\|-
	\| [[serverSidePlayerSample]]		\| [[serverSidePlayerSample]]

Zehra: /* Standard plug-ins */ added wiki table

2016-11-24T23:37:31Z

Standard plug-ins: added wiki table

← Older revision		Revision as of 23:37, 24 November 2016
Line 24:		Line 24:
	As of July 2016, [[BZFlag Git\|Git]] tree contains the following plug-ins:		As of July 2016, [[BZFlag Git\|Git]] tree contains the following plug-ins:

	*[[airspawn]]		{\|{{Prettytable}}
	*[[autoFlagReset]]		\|-
	*[[bzfscron]]		\| {{Hl3}} \|'''Plug-in'''
	*[[chathistory]]		\|-
	*[[customflagsample]]		\| [[airspawn]]
	*[[CustomZoneSample]]		\|-
	*[[fairCTF]]		\| [[autoFlagReset]]
	*[[fastmap]]		\|-
	*[[flagStay]]		\| [[bzfscron]]
	*[[HoldTheFlag]]		\|-
	*[[keepaway]]		\| [[chathistory]]
	*[[killall]]		\|-
	*[[koth]]		\| [[customflagsample]]
	*[[logDetail]]		\|-
	*[[nagware]]		\| [[CustomZoneSample]]
	*[[Phoenix]]		\|-
	*[[playHistoryTracker]]		\| [[fairCTF]]
	*[[plugin_utils]]		\|-
	*[[pushstats]]		\| [[fastmap]]
	*[[rabbitTimer]]		\|-
	*[[rabidRabbit]]		\| [[flagStay]]
	*[[recordmatch]]		\|-
	*[[regFlag]]		\| [[HoldTheFlag]]
	*[[RogueGenocide]]		\|-
	*[[SAMPLE_PLUGIN]]		\| [[keepaway]]
	*[[serverControl]]		\|-
	*[[serverSidePlayerSample]]		\| [[killall]]
	*[[shockwaveDeath]]		\|-
	*[[superUser]]		\| [[koth]]
	*[[teamflagreset]]		\|-
	*[[thiefControl]]		\| [[logDetail]]
	*[[timedctf]]		\|-
	*[[TimeLimit]]		\| [[nagware]]
	*[[wwzones]]		\|-
			\| [[Phoenix]]
			\|-
			\| [[playHistoryTracker]]
			\|-
			\| [[plugin_utils]]
			\|-
			\| [[pushstats]]
			\|-
			\| [[rabbitTimer]]
			\|-
			\| [[rabidRabbit]]
			\|-
			\| [[recordmatch]]
			\|-
			\| [[regFlag]]
			\|-
			\| [[RogueGenocide]]
			\|-
			\| [[SAMPLE_PLUGIN]]
			\|-
			\| [[serverControl]]
			\|-
			\| [[serverSidePlayerSample]]
			\|-
			\| [[shockwaveDeath]]
			\|-
			\| [[superUser]]
			\|-
			\| [[teamflagreset]]
			\|-
			\| [[thiefControl]]
			\|-
			\| [[timedctf]]
			\|-
			\| [[TimeLimit]]
			\|-
			\| [[wwzones]]
			\|}

	==Third Party Plug-ins==		==Third Party Plug-ins==

Allejo: Add note about linking to plugin_utils

2016-09-29T17:05:54Z

Add note about linking to plugin_utils

← Older revision		Revision as of 17:05, 29 September 2016
Line 98:		Line 98:
	# Select your new library target. Select the Build Settings tab, and locate the Other Linker Flags option. Add the option "-undefined dynamic_lookup"		# Select your new library target. Select the Build Settings tab, and locate the Other Linker Flags option. Add the option "-undefined dynamic_lookup"
	# Find the Architecture build setting for your new library. Make sure it is the same architecture as the main codebase, or click Levels, click the Architecture setting under your library target, click Other, and delete the setting. This will make it assume the overall project build architecture.		# Find the Architecture build setting for your new library. Make sure it is the same architecture as the main codebase, or click Levels, click the Architecture setting under your library target, click Other, and delete the setting. This will make it assume the overall project build architecture.
			# If your plug-in uses "plugin_utils.h", then ensure that under Build Phases the '''libplugin_utils.a''' library is listed under "Link Binary With Libraries"; add the library if it is not already listed.
	# Find the Executable Prefix build setting for your new library, and delete the "lib" setting.		# Find the Executable Prefix build setting for your new library, and delete the "lib" setting.
	# Add your source file(s) to the project, and make them members of your library target; ensure you select the "Copy items if needed" checkbox and to choose "Create groups."		# Add your source file(s) to the project, and make them members of your library target; ensure you select the "Copy items if needed" checkbox and to choose "Create groups."

Zehra: /* Third Party Plug-ins */ updated link

2016-07-22T23:07:07Z

Third Party Plug-ins: updated link

← Older revision		Revision as of 23:07, 22 July 2016
Line 60:		Line 60:

	==Third Party Plug-ins==		==Third Party Plug-ins==
	A number of non-developers have created plug-ins for BZFS, and usually release them on the [~~http~~://my.bzflag.org~~/bb~~/ BZFlag Forums].		A number of non-developers have created plug-ins for BZFS, and usually release them on the [https://forums.bzflag.org/ BZFlag Forums].

	=== On Linux ===		=== On Linux ===

Zehra: /* Standard plug-ins */ updated information to latest release

2016-07-04T14:44:14Z

Standard plug-ins: updated information to latest release

← Older revision		Revision as of 14:44, 4 July 2016
Line 22:		Line 22:
	These plug-ins are located in the ''/plugins'' directory.		These plug-ins are located in the ''/plugins'' directory.

	As of ~~March 2013~~, [[BZFlag ~~SVN~~\|~~SVN~~]] ~~TRUNK~~ contains the following plug-ins:		As of July 2016, [[BZFlag Git\|Git]] tree contains the following plug-ins:

	*[[airspawn]]		*[[airspawn]]
Line 29:		Line 29:
	*[[chathistory]]		*[[chathistory]]
	*[[customflagsample]]		*[[customflagsample]]
			*[[CustomZoneSample]]
	*[[fairCTF]]		*[[fairCTF]]
	*[[fastmap]]		*[[fastmap]]
	*[[flagStay]]		*[[flagStay]]
	*[[hiddenAdmin]]
	*[[HoldTheFlag]]		*[[HoldTheFlag]]
	*[[keepaway]]		*[[keepaway]]
Line 57:		Line 57:
	*[[timedctf]]		*[[timedctf]]
	*[[TimeLimit]]		*[[TimeLimit]]
	*[[webReport]]
	*[[webstats]]
	*[[wwzones]]		*[[wwzones]]

Allejo: Quick notes about adding plugin source to the Xcode build

2015-11-11T03:36:01Z

Quick notes about adding plugin source to the Xcode build

← Older revision		Revision as of 03:36, 11 November 2015
Line 101:		Line 101:
	# Find the Architecture build setting for your new library. Make sure it is the same architecture as the main codebase, or click Levels, click the Architecture setting under your library target, click Other, and delete the setting. This will make it assume the overall project build architecture.		# Find the Architecture build setting for your new library. Make sure it is the same architecture as the main codebase, or click Levels, click the Architecture setting under your library target, click Other, and delete the setting. This will make it assume the overall project build architecture.
	# Find the Executable Prefix build setting for your new library, and delete the "lib" setting.		# Find the Executable Prefix build setting for your new library, and delete the "lib" setting.
	# Add your source file(s) to the project, and make them members of your library target.		# Add your source file(s) to the project, and make them members of your library target; ensure you select the "Copy items if needed" checkbox and to choose "Create groups."
	# Build as usual.		# Build as usual.

Alezakos: /* Third Party Plug-ins */ Update the guide to build 3rd-party plugins for 2.4.3

2015-08-22T10:14:56Z

Third Party Plug-ins: Update the guide to build 3rd-party plugins for 2.4.3

← Older revision		Revision as of 10:14, 22 August 2015
Line 63:		Line 63:
	==Third Party Plug-ins==		==Third Party Plug-ins==
	A number of non-developers have created plug-ins for BZFS, and usually release them on the [http://my.bzflag.org/bb/ BZFlag Forums].		A number of non-developers have created plug-ins for BZFS, and usually release them on the [http://my.bzflag.org/bb/ BZFlag Forums].

			=== On Linux ===

	Here are the steps to compile a hypothetical third party plug-in named "Example":		Here are the steps to compile a hypothetical third party plug-in named "Example":

			==== For versions older than 2.4.3 ====

	# In the plugins directory of the BZFlag source tree run the command '''./newplug.sh Example'''		# In the plugins directory of the BZFlag source tree run the command '''./newplug.sh Example'''
Line 71:		Line 75:
	# In the top-level BZFlag source directory run '''autogen.sh''', '''configure''', and '''make''' as usual		# In the top-level BZFlag source directory run '''autogen.sh''', '''configure''', and '''make''' as usual

			==== For versions on or after 2.4.3 ====

			# Store the distributed plugin files into the plugins/''Example'' directory
			# In the top-level BZFlag source directory run:
			<div style="margin-left: 45px;">
			./autogen.sh
			./configure --enable-custom-plugins=''Example''
			./make

			Note that you can use a comma-separated list to specify multiple plugins to be built:
			./configure --enable-custom-plugins=''Example'',''AnotherExample'',''AnotherPlugin''
			</div>
	When that finishes successfully the plug-in should be ready to use as described above.		When that finishes successfully the plug-in should be ready to use as described above.

			=== On Mac OS X ===

	In Xcode on Mac OS X, follow these instructions:		In Xcode on Mac OS X, follow these instructions: