sopel-slap 0.4.1

Plugin for Sopel that lets users slap each other in fun ways

sopel-slap

Plugin for Sopel that lets users slap each other in fun ways

Installation

pip install sopel-slap

Substitute the appropriate pip command based on your environment (e.g. pip3 or pip3.10 on systems with multiple Python versions available).

If your Sopel configuration requires it, run sopel-plugins enable slap, passing the appropriate config name to -c if you have multiple bots.

Configuration

The easiest way to configure this plugin is via Sopel's built-in wizard:

sopel-plugins configure slap

Available settings are described below.

The verbs option

verbs is a list of verbs to choose from when slapping people. If set, it overrides the default list.

Probably the easiest way to make a custom list is to just press Enter twice when the config wizard asks for a list of verbs, which will add the default list to your bot's .cfg file. Then you can use your favorite text editor.

(We're aware that Sopel's wizard doesn't have great UX when it comes to entering lists. It'll get worked on someday, probably.)

The reflexive option

reflexive is the pronoun the bot uses when someone with authorization does .slap BotNick. By default, this is set to "itself".

Commands

.slap

Make the bot slap you

.slap nickname [reason]

Slap someone else, with an optional reason

If your bot has a non-default prefix, substitute it for . above.

Credits

This is based on the original slap.py by Michael Yanovich from sopel-extras, dating back to the late '00s/early '10s. It's been rewritten more or less from scratch to do things in the modern Sopel way. The only meaningful behavior change was dropping substitution of the caller's nick for me and myself, as it's quite possible for a real person to use either of those as a nick and no one* should be safe from slaps!

* — No one except the bot and its admins, that is.