# 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
```
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
<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
Raw data
{
"_id": null,
"home_page": null,
"name": "sopel-slap",
"maintainer": "dgw",
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "sopel, plugin, slap, pranks, bot, irc",
"author": "dgw, Michael Yanovich",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/32/e9/bc764a664afed2a2b57e7e92db1f73965aa69fe23b39b80f7ccc8d05a9cf/sopel_slap-0.4.1.tar.gz",
"platform": "Linux x86, x86-64",
"description": "# sopel-slap\n\nPlugin for Sopel that lets users slap each other in fun ways\n\n## Installation\n\n```sh\npip install sopel-slap\n```\n\n_Substitute the appropriate `pip` command based on your environment (e.g.\n`pip3` or `pip3.10` on systems with multiple Python versions available)._\n\n_If your Sopel configuration requires it, run `sopel-plugins enable slap`,\npassing the appropriate config name to `-c` if you have multiple bots._\n\n## Configuration\n\nThe easiest way to configure this plugin is via Sopel's built-in wizard:\n\n```sh\nsopel-plugins configure slap\n```\n\nAvailable settings are described below.\n\n### The `verbs` option\n\n`verbs` is a list of verbs to choose from when slapping people. If set, it\noverrides the default list.\n\nProbably the easiest way to make a custom list is to just press Enter twice\nwhen the config wizard asks for a list of verbs, which will add the default\nlist to your bot's `.cfg` file. Then you can use your favorite text editor.\n\n_(We're aware that Sopel's wizard doesn't have great UX when it comes to\nentering lists. It'll get worked on someday, probably.)_\n\n### The `reflexive` option\n\n`reflexive` is the pronoun the bot uses when someone with authorization does\n`.slap BotNick`. By default, this is set to \"itself\".\n\n## Commands\n\n<dl>\n <dt>.slap</dt>\n <dd>Make the bot slap you</dd>\n\n <dt>.slap nickname [reason]</dt>\n <dd>Slap someone else, with an optional reason</dd>\n</dl>\n\n_If your bot has a non-default `prefix`, substitute it for `.` above._\n\n## Credits\n\nThis is based on [the original `slap.py`][original-slap.py] by Michael Yanovich\nfrom [sopel-extras][], dating back to the late '00s/early '10s. It's been\nrewritten more or less from scratch to do things in the modern Sopel way. The\nonly meaningful behavior change was dropping substitution of the caller's nick\nfor `me` and `myself`, as it's quite possible for a real person to use either of\nthose as a nick and _no one_\\* should be safe from slaps!\n\n\\* \u2014 No one except the bot and its admins, that is.\n\n[original-slap.py]: https://github.com/sopel-irc/sopel-extras/blob/81ee756223474cacdac6f5847772d6085d006a50/slap.py\n[sopel-extras]: https://github.com/sopel-irc/sopel-extras\n",
"bugtrack_url": null,
"license": "EFL-2.0",
"summary": "Plugin for Sopel that lets users slap each other in fun ways",
"version": "0.4.1",
"project_urls": {
"Bug Tracker": "https://github.com/sopel-irc/sopel-slap/issues",
"Homepage": "https://github.com/sopel-irc/sopel-slap"
},
"split_keywords": [
"sopel",
" plugin",
" slap",
" pranks",
" bot",
" irc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8ee53b8a8972b91de04c19921c80553fc253b5c477e6df947d3bec191ac9cfd",
"md5": "cc956c533602ee16d1ddef7c16766442",
"sha256": "42b816a89862256e6eefd53910c3eb11afa5f2500c049f3afd6f6a606a238005"
},
"downloads": -1,
"filename": "sopel_slap-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc956c533602ee16d1ddef7c16766442",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 5934,
"upload_time": "2024-10-21T17:27:01",
"upload_time_iso_8601": "2024-10-21T17:27:01.660086Z",
"url": "https://files.pythonhosted.org/packages/b8/ee/53b8a8972b91de04c19921c80553fc253b5c477e6df947d3bec191ac9cfd/sopel_slap-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "32e9bc764a664afed2a2b57e7e92db1f73965aa69fe23b39b80f7ccc8d05a9cf",
"md5": "f00cc3eaf5e05e4098acc219648ce47e",
"sha256": "318fbe518f3f89089aa5866a15c8a66e195f996230958edec862c902890709f1"
},
"downloads": -1,
"filename": "sopel_slap-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "f00cc3eaf5e05e4098acc219648ce47e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 5532,
"upload_time": "2024-10-21T17:27:02",
"upload_time_iso_8601": "2024-10-21T17:27:02.595084Z",
"url": "https://files.pythonhosted.org/packages/32/e9/bc764a664afed2a2b57e7e92db1f73965aa69fe23b39b80f7ccc8d05a9cf/sopel_slap-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 17:27:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sopel-irc",
"github_project": "sopel-slap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sopel-slap"
}
JSON
