Skip to content

Commit

Permalink
Revert "Delete readme.md"
Browse files Browse the repository at this point in the history
This reverts commit 731f9d9.
  • Loading branch information
advaith1 committed Feb 6, 2019
1 parent 37e1aac commit 9dc80b6
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions Utilities/Poll Commands/readme.md
@@ -0,0 +1,49 @@
---
title: Poll Commands
permalink: /Utilities/PollCommands
---

# Poll System
This guide will teach you how to set up the Poll System, developed by TheRoboticon.

## Guide Markdown:
We assume that you are using the default command prefix, ``?``. Inputs will be written as ``[input]``. Choice inputs will be denoted as ``[input1/input2]``, respectively.

## Requirements
- A Channel to post important things in. We've called this channel ``#info-and-news``, but you can call it whatever you want- just edit the command as well.
- Two Voting Roles, ``Option1`` and ``Option2``. Again, you can name it whatever you want, just make sure to modify the command appropriately.
- A Moderator Role. In the current code, we used Moderator as our role name.

## List of Commands and Permissions

- ``?poll`` (Requires: Moderator)
- ``?op1`` and ``?op2``
- ``?pollcount`` (Requires: Moderator)
- ``?pollclose`` (Requires: Moderator)

## Command Use and Syntax

- ``?poll`` creates a new poll in your announcements channel.
- Use the format ``?poll [option one] [option two] [question]``
- For example, the poll 'Do you like Sandwiches?' would be written as follows: ``?poll Yes No Do you like Sandwiches?``

- ``?op1`` and ``?op2`` are the two voting commands.
- Following the example above, a user that enjoys sandwiches would type ``?op1`` to vote Yes.
- Note that once someone has voted, they cannot change their choice- the command will not work for them until you have closed the poll.

- ``?pollcount`` posts the current poll results in the channel you use it in.
- This will show the members of the two roles, ``Option1`` and ``Option2``.
- In rare cases there may be too many members to show in the list. For this, use the default command ``?roleinfo [option1/option2]``.

- ``?pollclose`` ends the current poll and removes all users from the roles ``Option1`` and ``Option2``, then announces the result.
- Use the format ``?pollclose [results]``
- For example, if most people voted yes for Sandwiches, you would might say ``?pollclose Looks like y'all like Sandwiches!``
- Note that the bot will also output a message noting the roles that are being removed. This is normal- you can use this command in a separate channel to hide the output.

## Conclusion

Congratulations on installing the new Poll Command system! Maybe you could ask your server members if they enjoy sandwiches as your first poll?

Hopefully this guide was helpful (*It better be, I spent a good 30 minutes on it*). If you have any questions, head over to the Dyno Custom Command server and ask the support staff for help, and we'll gladly help you through the process.

*This guide was written by TheRoboticon*

0 comments on commit 9dc80b6

Please sign in to comment.