Metadata-Version: 2.4
Name: versecbot_reaction_limiter
Version: 0.2.0
Summary: VerSecBot plugin to restrict reactions based on user roles.
Project-URL: Homepage, https://github.com/Museus/versecbot-ReactionLimiter
Project-URL: Issues, https://github.com/Museus/versecbot-ReactionLimiter/issues
Author-email: Museus <versecbot@museus.dev>
License-Expression: MIT
License-File: LICENSE.md
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: discord-py<3,>=2
Requires-Dist: pydantic-settings<3,>=2
Requires-Dist: versecbot-interface>=0.4.0
Provides-Extra: qa
Requires-Dist: pytest; extra == 'qa'
Requires-Dist: pytest-mock; extra == 'qa'
Requires-Dist: ruff; extra == 'qa'
Requires-Dist: tomli; extra == 'qa'
Description-Content-Type: text/markdown

# VerSecBot - Reaction Limiter

This plugin instructs VerSecBot to only allow specific roles to add message reactions in a given channel. If a user without a matching role tries to react, VerSecBot will remove the reaction.

This was created to allow public polls with a subset of voters.

To use it, install the package and add the following block to your configuration, replacing values in <> with your desired values:

```
    [versecbot.plugins.reaction_limiter]
        enabled = true

    [[versecbot.plugins.reaction_limiter.handlers]]
        enabled = true
        channel_ids = [list of channels that should be restricted]
        roles_required = [list of roles that can react in specified channels]

    [[versecbot.plugins.reaction_limiter.handlers]]
        enabled = true
        channel_ids = [list of channels that should be restricted]
        roles_required = [list of roles that can react in specified channels]

```
