SPADS plugin development - Revision history

Bibim: Replaced content with "This page is now hosted on GitHub: [https://github.com/Yaribz/SPADS/wiki/SPADS-plugin-development SPADS plugin development]"

2024-07-15T10:04:24Z

Replaced content with "This page is now hosted on GitHub: [https://github.com/Yaribz/SPADS/wiki/SPADS-plugin-development SPADS plugin development]"

Show changes

Bibim: /* Writing plugin code */

2021-01-28T13:19:37Z

Writing plugin code

← Older revision		Revision as of 14:19, 28 January 2021
Line 248:		Line 248:
	Here is an implementation example for this basic command:		Here is an implementation example for this basic command:
	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl">
	# This is the handler for our new command		# This is the handler for our new command
	sub hSpadsTime {		sub hSpadsTime {
	my ($source,$user,$p_params,$checkOnly)=@_;		my ($source,$user,$p_params,$checkOnly)=@_;

	# time is a basic command, we have nothing to check in case of callvote		# time is a basic command, we have nothing to check in case of callvote
	return 1 if($checkOnly);		return 1 if($checkOnly);

	my @time = localtime();		my @time = localtime();
	@time = map(sprintf("%02d",$_),@time);		@time = map(sprintf("%02d",$_),@time);

	answer("Current local time: $time[2]:$time[1]:$time[0]");		answer("Current local time: $time[2]:$time[1]:$time[0]");
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Bibim: /* Preparing the template */

2021-01-28T13:18:51Z

Preparing the template

← Older revision		Revision as of 14:18, 28 January 2021
Line 215:		Line 215:
	{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|		{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|
	\|		\|
	# Anyone can call our command from anywhere		# Anyone can call our command from anywhere
	[time]		[time]
	::\|0:		::\|0:
	\|}		\|}
	Now we need to write the help information for our new command. This is done in the file <code>TimePluginHelp.dat</code>. This file uses the same syntax as the standard SPADS <code>help.dat</code> file, and the template provides a help example for a command <code>myCommand</code> as a syntax reminder. After each command declaration, the first line is the command syntax description, and the other lines are optional usage examples. Let's replace this help example with our own help information for our basic <code>!time</code> command:		Now we need to write the help information for our new command. This is done in the file <code>TimePluginHelp.dat</code>. This file uses the same syntax as the standard SPADS <code>help.dat</code> file, and the template provides a help example for a command <code>myCommand</code> as a syntax reminder. After each command declaration, the first line is the command syntax description, and the other lines are optional usage examples. Let's replace this help example with our own help information for our basic <code>!time</code> command:
	{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|		{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|
	\|		\|
	[time]		[time]
	<nowiki>!</nowiki>time - This command just prints current time		<nowiki>!</nowiki>time - This command just prints current time
	\|}		\|}

	== Writing plugin code ==		== Writing plugin code ==

Bibim: /* Writing plugin code */

2021-01-28T13:17:14Z

Writing plugin code

Show changes

Bibim: /* Preparing the template */

2021-01-28T13:15:31Z

Preparing the template

Bibim: /* Writing plugin code */

2021-01-28T13:15:00Z

Writing plugin code

← Older revision		Revision as of 14:15, 28 January 2021
Line 38:		Line 38:
	Now that we have identified the API functions that we need, we can actually implement our plugin. Here is a commented implementation example of the <code>onPrivateMsg</code> callback, which will answer <code>Hello World</code> to anyone saying <code>Hello</code> in a private message to SPADS:		Now that we have identified the API functions that we need, we can actually implement our plugin. Here is a commented implementation example of the <code>onPrivateMsg</code> callback, which will answer <code>Hello World</code> to anyone saying <code>Hello</code> in a private message to SPADS:
	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl">
	sub onPrivateMsg {		sub onPrivateMsg {

			# $self is the plugin object (first parameter of all plugin callbacks)
			# $userName is the name of the user sending the private message
			# $message is the message sent by the user
			my ($self,$userName,$message)=@_;

			# We check the message sent by the user is "Hello"
			if($message eq 'Hello') {

	# ~~$self is the plugin object (first parameter of all plugin callbacks)~~		# We send our wonderful Hello World message
	~~# $userName is the name of the user sending the private message~~		sayPrivate($userName,'Hello World');
	~~# $message is the~~ message ~~sent by the user~~
	my (~~$self,~~$userName,~~$message~~)~~=@_~~;

	~~# We check the message sent by the user is "Hello"~~		}
	~~if($message eq 'Hello') {~~
			# We return 0 because we don't want to filter out private messages
	~~# We send our wonderful Hello World message~~		# for other SPADS processing
	~~sayPrivate($userName,'Hello World');~~		return 0;

	}		}</syntaxhighlight>

	# We return 0 because we don't want to filter out private messages
	# for other SPADS processing
	return 0;

	}</syntaxhighlight>

	All we have to do now is adding this callback declaration in our <code>HelloWorld.pm</code> file located in SPADS plugins directory. We obtain [http://planetspads.free.fr/spads/plugins/tutorials/HelloWorld.pm this fully functional HelloWorld plugin].		All we have to do now is adding this callback declaration in our <code>HelloWorld.pm</code> file located in SPADS plugins directory. We obtain [http://planetspads.free.fr/spads/plugins/tutorials/HelloWorld.pm this fully functional HelloWorld plugin].

Bibim: /* New-command plugin tutorial (TimePlugin) */

2021-01-28T10:49:12Z

New-command plugin tutorial (TimePlugin)

← Older revision		Revision as of 11:49, 28 January 2021
Line 204:		Line 204:
	= New-command plugin tutorial (TimePlugin) =		= New-command plugin tutorial (TimePlugin) =

	In this section we are going to write a plugin which implements a new command for SPADS. Such plugins are configurable plugins like the one we wrote just before, with 2 additional files to configure the new commands. This plugin will give current time when someone types "!time".		In this section we are going to write a plugin which implements a new command for SPADS. Such plugins are configurable plugins like the one we wrote just before, with 2 additional files to configure the new commands. This plugin will give current time when someone types <code>!time</code>.

	== Preparing the template ==		== Preparing the template ==
Line 210:		Line 210:
	This time we need to download 4 files to prepare our plugin: [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPlugin.pm the new-command plugin template], [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPlugin.conf the associated configuration file example], [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPluginHelp.dat the help file example] and [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPluginCmd.conf the commands rights configuration file example].		This time we need to download 4 files to prepare our plugin: [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPlugin.pm the new-command plugin template], [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPlugin.conf the associated configuration file example], [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPluginHelp.dat the help file example] and [http://planetspads.free.fr/spads/plugins/templates/commented/MyNewCommandPluginCmd.conf the commands rights configuration file example].

	As usual, we rename these files to match our plugin name: "MyNewCommandPlugin" --> "TimePlugin". Then we edit the plugin template TimePlugin.pm and replace "MyNewCommandPlugin" by "TimePlugin" in the source code, and we do the same for the plugin configuration template TimePlugin.conf, so that the "commandsFile" and "helpFile" settings are consistent with the files we just renamed.		As usual, we rename these files to match our plugin name: <code>MyNewCommandPlugin</code> --> <code>TimePlugin</code>. Then we edit the plugin template <code>TimePlugin.pm</code> and replace <code>MyNewCommandPlugin</code> by <code>TimePlugin</code> in the source code, and we do the same for the plugin configuration template <code>TimePlugin.conf</code>, so that the <code>commandsFile</code> and <code>helpFile</code> settings are consistent with the files we just renamed.

	Then we can edit our command rights requirements configuration file: TimePluginCmd.conf. This file uses the same syntax as the standard SPADS commands.conf file. The template provides a default command "myCommand" with no requirement. We will just rename this command to "time":		Then we can edit our command rights requirements configuration file: <code>TimePluginCmd.conf</code>. This file uses the same syntax as the standard SPADS <code>commands.conf</code> file. The template provides a default command <code>myCommand</code> with no requirement. We will just rename this command to <code>time</code>:
	{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|		{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|
	\|		\|
Line 219:		Line 219:
	::\|0:		::\|0:
	\|}		\|}
	Now we need to write the help information for our new command. This is done in the file TimePluginHelp.dat. This file uses the same syntax as the standard SPADS help.dat file, and the template provides a help example for a command "myCommand" as a syntax reminder. After each command declaration, the first line is the command syntax description, and the other lines are optional usage examples. Let's replace this help example with our own help information for our basic !time command:		Now we need to write the help information for our new command. This is done in the file <code>TimePluginHelp.dat</code>. This file uses the same syntax as the standard SPADS <code>help.dat</code> file, and the template provides a help example for a command <code>myCommand</code> as a syntax reminder. After each command declaration, the first line is the command syntax description, and the other lines are optional usage examples. Let's replace this help example with our own help information for our basic <code>!time</code> command:
	{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|		{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|
	\|		\|
Line 227:		Line 227:
	== Writing plugin code ==		== Writing plugin code ==

	The new-command plugin template that we used to initialize our plugin already defines a new command named "myCommand", so all we have to do is to edit our plugin file ( TimePlugin.pm ) and replace this command by our own "time" command:		The new-command plugin template that we used to initialize our plugin already defines a new command named <code>myCommand</code>, so all we have to do is to edit our plugin file ( <code>TimePlugin.pm</code> ) and replace this command by our own <code>time</code> command:

	First, let's modify the code which sets up the new SPADS command handler using the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#addSpadsCommandHandler-handlers-replace-0 addSpadsCommandHandler]. This call is located in the plugin constructor. We edit it so that it becomes:		First, let's modify the code which sets up the new SPADS command handler using the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#addSpadsCommandHandler-handlers-replace-0 addSpadsCommandHandler]. This call is located in the plugin constructor. We edit it so that it becomes:
Line 243:		Line 243:
	[...]		[...]
	</syntaxhighlight>		</syntaxhighlight>
	Finally, we must replace the handler example "hMyCommand" by our own handler "hSpadsTime". In order to answer to the user issuing the command, we can use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#answer-message answer], which will send an answer message to the user in the same way he sent the command (private message, battle lobby...).		Finally, we must replace the handler example <code>hMyCommand</code> by our own handler <code>hSpadsTime</code>. In order to answer to the user issuing the command, we can use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#answer-message answer], which will send an answer message to the user in the same way he sent the command (private message, battle lobby...).

	Here is an implementation example for this basic command:		Here is an implementation example for this basic command:
Line 267:		Line 267:
	To test our plugin, we have to put the plugin module and the plugin help file in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:pluginsDir SPADS plugins directory], and the 2 configuration files in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:etcDir SPADS etc directory].		To test our plugin, we have to put the plugin module and the plugin help file in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:pluginsDir SPADS plugins directory], and the 2 configuration files in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:etcDir SPADS etc directory].

	Then we load the plugin as follows: "!plugin TimePlugin load". And finally, we can try to say !time in a private message to SPADS or in the battle lobby, and SPADS should answer giving current local time. Our !time command help should also appear in "!help" and "!help time" outputs.		Then we load the plugin as follows: <code>!plugin TimePlugin load</code>. And finally, we can try to say !time in a private message to SPADS or in the battle lobby, and SPADS should answer giving current local time. Our <code>!time</code> command help should also appear in <code>!help</code> and <code>!help time</code> outputs.

	[[Category:SPADS]]		[[Category:SPADS]]

Bibim: /* Configurable plugin tutorial (ForbiddenWords) */

2021-01-28T09:57:16Z

Configurable plugin tutorial (ForbiddenWords)

Bibim at 07:32, 28 January 2021

2021-01-28T07:32:38Z

← Older revision		Revision as of 08:32, 28 January 2021
Line 5:		Line 5:
	SPADS plugins are object-oriented modules. It is strongly recommended to already know Perl basics before starting Perl plugin development (a brief introduction to Perl is available [https://perldoc.perl.org/perlintro here]).		SPADS plugins are object-oriented modules. It is strongly recommended to already know Perl basics before starting Perl plugin development (a brief introduction to Perl is available [https://perldoc.perl.org/perlintro here]).

			<br>
	= Simple plugin tutorial (HelloWorld) =		= Simple plugin tutorial (HelloWorld) =

Line 66:		Line 67:
	Finally, just say <code>Hello</code> to SPADS in a private message. Congratulations for your first SPADS plugin! ;)		Finally, just say <code>Hello</code> to SPADS in a private message. Congratulations for your first SPADS plugin! ;)

			<br>
	= Configurable plugin tutorial (ForbiddenWords) =		= Configurable plugin tutorial (ForbiddenWords) =

Line 198:		Line 200:
	Then we load the plugin as follows: "!plugin ForbiddenWords load". And finally, as an unprivileged user we can try to say some forbidden words in the battle lobby and we should get kicked by the plugin.		Then we load the plugin as follows: "!plugin ForbiddenWords load". And finally, as an unprivileged user we can try to say some forbidden words in the battle lobby and we should get kicked by the plugin.

			<br>
	= New-command plugin tutorial (TimePlugin) =		= New-command plugin tutorial (TimePlugin) =

Bibim: /* Writing plugin code */

2021-01-27T21:07:01Z

Writing plugin code

← Older revision		Revision as of 22:07, 27 January 2021
Line 35:		Line 35:
	We also want our plugin to send a private message, to do so we can call the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#sayPrivate-user-message sayPrivate].		We also want our plugin to send a private message, to do so we can call the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#sayPrivate-user-message sayPrivate].

	Now that we have identified the API functions that we need, we can actually implement our plugin. Here is a commented implementation example of the <code>onPrivateMsg</code> callback, which will answer "Hello World" to anyone saying "Hello" in a private message to SPADS:		Now that we have identified the API functions that we need, we can actually implement our plugin. Here is a commented implementation example of the <code>onPrivateMsg</code> callback, which will answer <code>Hello World</code> to anyone saying <code>Hello</code> in a private message to SPADS:
	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl">
	sub onPrivateMsg {		sub onPrivateMsg {

← Older revision		Revision as of 14:15, 28 January 2021
Line 85:		Line 85:
	{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|		{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|
	\|		\|
	# This is our global setting (can't be changed without reloading the configuration)		# This is our global setting (can't be changed without reloading the configuration)
	words:ass;asshole;bastard;bitch;cunt;fuck;motherfucker;shit;whore		words:ass;asshole;bastard;bitch;cunt;fuck;motherfucker;shit;whore

	# We must define our preset setting in the default preset at least		# We must define our preset setting in the default preset at least
	[default]		[default]

	# This is our preset setting, which can be changed with "!plugin ... set ..."		# This is our preset setting, which can be changed with "!plugin ... set ..."
	# or by loading a preset.		# or by loading a preset.
	# "100" is the default value, and any integer between 0 and 140 is allowed		# "100" is the default value, and any integer between 0 and 140 is allowed
	immuneLevel:100\|0-140		immuneLevel:100\|0-140
	\|}		\|}
	Then we must prepare the plugin template itself, by renaming it from <code>MyConfigurablePlugin.pm</code> to <code>ForbiddenWords.pm</code> and editing it to replace <code>MyConfigurablePlugin</code> by <code>ForbiddenWords</code> in the source code. We must also adapt the template so that it uses the configuration settings we chose. This is done by modifying the <code>%globalPluginParams</code> and <code>%presetPluginParam</code> declarations as follows:		Then we must prepare the plugin template itself, by renaming it from <code>MyConfigurablePlugin.pm</code> to <code>ForbiddenWords.pm</code> and editing it to replace <code>MyConfigurablePlugin</code> by <code>ForbiddenWords</code> in the source code. We must also adapt the template so that it uses the configuration settings we chose. This is done by modifying the <code>%globalPluginParams</code> and <code>%presetPluginParam</code> declarations as follows:
	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl">
	# We define one global setting "words" and one preset setting "immuneLevel".		# We define one global setting "words" and one preset setting "immuneLevel".
	# "words" has no type associated (no restriction on allowed values)		# "words" has no type associated (no restriction on allowed values)
	# "immuneLevel" must be an integer or an integer range		# "immuneLevel" must be an integer or an integer range
	# (check %paramTypes hash in SpadsConf.pm for a complete list of allowed		# (check %paramTypes hash in SpadsConf.pm for a complete list of allowed
	# setting types)		# setting types)
	my %globalPluginParams = ( words => [] );		my %globalPluginParams = ( words => [] );
	my %presetPluginParams = ( immuneLevel => ['integer','integerRange'] );		my %presetPluginParams = ( immuneLevel => ['integer','integerRange'] );
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 10:57, 28 January 2021
Line 70:		Line 70:
	= Configurable plugin tutorial (ForbiddenWords) =		= Configurable plugin tutorial (ForbiddenWords) =

	In this section we are going to write our first configurable SPADS plugin (a configurable plugin has its own configuration file, named after the plugin name but with ".conf" extension). This plugin will monitor all messages said by players in the battle lobby, and will kick players who use swear words.		In this section we are going to write our first configurable SPADS plugin (a configurable plugin has its own configuration file, named after the plugin name but with <code>.conf</code> extension). This plugin will monitor all messages said by players in the battle lobby, and will kick players who use swear words.

	== Specifying our configuration parameters ==		== Specifying our configuration parameters ==

	The first step of writing a configurable plugin is to choose how we will configure it. In our example, we will use 2 configuration parameters: "words" will contain the list of forbidden words, and "immuneLevel" will contain the minimum autohost access level to be immune regarding these forbidden words checks.		The first step of writing a configurable plugin is to choose how we will configure it. In our example, we will use 2 configuration parameters: <code>words</code> will contain the list of forbidden words, and <code>immuneLevel</code> will contain the minimum autohost access level to be immune regarding these forbidden words checks.

	We choose to make "words" a global setting (unmodifiable, not impacted by preset change), and "immuneLevel" a preset setting (modifiable, can be impacted by preset change). The "words" global setting will have no restriction (can be empty, can contain any character...), whereas the "immuneLevel" preset setting will only be allowed to be an integer or integer range.		We choose to make <code>words</code> a global setting (unmodifiable, not impacted by preset change), and <code>immuneLevel</code> a preset setting (modifiable, can be impacted by preset change). The <code>words</code> global setting will have no restriction (can be empty, can contain any character...), whereas the <code>immuneLevel</code> preset setting will only be allowed to be an integer or integer range.

	== Preparing the template ==		== Preparing the template ==
Line 82:		Line 82:
	Once we have a clear view of our configuration settings, we can start adapting the template for our needs. Since we are making a configurable plugin, this time we will download [http://planetspads.free.fr/spads/plugins/templates/commented/MyConfigurablePlugin.pm the configurable plugin template] and its associated [http://planetspads.free.fr/spads/plugins/templates/commented/MyConfigurablePlugin.conf configuration file example].		Once we have a clear view of our configuration settings, we can start adapting the template for our needs. Since we are making a configurable plugin, this time we will download [http://planetspads.free.fr/spads/plugins/templates/commented/MyConfigurablePlugin.pm the configurable plugin template] and its associated [http://planetspads.free.fr/spads/plugins/templates/commented/MyConfigurablePlugin.conf configuration file example].

	First, let's take a look at the configuration file example. This is a just a basic configuration file containing one global setting example and one preset setting example. Let's modify this file to match the configuration we chose as follows (don't forget to rename the file from "MyConfigurablePlugin.conf" to "ForbiddenWords.conf" also):		First, let's take a look at the configuration file example. This is a just a basic configuration file containing one global setting example and one preset setting example. Let's modify this file to match the configuration we chose as follows (don't forget to rename the file from <code>MyConfigurablePlugin.conf</code> to <code>ForbiddenWords.conf</code> also):
	{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|		{\|style="margin-top: 10px; margin-left: 40px; background-color: #38474E; border: 1px solid black; border-color: #20292E" \|
	\|		\|
Line 96:		Line 96:
	immuneLevel:100\|0-140		immuneLevel:100\|0-140
	\|}		\|}
	Then we must prepare the plugin template itself, by renaming it from "MyConfigurablePlugin.pm" to "ForbiddenWords.pm" and editing it to replace "MyConfigurablePlugin" by "ForbiddenWords" in the source code. We must also adapt the template so that it uses the configuration settings we chose. This is done by modifying the %globalPluginParams and %presetPluginParam declarations as follows:		Then we must prepare the plugin template itself, by renaming it from <code>MyConfigurablePlugin.pm</code> to <code>ForbiddenWords.pm</code> and editing it to replace <code>MyConfigurablePlugin</code> by <code>ForbiddenWords</code> in the source code. We must also adapt the template so that it uses the configuration settings we chose. This is done by modifying the <code>%globalPluginParams</code> and <code>%presetPluginParam</code> declarations as follows:
	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl">
	# We define one global setting "words" and one preset setting "immuneLevel".		# We define one global setting "words" and one preset setting "immuneLevel".
Line 143:		Line 143:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	Finally, we have to implement our SAIDBATTLE handler "hLobbySaidBattle". In this handler we need to perform following operations:		Finally, we have to implement our <code>SAIDBATTLE</code> handler <code>hLobbySaidBattle</code>. In this handler we need to perform following operations:
	* skip processing if the user is the autohost itself: we need to access SPADS configuration to compare the user name with the [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:lobbyLogin lobbyLogin] setting value. So we will need the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#getSpadsConf getSpadsConf].		* skip processing if the user is the autohost itself: we need to access SPADS configuration to compare the user name with the [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:lobbyLogin lobbyLogin] setting value. So we will need the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#getSpadsConf getSpadsConf].
	* perform processing according to our configuration ("words" and "immuneLevel" settings): we need to access our plugin configuration, so we will need the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#getPluginConf-pluginName-caller getPluginConf].		* perform processing according to our configuration (<code>words</code> and <code>immuneLevel</code> settings): we need to access our plugin configuration, so we will need the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#getPluginConf-pluginName-caller getPluginConf].
	* retrieve the autohost access level of the user: we will use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#getUserAccessLevel-user getUserAccessLevel]		* retrieve the autohost access level of the user: we will use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#getUserAccessLevel-user getUserAccessLevel]
	* send a message to the battle lobby when we kick someone: we will use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#sayBattle-message sayBattle].		* send a message to the battle lobby when we kick someone: we will use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#sayBattle-message sayBattle].
	* send a [http://springrts.com/dl/LobbyProtocol/ProtocolDescription.html#KICKFROMBATTLE:client KICKFROMBATTLE] lobby command to kick a user: we will use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#queueLobbyCommand-lobbyCommand queueLobbyCommand].		* send a [http://springrts.com/dl/LobbyProtocol/ProtocolDescription.html#KICKFROMBATTLE:client KICKFROMBATTLE] lobby command to kick a user: we will use the plugin API function [http://planetspads.free.fr/spads/doc/spadsPluginApiDoc.html#queueLobbyCommand-lobbyCommand queueLobbyCommand].

	Here is a commented implementation example of this "hLobbySaidBattle" handler, which will kick any non-privileged user saying a forbidden word in the battle lobby:		Here is a commented implementation example of this <code>hLobbySaidBattle</code> handler, which will kick any non-privileged user saying a forbidden word in the battle lobby:
	<syntaxhighlight lang="perl">		<syntaxhighlight lang="perl">
	# This is the handler we set up on SAIDBATTLE lobby command.		# This is the handler we set up on SAIDBATTLE lobby command.
Line 198:		Line 198:
	To test our plugin, we have to put the plugin module in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:pluginsDir SPADS plugins directory], and the associated configuration file in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:etcDir SPADS etc directory].		To test our plugin, we have to put the plugin module in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:pluginsDir SPADS plugins directory], and the associated configuration file in [http://planetspads.free.fr/spads/doc/spadsDoc_All.html#global:etcDir SPADS etc directory].

	Then we load the plugin as follows: "!plugin ForbiddenWords load". And finally, as an unprivileged user we can try to say some forbidden words in the battle lobby and we should get kicked by the plugin.		Then we load the plugin as follows: <code>!plugin ForbiddenWords load</code>. And finally, as an unprivileged user we can try to say some forbidden words in the battle lobby and we should get kicked by the plugin.

	<br>		<br>

	= New-command plugin tutorial (TimePlugin) =		= New-command plugin tutorial (TimePlugin) =