Skip to content

Latest commit

 

History

History
72 lines (61 loc) · 2.21 KB

README.md

File metadata and controls

72 lines (61 loc) · 2.21 KB
Raw

Votebot

An IRC bot for voting.

What does it do? It's counts votes. That is all.

Commands

Admin-Only

  • .clear: Clears all votes
  • .whitelist <nick>: Allows the user with the given nick to vote
  • .join <channel>: The bot will join channel
  • .part <channel>: The bot will leave channel
  • .die: The bot dies
  • .vote-as [nick] [vote]: Vote as another user
  • .rm-vote-as [nick]: Removes the given user's vote

Everybody

  • .votes: Shows the votes
  • .vote <item>: Adds a vote for item
  • .rmvote: Deletes the user's vote
  • .count: Says how many votes there are
  • .whodunnit [item]: Says who voted for that item
  • .whosvoted: Lists all the people who have voted
  • .whathaveyoudone [nick]: Says what the user voted for
  • .rapsheet: Lists every item and who has voted for it (one per message)

"Responses" (<nick>: <message>)

  • "hello": Replies "Hello, "
  • "beep": Replies "boop"
  • "help": Lists summary of commands

##Dependencies

  • Java 1.6 or greater (required for clojure)
  • Clojure
  • Leiningen
  • PostgreSQL

Setup

To get Votebot running, you're going to need to set up a PostgreSQL database for it.

varchar fields should be at least 30 characters long. Any longer than 30 characters will not hurt, but additional spaces will be wasted.

It should:

  • Have two tables, users and votes
    • users should have two fields:
      • id (SERIAL PRIMARY KEY)
      • nick (TEXT NOT NULL)
    • votes should have three fields:
      • id (SERIAL PRIMARY KEY)
      • users_id (INTEGER NOT NULL)
      • item (TEXT NOT NULL)
      • old (BOOLEAN NOT NULL DEFAULT false)

Configuration

The bot requires a file named settings.json. I have included an example file called settings-example.json.

  • "bot_nick": Bot's nick
  • "bot_pass": Bot's password
  • "server": IRC server to connect to
  • "port": Port to connect to the IRC server on
  • "master": The nick of the user to consider "master"
  • "channels": An array of channels to join
  • "db-name": PostgreSQL database name
  • "db-user": User with access to the database
  • "db-pass": Password for user to access the database

Running

Ensure that postgreSQL is working correctly then in the votebot folder run:

 lein run