calculon-web

A collection of web plugins for Calculon
README

Library for writing IRC bots in OCaml, a collection of plugins, and a dramatic robotic actor.
The core library is called calculon.

Build

make build

Introduction to the Code

Let's assume calculon is loaded, via:

# #require "calculon";;

Main

The typical main entry point would look like this.
Calculon works by gathering a list of
plugins (see the module Plugin), some configuration (see Config)
and running the package in a loop using irc-client.


module C = Calculon

let plugins : C.Plugin.t list = [
  C.Plugin_social.plugin;
  C.Plugin_factoids.plugin;
  (* etc. *)
]

let () =
  let conf = C.Config.of_argv () in
  C.Run_main.main conf plugins |> Lwt_main.run

Plugins

A plugin contains a set of commands.
A command is is a rule that matches a IRC message with some regex, and decides
whether or not to fire with a reply. They are defined in the module Command.

For instance, the following module will reply to messages
starting with !hello by replying "hello <sender>". This is a simple
command, as the function Command.make_simple indicates: it returns a string option to indicate whether or not to respond to any line starting with
!prefix. More elaborate commands are possible using Command.make.


open Calculon

let cmd_hello : Command.t =
  Command.make_simple ~descr:"hello world" ~cmd:"hello" ~prio:10
    (fun (input_msg:Core.privmsg) _ ->
       let who = input_msg.Core.nick in
       Lwt.return (Some ("hello " ^ who))
    )

let plugin_hello : Plugin.t = Plugin.of_cmd cmd_hello

Basic plugins are stateless, built from one or more commands with Plugin.of_cmd
and Plugin.of_cmds.
Other plugins can be stateful (typically, they can have some persistent
state, or more "custom" schemes).
The constructor Plugin.stateful is used to make such plugins.
All the persistent state is stored in a single json file.

See for instance the existing plugins Plugin_factoids and Plugin_movie
to see how to use Plugin.stateful.

Install
Published
25 Feb 2019
Maintainers
Sources
v0.4.tar.gz
md5=e53363833b7e3620a2ce7ffb9a27715d
sha512=c997fd52fd277e8a2d50f266f12182afa96f72bb2f161a6ac1b3372fc9ebbcc12c7593f90cbb5873456b8b96d3488e5c52d071723bbaa05097710d643241d70b
Dependencies
Reverse Dependencies