https://github.com/ncfavier/bothendieck

An IRC bot
https://github.com/ncfavier/bothendieck

haskell irc-bot

Last synced: 11 days ago
JSON representation

An IRC bot

• Host: GitHub
• URL: https://github.com/ncfavier/bothendieck
• Owner: ncfavier
• License: isc
• Created: 2022-10-17T23:18:46.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-05T19:17:33.000Z (2 months ago)
• Last Synced: 2024-10-11T23:39:29.693Z (28 days ago)
• Topics: haskell, irc-bot
• Language: Haskell
• Homepage:
• Size: 196 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A simple IRC bot based on the [`irc-client`](https://hackage.haskell.org/package/irc-client) library.

## Features

Each module in [`src/Parts`](https://github.com/ncfavier/bothendieck/tree/main/src/Parts) defines a separate set of features: commands and message handlers. In the following, commands start with a `.`, but this prefix can be [configured](#usage).

- [`URL`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/URL.hs) fetches and posts URL titles.

- [`Eval`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/Eval.hs) provides evaluators for a bunch of languages using [qeval](https://github.com/ncfavier/qeval). Syntax: `LANG> EXPRESSION`. Use `↵` (compose + return) to insert newlines.

- [`Wikimedia`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/Wikimedia.hs) queries information from Wikimedia projects.

  - `.wp ARTICLE` prints a summary of the given article on [Wikipedia](https://en.wikipedia.org), the free encyclopedia.

  - `.wprandom [CATEGORY]` prints a link to a random Wikipedia article.

  - `.wtrandom [CATEGORY|-l LANGUAGE]` prints a link to a random [Wiktionary](https://en.wiktionary.org) entry.

- [`NLab`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/NLab.hs) queries information from the [nLab](https://ncatlab.org), a wiki for higher mathematics.

  - `.nlab SEARCH` searches for a page and prints a link to the first result.

  - `.nlabrandom [CATEGORY]` prints a random page.

- [`MerriamWebster`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/MerriamWebster.hs) queries information from the [Merriam-Webster](https://www.merriam-webster.com) dictionary.

  - `.d[ef[ine]] [-e ENTRY] WORD` queries a word's definition.

  - `.etym[ology] [-e ENTRY] WORD` queries a word's etymology.

- [`Translate`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/Translate.hs) provides translations via [Google Translate](https://translate.google.com/).

  - `.tr[ans[late]] [[SOURCE]:[TARGET]] TEXT` translates `TEXT` from the `SOURCE` to the `TARGET` language, specified as [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166) codes. The default source language is auto-detected, and the default target language is English.

- [`WolframAlpha`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/WolframAlpha.hs) queries [WolframAlpha](https://www.wolframalpha.com) for answers.

  - `.(wa|wolfram[alpha]) QUERY` asks a general question.

  - `.time PLACE` asks for the current time in `PLACE`.

  - `.weather PLACE` asks for the current weather in `PLACE`.

- [`Random`](https://github.com/ncfavier/bothendieck/blob/main/src/Parts/Random.hs) provides random quotes from various sources:

  - `.compliment`: surrealist compliments from the [surrealist compliment generator](http://www.madsci.org/cgi-bin/lynn/jardin/SCG).

  - `.lytt[le|on]`: entries from the [Lyttle Lytton contest](https://adamcadre.ac/lyttle/).

## Usage

With a [flakes-enabled](https://nixos.wiki/wiki/Flakes#Enable_flakes) Nix:

```console

$ nix run github:ncfavier/bothendieck -- -c path/to/config.toml

```

See [`config.sample.toml`](https://github.com/ncfavier/bothendieck/blob/main/config.sample.toml) for inspiration.

You can specify additional configuration files with the `-C` option. This is useful for separating secrets from the main configuration.