Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discord-haskell/discord-haskell
Haskell library for writing Discord bots
https://github.com/discord-haskell/discord-haskell
bot discord discord-api haskell-library
Last synced: 15 days ago
JSON representation
Haskell library for writing Discord bots
- Host: GitHub
- URL: https://github.com/discord-haskell/discord-haskell
- Owner: discord-haskell
- License: other
- Created: 2018-06-12T21:47:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T18:30:38.000Z (6 months ago)
- Last Synced: 2024-08-10T11:03:00.208Z (3 months ago)
- Topics: bot, discord, discord-api, haskell-library
- Language: Haskell
- Homepage: https://hackage.haskell.org/package/discord-haskell
- Size: 1.61 MB
- Stars: 264
- Watchers: 11
- Forks: 57
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
- discord-api-libs - discord-haskell - Haskell library for writing Discord bots (Libraries / Haskell)
README
# discord-haskell [](https://github.com/discord-haskell/discord-haskell/actions/) [](https://hackage.haskell.org/package/discord-haskell) [](https://discord.gg/eaRAGgX3bK)
Build that discord bot in Haskell! Also checkout the
[calamity haskell library](https://github.com/nitros12/calamity)
for a more advanced interface.
#### Documentation
#### [[installing](./docs/installing.md)] [[debugging](./docs/debugging.md)] [[creating-bot](./docs/creating-bot.md)]
#### [[app-commands](./docs/applicationcommands.md)] [[components](./docs/components.md)] [[cache](./docs/cache.md)] [[embeds](./docs/embeds.md)] [[emoji](./docs/emoji.md)] [[intents](./docs/intents.md)] [[voice](./docs/voice.md)]
#### [[design](./docs/design.md)] [[contributing](./docs/contributing.md)] [[todo](./docs/todo.md)]
#### Example
This is an example bot that replies "pong" to messages that start with "ping". Checkout the [other examples](./examples/) for things like state management.
```haskell
{-# 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:
#### Official Discord Documentation
This api closley matches the [official discord documentation](https://discord.com/developers/docs/intro),
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](https://discord.com/developers/docs/resources/channel#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](./docs/debugging.md)), make sure you have the most recent version, ask on discord, or open a github issue.