soter

command module
v0.0.0-...-800829f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 12, 2021 License: MIT Imports: 10 Imported by: 0

README

Soter - An IRC Bot, Protector of channels

From the Greek god Soter

Soter (Σωτήρ "Saviour, Deliverer") was the personification or daimon of safety, preservation and deliverance from harm.

And so Soter is an IRC Bot that preserves and protects IRC Channels.

Requirements

The main requirement of Soter is simply that is has IRC Operator privileges on the server/network is it used on. On most IRCD(s) (IRC Server software) this is called an O-line. Please make sure it has one!

Installation

$ go get git.mills.io/prologic/soter

Getting Started

Simply run soter:

$ ./soter

How it works

  • Soter will connect to a configured server.
  • Upon successfully connection, Soter will "Oper" up.
  • When Soter is invited to a channel; it will immediately join.
  • When Soter joins a channel for the first time it "Ops" itself.
  • Soter then maintains a persistent "memory" of the channel's topic and modes.
  • Soter will also maintain channel operators in the case of disruption.
  • cadmus -- an IRC Bot written in Go that logs IRC Channels and provides an interface to view and search those logs
  • eris -- a modern IRC Server / Daemon written in Go that has a heavy focus on security and privacy

License

Soter is licensed under the MIT License.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL