/smartpoll

maubot smart poll

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Smart Poll

A maubot plugin for Matrix, which enables polls in matrix rooms. The polls are text-based, so that they can also be used via bridges.

This repository originates from a forked repository maubot-poll, which is a English translated version of the original maubot-poll by @DrDeee. This bot also learns from Poll Maubot.

Installation

Upload the smartpoll-v0.0.0.mbc file via Maubot user interface. You could generate your own mbc file via mbcbuild.sh script in the source code. Alternatively, you could download the plugin from the Tags.

Usage

  • Create a new poll

    !poll create <question> | <option 1> | <option 2> ...
    
    • Alternatively, a new poll can be created as follows,
      !poll create <question>
      <option 1>
      <option 2>
      ...
      
  • Vote for choice(s)

    There will be emojis 1️⃣, 2️⃣, 3️⃣, etc. attached to the poll from the bot. Users can simply click the emoji to vote for choice(s)

  • Show the result of the poll (creator only)

    !poll result <code>
    
  • Pings all participants who voted for choice (creator only)

    !poll ping <code> <choice>
    
  • Close the result of the poll (creator only)

    !poll close <code>
    

TODO List

  • Add list functionality to list active and/or closed polls
  • Connect with database so that a closed poll result is still accessible
  • Enable result/close/ping without <code> to show the output related to the most recent active poll.
  • Add multiple-choice poll so that only a single choice counts
  • Add private vote functionality so that users can vote in a private room with the bot and the creator can only view the poll results and cannot ping choice.

Contributors

Made with contrib.rocks.