discord-haskell: Write bots for Discord in Haskell

[ library, mit, network, program ] [ Propose Tags ]

Functions and data types to write discord bots. Official discord docs https://discord.com/developers/docs/reference.

See the project readme for quickstart notes https://github.com/discord-haskell/discord-haskell#discord-haskell-


[Skip to Readme]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.5.0, 0.5.1, 0.6.0, 0.7.0, 0.7.1, 0.8.0, 0.8.1, 0.8.2, 0.8.3, 0.8.4, 1.0.0, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.2.0, 1.3.0, 1.4.0, 1.5.0, 1.5.1, 1.5.2, 1.6.0, 1.6.1, 1.7.0, 1.8.0, 1.8.1, 1.8.2, 1.8.3, 1.8.4, 1.8.5, 1.8.6, 1.8.7, 1.8.8, 1.8.9, 1.9.0, 1.9.1, 1.9.2, 1.10.0, 1.11.0, 1.12.0, 1.12.1, 1.12.2, 1.12.3, 1.12.4, 1.12.5, 1.13.0, 1.14.0, 1.15.0, 1.15.1, 1.15.2, 1.15.3
Change log changelog.md
Dependencies aeson (>=1.5 && <1.6 || >=2.0 && <2.2), async (>=2.2 && <2.3), base (>=4.14 && <4.18), base64-bytestring (>=1.1 && <1.3), bytestring (>=0.10 && <0.12), containers (>=0.6 && <0.7), data-default (>=0.7 && <0.8), discord-haskell, emoji (>=0.1 && <0.2), http-api-data (>=0.4 && <0.6), http-client (>=0.6 && <0.8), iso8601-time (>=0.1 && <0.2), MonadRandom (>=0.5 && <0.6), mtl (>=2.2 && <2.3), network (>=3.0.0.0 && <3.2.0.0), req (>=3.9 && <3.14), safe-exceptions (>=0.1 && <0.2), scientific (>=0.3 && <0.4), text (>=1.2 && <3), time (>=1.9 && <1.12), unliftio (>=0.2 && <0.3), unordered-containers (>=0.2.10.0 && <0.3), websockets (>=0.12 && <0.13), wuss (>=1.1 && <3) [details]
License MIT
Copyright 2019 Karl
Author Karl
Maintainer ksfish5@gmail.com
Revised Revision 1 made by yutotakano at 2022-09-23T11:32:34Z
Category Network
Home page https://github.com/discord-haskell/discord-haskell
Bug tracker https://github.com/discord-haskell/discord-haskell/issues
Source repo head: git clone https://github.com/discord-haskell/discord-haskell.git
Uploaded by BenjaminMcRae at 2022-09-09T17:54:50Z
Distributions NixOS:1.15.3
Reverse Dependencies 2 direct, 0 indirect [details]
Executables state-counter, rest-without-gateway, gateway, cache, interaction-commands, ping-pong
Downloads 16360 total (190 in the last 30 days)
Rating 2.5 (votes: 6) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2022-09-23 [all 3 reports]

Readme for discord-haskell-1.15.3

[back to package description]

discord-haskell CI Status Hackage version Discord server

Build that discord bot in Haskell! Also checkout the calamity haskell library for a more advanced interface.

Documentation

[installing] [debugging] [creating-bot]

[app-commands] [components] [cache] [embeds] [emoji] [intents] [voice]

[design] [contributing] [todo]

Example

This is an example bot that replies "pong" to messages that start with "ping". Checkout the other examples for things like state management.

{-# LANGUAGE OverloadedStrings #-}  -- allows "string literals" to be Text
import           Control.Monad (when, void)
import           UnliftIO.Concurrent
import           Data.Text (isPrefixOf, toLower, Text)
import qualified Data.Text.IO as TIO

import           Discord
import           Discord.Types
import qualified Discord.Requests as R

-- | Replies "pong" to every message that starts with "ping"
pingpongExample :: IO ()
pingpongExample = do
    userFacingError <- runDiscord $ def
             { discordToken = "Bot ZZZZZZZZZZZZZZZZZZZ"
             , discordOnEvent = eventHandler
             , discordOnLog = \s -> TIO.putStrLn s >> TIO.putStrLn ""
             } -- if you see OnLog error, post in the discord / open an issue

    TIO.putStrLn userFacingError
    -- userFacingError is an unrecoverable error
    -- put normal 'cleanup' code in discordOnEnd (see examples)

eventHandler :: Event -> DiscordHandler ()
eventHandler event = case event of
    MessageCreate m -> when (isPing m && not (fromBot m)) $ do
        void $ restCall (R.CreateReaction (messageChannelId m, messageId m) "eyes")
        threadDelay (2 * 10^6)
        void $ restCall (R.CreateMessage (messageChannelId m) "Pong!")
    _ -> return ()

fromBot :: Message -> Bool
fromBot = userIsBot . messageAuthor

isPing :: Message -> Bool
isPing = ("ping" `isPrefixOf`) . toLower . messageContent

Discord Server

Ask questions, get updates, request features, etc in the project discord server: https://discord.gg/eaRAGgX3bK

Official Discord Documentation

This api closley matches the official discord documentation, which lists the rest requests, gateway events, and gateway sendables.

You can use the docs to check the name of something you want to do. For example: the docs list a Get Channel API path, which translates to discord-haskell's rest request ADT for GetChannel of type ChannelId -> ChannelRequest Channel.

Open an Issue

If something goes wrong: check the error message (optional: check the debugging logs), make sure you have the most recent version, ask on discord, or open a github issue.