Metadata-Version: 2.1
Name: sopel-slap
Version: 0.3.2
Summary: Plugin for Sopel that lets users slap each other in fun ways
Author: dgw, Michael Yanovich
Maintainer: dgw
License: EFL-2.0
Project-URL: Homepage, https://github.com/sopel-irc/sopel-slap
Project-URL: Bug Tracker, https://github.com/sopel-irc/sopel-slap/issues
Keywords: sopel,plugin,slap,pranks,bot,irc
Platform: Linux x86, x86-64
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: Eiffel Forum License (EFL)
Classifier: License :: OSI Approved :: Eiffel Forum License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: <4,>=3.8
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: sopel>=7.1

# sopel-slap

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

## Installation

```sh
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:

```sh
sopel-plugins configure slap
```

Right now, there is only one option:

* `verbs`: A list of verbs to choose from when slapping people. Overrides the
  default list if set.

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.)_

## Commands

<dl>
  <dt>.slap</dt>
  <dd>Make the bot slap you</dd>

  <dt>.slap nickname [reason]</dt>
  <dd>Slap someone else, with an optional reason</dd>
</dl>

_If your bot has a non-default `prefix`, substitute it for `.` above._

## Credits

This is based on [the original `slap.py`][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.

[original-slap.py]: https://github.com/sopel-irc/sopel-extras/blob/81ee756223474cacdac6f5847772d6085d006a50/slap.py
[sopel-extras]: https://github.com/sopel-irc/sopel-extras
