kameloso

kameloso is an IRC bot based on mixins and UDAs.

See the kameloso.plugins package for available plugins.

Additionally, see the homepage at https://github.com/zorael/kameloso for help on getting started.

Modules

common
module kameloso.common

Common functions used throughout the program, generic enough to be used in several places, not fitting into any specific one.

config
module kameloso.config

Functionality related to configuration; verifying it, correcting it, reading it from/writing it to disk, and parsing it from command-line arguments.

configreader
module kameloso.configreader

Functions related to reading from a configuration file, broken out of kameloso.config to avoid cyclic dependencies.

constants
module kameloso.constants

A collection of constants used throughout the program.

entrypoint
module kameloso.entrypoint

Dummy main module so all the real files get tested by dub.

irccolours
module kameloso.irccolours

Functions related to IRC colouring and formatting; mapping it to ANSI terminal such, stripping it, etc.

kameloso
module kameloso.kameloso

Module for the main Kameloso instance struct.

logger
module kameloso.logger

Contains the custom KamelosoLogger class, used to print timestamped and (optionally) coloured logging messages.

main
module kameloso.main

The main module, housing startup logic and the main event loop.

messaging
module kameloso.messaging

Functions used to send messages to the server.

net
module kameloso.net

Functionality related to connecting to a server over the Internet.

platform
module kameloso.platform

Functions that deal with OS- and/or platform-specifics.

plugins
module kameloso.plugins

Bits and bobs to register plugins to be instantiated on program startup/connect.

pods
module kameloso.pods

POD structs, broken out of kameloso.kameloso to avoid cyclic dependencies.

printing
module kameloso.printing

Functions related to (formatting and) printing structs and classes to the local terminal, listing each member variable and their contents in an easy-to-visually-parse way.

semver
module kameloso.semver

SemVer information about the current release.

ssldownloads
module kameloso.ssldownloads

Bits and bobs that automate downloading SSL libraries and related necessities on Windows.

string
module kameloso.string

Various functions that do string manipulation.

terminal
module kameloso.terminal

Helpers to set up a terminal environment.

thread
module kameloso.thread

Structures and functions related to concurrency message passing, threads and Fibers.

time
module kameloso.time

Various functions that deal with Durations.

traits
module kameloso.traits

Various traits that are too kameloso-specific to be in lu.

Meta