diff --git a/develop/advanced_plugin_config.rst b/develop/advanced_plugin_config.rst index 9b3009e..baacb82 100644 --- a/develop/advanced_plugin_config.rst +++ b/develop/advanced_plugin_config.rst @@ -418,6 +418,8 @@ Note that we initialize it just the same as we do any other registry type, with two arguments: the default value, and then the description of the config variable. +.. _configuration-hooks: + Configuration hooks =================== diff --git a/develop/events.rst b/develop/events.rst new file mode 100644 index 0000000..57ba839 --- /dev/null +++ b/develop/events.rst @@ -0,0 +1,20 @@ +*************** +Catching events +*************** + +This page is a non-exhaustive list of catchable +events via plugin methods (other events include +:ref:`configuration hooks ` and +:ref:`HTTP server callbacks `) + +Commands and numerics +===================== + +You can catch commands directly with “do-methods”: when the bot receives a +``PRIVMSG``, all ``doPrivmsg`` methods are called; when it gets a ``437`` +message, all ``do437`` methods are called, etc. + +Those command take two commands: an :ref:`Irc object ` +and a :ref:`IrcMsg object `. + +To get a list of all possible messages, check IRC RFCs. diff --git a/develop/httpserver.rst b/develop/httpserver.rst index 030e34f..4096cb4 100644 --- a/develop/httpserver.rst +++ b/develop/httpserver.rst @@ -1,3 +1,5 @@ +.. _http_plugins: + ******************************************** Using Limnoria's HTTP server in your plugins ******************************************** diff --git a/develop/index.rst b/develop/index.rst index 83739b0..99fc430 100644 --- a/develop/index.rst +++ b/develop/index.rst @@ -23,6 +23,7 @@ Specific documentation :maxdepth: 2 using_utils.rst + events.rst httpserver.rst Library reference