The most extensible IRC /SLAP you have ever seen.
This is a plugin for HexChat. You can get HexChat from it's homepage.
Slapper consists of two components: the slapper python module, which is installed via setup.py and the plugins in the plugins folder, which utilize it. (right now it's HexChat only.)
- Slapping people in IRC.
- Slapping multiple people at once.
- Defining more than one command to be executed to slap someone.
- Usage of long names (with spaces) for both slappers and targets (with escaping!)
- Defining multiple slappers. (Never write more than one plugin)
- Slappers with optional commands.
/SLAP [-h] [-c slapper [slapper ...]] [-d key value] [-r] [-s slapper] [-o optional] target [target ...]
The syntax may vary for different plugins (currently, the Hexchat version includes even more options), but the ones above should always be included.
target is a target. You can have as many as you want.
-c|--choice defines a list of slappers (in your slapper directory) to choose from randomly. Have another option or add -- before the target list to not confuse the parser ;)
-d|--definition can be used to define a key value pair. If key is used in a slapper command, it will be replaced with value.
-h|--help prints a help, also explaining the syntax of the plugin in usage.
-r|--random same as choice, but with all slappers in your slapper directory.
-s|--slapper uses a specific slapper.
-o|--optional tells slapper to execute a command, it normally does not use.
For optional commands and definitions, please refer to the slapper configuration.
Slapper configuration files are by default stored in the slapper subfolder of your client's configuration folder. For the HexChat implementation this can be changed by changing slapper_cfg_dir in your addon_python.conf to a different directory. The slapper configuration file has the following sections:
[formatting]consists oftarget formatto make the names of targets appear bold, italic, whatever... andand, which is used when concatenating a list of more than one target to a comma seperated sequence,andand the last target.[replacements]has key value pairs of replacements, which can be used for commands.[count]hasusages, which is the current usage count andtargets, which is the current target count.[commands]are the IRC commands, which are to be executed, when the slapper slaps (a group of) someone(s).[optionals]are additional commands, which the user may call by adding a certain flag to the command he enters. See usage.
When a command uses a replacement, the key has to be embraced with curly brackets like {this}.
The following replacements are made internally. You can not override their values.
{targets}: the targets for slapping. This should be used in your commands, if you want to have the target names actually appear.{count usages}: how often the slapper has been used.{count targets}: on how many people the slapper has been used.{nick}: your nickname (might be handy sometimes).