Plug-ins

Loymdayddaud — Thu, 05 Nov 2026 12:07:06 GMT

updates

← Older revision		Revision as of 12:07, 5 November 2026
Line 7:		Line 7:

	==Use==		==Use==
	Plug-ins are loaded at startup by the '''-loadplugin''' option, or at run time with the ''/loadplugin'' command. If the full path to the plug-in is not specified, then [[BZFS]] will search a number of known sub directories for the plug-in as it attempts to load it. Using a valid path to the plug-in on load is highly recommended. While playing, all plug-ins loaded onto the server are visible with the /listplugins command.		Plug-ins are loaded at startup by the '''-loadplugin''' option, or at run time with the ''/loadplugin'' command. If the full path to the plug-in is not specified, then [[BZFS]] will search a number of known sub directories for the plug-in as it attempts to load it. Using a valid path to the plug-in on load is highly recommended. While playing, all plug-ins loaded onto the server are visible with the /listplugins command to users with that permission.
	===Parameters===		===Parameters===
	Some plug-ins take parameters that are passed to the plug-in on load. This is often a numeric value, or a path to a file. To pass a parameter to a plug-in, simply add a ',' after the plug-in name or path, and then add the parameter. Parameters can not have spaces, due to the way [[BZFS]] parses command line options and / commands.		Some plug-ins take parameters that are passed to the plug-in on load. This is often a numeric value, or a path to a file. To pass a parameter to a plug-in, simply add a ',' after the plug-in name or path, and then add the parameter. Parameters can not have spaces, due to the way [[BZFS]] parses command line options and / commands.
Line 79:		Line 79:

	==Plug-in Development==		==Plug-in Development==
	To begin a plugin, use [https://bzflag-plugin-starter.allejo.org/ ~~allejo's~~ plugin skeleton generator] to create the initial logic.		To begin a plugin, use allejo's [https://bzflag-plugin-starter.allejo.org/ 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].
			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 by allejo 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.		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.

Line 86:		Line 88:
	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 unreleased [[BZFlag_2.99\|version 3.0]], major changes to the [[BZFS API]] were made to increase its lifespan.

User:Test

Test — Sun, 01 Nov 2026 21:11:45 GMT

User account Test was created

BZFlagWiki - Recent changes [en]

Plug-ins

User:Test