kaguya alternatives and similar packages
Based on the "Networking" category.
Alternatively, view kaguya alternatives based on common mentions on social networks and blogs.
-
Ockam
Ockam is a suite of tools, programming libraries and infrastructure that make it easy to build devices that communicate securely, privately and trustfully with cloud services and other devices. -
sshkit
An Elixir toolkit for performing tasks on one or more servers, built on top of Erlang’s SSH application.
Get performance insights in less than 4 minutes
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest. Visit our partner's website for more details.
Do you think we are missing an alternative of kaguya or a related project?
Popular Comparisons
README
Kaguya
A small but powerful IRC bot
Installation
Add kaguya to your list of dependencies in
mix.exs
:def deps do [{:kaguya, "~> x.y.z"}] end
Run
mix deps.get
Ensure kaguya is started before your application:
def application do [applications: [:kaguya]] end
Configure kaguya in config.exs:
config :kaguya, server: "my.irc.server", port: 6666, bot_name: "kaguya", channels: ["#kaguya"]
Usage
By default Kaguya won't do much. This is an example of a module which will perform a few simple commands:
defmodule Kaguya.Module.Simple do
use Kaguya.Module, "simple"
handle "PRIVMSG" do
match ["!ping", "!p"], :pingHandler
match "hi", :hiHandler
match "!say ~message", :sayHandler
end
defh pingHandler, do: reply "pong!"
defh hiHandler(%{user: %{nick: nick}}), do: reply "hi #{nick}!"
defh sayHandler(%{"message" => response}), do: reply response
end
This module defines four commands to be handled:
!ping
and!p
are aliased to the same handler, which has the bot respondpong!
.hi
will cause the bot to reply saying "hi" with the persons' nick!say [some message]
will have the bot echo the message the user gave.
The handler macro can accept up to two different parameters, a map which destructures a message struct, and a map which destructures a match from a command.
You can find a more full featured example in example/basic.ex
.
Configuration
server
- Hostname or IP address to connect with. String.server_ip_type
- IP version to use. Can be eitherinet
orinet6
port
- Port to connect on. Integer.bot_name
- Name to use by bot. String.channels
- List of channels to join. Format:#<name>
. Listhelp_cmd
- Specifies command to act as help. Defaults to.help
. Stringuse_ssl
- Specifies whether to use SSL or not. Booleanreconnect_interval
- Interval for reconnection in ms. Integer. Not used.server_timeout
- Timeout(ms) that determines when server gets disconnected. Integer. When omitted Kaguya does not verifies connectivity with server. It is recommended to set at least few minutes.