Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.29 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.29 KB
Raw

irc-dcc - A DCC message parsing and helper library for IRC clients

Build Status irc-dcc on Hackage irc-dcc on Stackage Nightly

DCC (Direct Client-to-Client) is an IRC sub-protocol for establishing and maintaining direct connections to exchange messages and files.

See http://www.irchelp.org/irchelp/rfc/ctcpspec.html for more details.

Supported Variants:

  • (Standard) DCC
  • Reverse DCC

Usage

  1. Add irc-dcc to the build-depends section of your .cabal file.
  2. Import Network.IRC.DCC.
    • Parse a CTCP message using runParser and any of the parse* methods exported by this module. If the CTCP message was the desired DCC command, the function will return a Right value.
    • Encode a DCC command by using encodeCtcp function of its CtcpCommand instance.

See this package's documentation on Hackage.

Development

  1. Install Stack.
  2. Run stack build.