IRC bot in D
To use this package, put the following dependency into your project's dependencies section:
kameloso sits and listens in the channels you specify and reacts to events, like bots generally do.
It is written in D. A variety of features comes bundled in the form of plugins, and it's designed to be very easy to write your own. Any and all ideas welcome.
It works very well with the majority of server networks. IRC is standardised but servers still come in many flavours, where some outright conflict with others. If something doesn't immediately work it's most often an easy issue of specialcasing for that particular IRC network or server daemon.
Current functionality includes:
- bedazzling coloured terminal output like it's the 90s
- automatic mode sets (eg. auto
- looking up titles of pasted web URLs
sed-replacement of the last message sent (
notesto offline users that get played back when they come online
seenplugin; reporting when a user was last seen, written as a rough example plugin
- Reddit post lookup
- Twitch support; Twitch bot is now easy (see notes on connecting below)
- piping text from the terminal to the server (Posix only)
- mIRC colour coding and text effects (bold, underlined, ...), translated into Bash terminal formatting
- SASL authentication (
- configuration stored on file
- the dmd and ldc compilers will segfault if building in anything other than
debugmode (bug #18026, see more on build types below).
- the gdc compiler doesn't yet support
static foreachand thus cannot be used to build this bot.
- some plugins don't yet differentiate between different home channels if there is more than one.
- nicknames are not case-insensitive. The
lowercaseNicknamefunction is written and in place; it's just not yet seeing use. It is a very invasive change, so holding out until we find a use-case.
- IRC server daemons that have not been tested against may exhibit weird behaviour if parsing goes awry. Need concrete examples to fix; please report errors and abnormalities.
Use on networks without services (
AuthServ/...) may be difficult, since the bot identifies people by their account names. You will probably want to register yourself with such, where available.
Testing is primarily done on freenode, so support and coverage is best there.
Table of contents
- Getting started
- How to use
- Debugging and generating unit tests
- Built with
- compiler segfaults are back.
automodesplugin, please test.
printerplugin can now save logs to disk. Regenerate your configuration file and enable it with
true. It can either write lines immediately as they are received, or buffer writes to write with a cadence of once every PING, configured with
bufferedWrites. By default only homes are logged; configurable with the
logAllChannelsknob. Needs testing and feedback.
- all* (non-service) plugins can now be toggled as enabled or disabled in the configuration file. Regenerate it to get the needed entries.
IRCEventhas a new member
count. It houses counts, amounts, the number of times something has happened, and similar numbers. This lets us leave
numalone to its original purpose of specifying numerics.
- Twitch emote highlighting; now uses a
dstringand is seemingly fully accurate.
- Documentation offline until such time Travis manages to compile ddox again. Old links: github.io, dpldocs.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes, as well as general use.
It's possible to build it manually without dub, but it is non-trivial if you want the web-related plugins to work.
GitHub offers downloads in ZIP format, but it's arguably easier to use git and clone a copy of the source that way.
$ git clone https://github.com/zorael/kameloso.git $ cd kameloso
$ dub build
This will compile it in the default
debug build type, which adds some extra code and debugging symbols.
You can automatically strip these and add some optimisations by building it in
dub build -b release. Mind that build times will increase. Refer to the output of
dub build --helpfor more build types.
The above will currently not work, as the compiler will crash on some build configurations under anything other than
Unit tests are built into the language, but you need to compile the project in
unittest mode to include them.
$ dub build -b unittest
The tests are run at the start of the program, not during compilation. You can use the shorthand
dub test to compile with tests and run them in one go.
unittest builds will only run the unit tests and immediately exit.
The available build configurations are:
vanilla, builds without any specific extras
colours, compiles in terminal colours
web, compiles in plugins with web lookup (
colours+web, includes both of the above
posix, default on Posix-like systems, equals
windows, default on Windows, equals
colours+webbut with extra code needed for running it under the default Cygwin terminal (mintty)
You can specify which to compile with the
-c switch. Not supplying one will make it build the default for your operating system.
$ dub build -c cygwin
There are a few Windows caveats.
- Web URL lookup, including the web titles and Reddit plugins, may not work out of the box with secure HTTPS connections due to the default installation of
dlang-requestsnot finding the correct libraries. Unsure of how to fix this. Normal HTTP access should work fine.
- Terminal colours may also not work, depending on your version of Windows and likely your terminal font. Unsure of how to enable this.
- Use in Cygwin terminals without compiling the aforementioned
cygwinbuild configuration will be unpleasant. Normal
cmdand Powershell consoles are not affected and can be used with any configuration.
How to use
The bot needs the services account name of the administrator(s) of the bot, and/or one or more home channels to operate in. It cannot work without having at least one of the two, so you need to generate and edit a configuration file before starting.
$ ./kameloso --writeconfig
Open the new
kameloso.conf in a text editor and fill in the fields. Additional resource files will have been created as well; for instance, see
users.json for where to enter whitelisted (and blacklisted) account names.
If you enter an authentification password (
authPassword) and then regenerate the file, the password will be encoded into Base64 format. Mind that this does not mean it's encrypted! It just makes it less easy to tell what the password is at a mere glance.
Once the bot has joined a home channel, it's ready. Mind that you need to authorise yourself with services with an account listed as an administrator in the configuration file to make it listen to anything you do. Before allowing anyone to trigger any functionality it will look them up and compare their accounts with its white- and blacklists.
$ ./kameloso -s irc.freenode.net -n you -H '#channel' -C '#d' you joined #channel kameloso sets mode +o you you | !say foo kameloso | foo you | foo bar baz you | s/bar/BAR/ kameloso | you | foo BAR baz you | !8ball kameloso | It is decidedly so you | !addquote you This is a quote kameloso | Quote saved. (1 on record) you | !quote you kameloso | you | This is a quote you | !note OfflinePerson Why so offline? kameloso | Note added. you | !seen OfflinePerson kameloso | I last saw OfflinePerson 1 hour and 34 minutes ago. you | kameloso: sudo PRIVMSG #channel :this is a raw IRC command kameloso | this is a raw IRC command you | !bash 85514 kameloso | <Reverend> IRC is just multiplayer notepad. you | https://www.youtube.com/watch?v=s-mOy8VUEBk kameloso | [youtube.com] Danish language you | !reddit https://dlang.org/blog/2018/01/04/dmd-2-078-0-has-been-released/ kameloso | Reddit post: https://www.reddit.com/r/programming/comments/7o2tcw/dmd_20780_has_been_released
help to the bot in a private message for a summary of available bot commands, and
help [plugin] [command] for a brief description of a specific one. Mind that commands defined as regular expressions cannot be shown, due to technical reasons.
The prefix character (here "
!") is configurable; refer to your generated configuration file. Common alternatives are
~, making it
[Core] prefix !
It can technically be any string and not just one character. Enquote it if you want any spaces as part of the prefix token, like
If you have compiled in colours and you have bright terminal background, the colours may be hard to see and the text difficult to read. If so, make sure to pass the
--bright argument, and/or modify the configuration file;
[Core]. The bot uses the entire range of 8-colour ANSI, so if one or more colours are too dark or bright even with the right
brightTerminal setting, please see to your terminal appearance settings. This is not uncommon, especially with backgrounds that are not fully black or white. (read: Monokai, Breeze, Solaris, ...)
[IRCBot] nickname twitchaccount pass oauth:the50letteroauthstringgoeshere homes #twitchaccount channels #streamer1,#streamer2,#streamer3 [IRCServer] address irc.chat.twitch.tv port 6667
pass is not the same as
authPassword. It is supplied very early during login (or registration) to allow you to connect -- even before negotiating username and nickname, which is otherwise the very first thing to happen.
authPassword is something that is sent to a services bot (like
AuthServ) after registration has finished and you have successfully logged onto the server. (In the case of SASL authentication,
authPassword is used during late registration.)
Use as a library
The IRC event parsing bits are largely decoupled from the rest of the program, needing only some helper modules.
Feel free to copy these and drop them into your own project.
Debugging and generating unit tests
Writing an IRC bot when servers all behave differently is a game of whack-a-mole. As such, you may/will come across unexpected events for which there are no rules on how to parse. It may be some messages silently have weird values in the wrong fields (e.g. nickname where channel should go), or be empty when they shouldn't -- or more likely there will be an error message. Please file an issue.
If you're working on developing the bot yourself, you can generate unit test assert blocks for new events by passing the command-line
--asserts flag, specifying the server daemon and pasting the raw line. Copy the generated assert block and place it in
tests/events.d, or wherever is appropriate.
If more state is neccessary to replicate the environment, such as needing things from
RPL_ISUPPORT or a specific resolved server address (from early
RPL_HELLO), paste/fake the raw line for those first and it will inherit the implied changes for any following lines throughout the session. It will print the changes for easier construction of unit tests, so you'll know if you suceeded.
- pipedream zero: no compiler segfaults
- pipedream: DCC
- pipedream two:
- optional formatting in IRC output? (later if at all)
- notes triggers? (later)
seendoing what? channel-split?
- set up a real configuration home like
~/.kameloso? what of Windows?
- automode channel awareness boost
This project is licensed under the MIT license - see the LICENSE file for details.
- Registered by JR
- 1.0.0-rc.2 released 10 months ago
- Copyright © 2018, JR