An IRC bot for learning, fun and collaboration in the Freepost community.

fr33domlover c36fc8ef90 Move shortcuts from JSON to DB 4 days ago
config c36fc8ef90 Move shortcuts from JSON to DB 4 days ago
src c36fc8ef90 Move shortcuts from JSON to DB 4 days ago
state-default c36fc8ef90 Move shortcuts from JSON to DB 4 days ago
util ea6b0678b1 fix error in run.sh script! 2 years ago
.gitignore 46cf4f38fd Build with stack and LTS-5.8 1 year ago
AUTHORS 099c64200e Update AUTHORS file, been getting contributions recently :) 5 months ago
COPYING ff77faba78 add aux files 2 years ago
ChangeLog ff77faba78 add aux files 2 years ago
INSTALL.md 77da8c4285 fix typo. closes #55 11 months ago
NEWS.md 092cebadc6 Release 0.5 1 year ago
README.md 66b0907eb1 Fix lines length to 79-chars and add reference to !get command. 5 months ago
Setup.hs ff77faba78 add aux files 2 years ago
funbot.cabal 976c5becba Dispatch memos only when a user says something 3 months ago
stack.yaml b3f4e32731 Remove old unused extra-deps from stack.yaml 3 months ago

README.md

funbot

FunBot is an IRC bot written in Haskell. This is a fun and interactive way to learn and experiment with Haskell, quickly seeing the results of the code you write. The project was started after an idea was brought up in #freepost channel: Write a bot collaboratively, the whole community together. Experiment, learn and laugh in the process.

FunBot is free software, and is committed to software freedom and to freedom in general. It is released to the public domain using the CC0 Public Domain Dedication. See COPYING.

Cheatsheet

  • !repo+ <host> <username> <repo> <channel>: Add repo. Example: !repo+ notabug fr33domlover funbot #freepost
  • !repo- <host> <username> <repo>: Remove repo
  • !spec+ <host> <username> <repo> <channel>: Add another channel where git repo events will be announced. This must be used after a repo has already been added with !repo+.
  • !spec- <host> <username> <repo> <num>: Remove git event announcement specification with the given index number (as found in the settings tree, i.e. starting from 1) from the given repo. See also !spec+. Note: To see the "settings tree" use the !get command, for example !get repos.notabug.fr33domlover/funbot.
  • !tell <nick>[:|,] <text>: Private memo to user
  • !ctell <nick>[:|,] <text>: Public memo (in channel) to user. Bot will speak in the channel where the command was issued.
  • !join <channel>: Make funbot join a channel (requires privileges).
  • !leave <channel>: Make funbot part a channel (requires privileges).

Using

See the .cabal file for more info and link to project website and version control.

The official download location is the Git repository:

https://notabug.org/fr33domlover/funbot.git

Occasionally, releases may be made to Hackage, the Haskell package repository. See http://hackage.haskell.org/package/funbot.

Some of the dependency libraries may have recent features not released to Hackage yet. See the guide linked at the bottom for their clone URLs. If you use a released version of funbot, you can safely install all the dependencies from Hackage as usual.

This program is free software, released to the public domain using the CC0 Public Domain Dedication. For the boring "legal" details see the file COPYING.

See the file INSTALL.md for a detailed usage and deployment guide. The file ChangeLog explains how to see the history log of the changes done in the code. NEWS.md provides a friendly overview of the changes for each release.

Reporting Bugs and Suggesting Features

If you found a bug, or you have an idea, a feature request or a wishlist item, open a ticket for it! Even if you're goint to implement something or try to solve it.

Use NotABug's issue system.

User/Contributor Guide

There is a detailed guide for running the bot and creating a development setup. It's in the INSTALL.md file.

If you're going to implement some feature or fix some bug you found, start by opening an issue so that other people will know which features are being developed and who does what.