Metadata-Version: 2.4
Name: sopel-8ball
Version: 1.0.0
Summary: Magic 8 ball plugin for Sopel
Author-email: dgw <dgw@technobabbl.es>, Florian Strzelecki <florian.strzelecki@gmail.com>
Maintainer-email: Florian Strzelecki <florian.strzelecki@gmail.com>
License-Expression: EFL-2.0
Project-URL: Homepage, https://github.com/Exirel/sopel-8ball
Project-URL: Bug Tracker, https://github.com/Exirel/sopel-8ball/issues
Keywords: sopel,plugin,eight-ball,bot,irc
Platform: Linux x86, x86-64
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX :: Linux
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: Programming Language :: Python :: 3.13
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: <4,>=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: sopel>=8.0
Requires-Dist: importlib-metadata>=8.6
Dynamic: license-file

===========
sopel-8ball
===========

Sopel magic 8 ball plugin::

    <User> .8ball Do you know the future?
    <Sopel> User: You may rely on it.
    <User> .8ball Do you like me?
    <Sopel> User: Better not tell you now.
    <User> .8ball Will I live forever?
    <Sopel> User: Very doubtful.

Install
=======

The preferred way to install this plugin is through ``pip``::

    $ pip install sopel-8ball

Note that you may need to use ``pip3``, depending on your system and your
installation.

Once this is done, you should configure and enable the plugin::

    $ sopel-plugins configure 8ball
    $ sopel-plugins enable 8ball

And then, restart your bot: this, again, depends on your system and how you run
your bot.

Magic 8 ball choices
====================

There are more than one style of choices you can select:

* ``classic``: the classic version (10 yes, 5 maybe, 5 no)
* ``snarky``: this version is rude (5 yes, 5 maybe, 10 no)
* ``spooky``: use at your own risk (5 yes, 10 maybe, 5 no, 100% freaky)
* ``thefrench``: experience French profanity (5 yes, 5 maybe, 5 no,
  100% French)
* ``weeaball``: for japanese style fan ＼(＾▽＾)／ (7 yes, 9 maybe, 7 no,
  100% kaomoji)
* ``yesno``: only "yes" or "no" (1 yes, 0 maybe, 1 no, 100% assertive)

This can be configured with the Sopel configuration wizard::

    $ sopel-plugins configure 8ball

Or manually, by editing your configuration and adding this section::

    [magic8ball]
    choices = classic

Replace ``classic`` (the default) by one of the value above.
