Add README.md

This commit is contained in:
2026-03-27 06:26:37 +00:00
parent a461b0d8ea
commit 5b615e2021

27
README.md Normal file
View File

@@ -0,0 +1,27 @@
# PollChat
An async IRC poll bot written in Python with no external dependencies.
## Commands
| Command | Description |
|---|---|
| `.poll` | Show the current active poll |
| `.poll <question> \| <a>, <b>, ...` | Create a new poll |
| `.vote <letter>` | Vote for an option |
| `.vote <letter> <text>` | Vote "other" with a custom response |
| `@polls` | Show help menu |
## Features
- Colored bar graph results with per-option vote percentages
- Every poll gets an "other" option automatically — players can add custom answers that become voteable options
- One custom answer per person, max 10 custom options per poll
- Empty custom options are removed when all voters leave them
- 10 minute cooldown between new polls
- 3 second per-user command cooldown
- Nicks and messages containing "pizza" are ignored
- IRC formatting (colors, bold, underline, italic) allowed in questions and answers
- Unicode is blocked, only ASCII + emojis allowed
- Poll questions max 100 chars, options max 20 chars
- Auto-reconnect on disconnect