|
| 1 | +# @apilium/mayros-irc |
| 2 | + |
| 3 | +Mayros IRC channel plugin -- connect your Mayros agent to IRC networks. |
| 4 | + |
| 5 | +## Installation |
| 6 | + |
| 7 | +```bash |
| 8 | +mayros plugin install @apilium/mayros-irc |
| 9 | +``` |
| 10 | + |
| 11 | +## Configuration |
| 12 | + |
| 13 | +Add to your `mayros.toml`: |
| 14 | + |
| 15 | +```toml |
| 16 | +[channels.irc] |
| 17 | +enabled = true |
| 18 | +host = "irc.libera.chat" |
| 19 | +port = 6697 |
| 20 | +tls = true |
| 21 | +nick = "mayros-bot" |
| 22 | +# username = "mayros" |
| 23 | +# realname = "Mayros Bot" |
| 24 | +# password = "server-password" |
| 25 | +# passwordFile = "/path/to/password" |
| 26 | +# channels = ["#mychannel"] |
| 27 | + |
| 28 | +# DM security |
| 29 | +# dmPolicy = "pairing" # "open" | "pairing" | "allowlist" |
| 30 | +# allowFrom = [] |
| 31 | + |
| 32 | +# Group settings |
| 33 | +# groupPolicy = "allowlist" # "open" | "allowlist" | "disabled" |
| 34 | +# groupAllowFrom = [] |
| 35 | +# historyLimit = 50 |
| 36 | +# textChunkLimit = 350 |
| 37 | +# mediaMaxMb = 10 |
| 38 | + |
| 39 | +# NickServ authentication |
| 40 | +# [channels.irc.nickserv] |
| 41 | +# enabled = true |
| 42 | +# password = "nickserv-password" |
| 43 | +# passwordFile = "/path/to/ns-password" |
| 44 | +# register = false |
| 45 | +# registerEmail = "bot@example.com" |
| 46 | + |
| 47 | +# Per-channel overrides |
| 48 | +# [channels.irc.groups."#mychannel"] |
| 49 | +# requireMention = true |
| 50 | +# enabled = true |
| 51 | + |
| 52 | +# Multi-account support |
| 53 | +# [channels.irc.accounts.secondary] |
| 54 | +# host = "irc.oftc.net" |
| 55 | +# nick = "mayros-alt" |
| 56 | +``` |
| 57 | + |
| 58 | +## Environment Variables |
| 59 | + |
| 60 | +- `IRC_HOST` -- server hostname (default account) |
| 61 | +- `IRC_PORT` -- server port (default account) |
| 62 | +- `IRC_TLS` -- enable TLS (`true`/`false`, default account) |
| 63 | +- `IRC_NICK` -- bot nickname (default account) |
| 64 | +- `IRC_USERNAME` -- IRC username (default account) |
| 65 | +- `IRC_REALNAME` -- IRC real name (default account) |
| 66 | +- `IRC_PASSWORD` -- server password (default account) |
| 67 | +- `IRC_CHANNELS` -- comma-separated channel list (default account) |
| 68 | +- `IRC_NICKSERV_PASSWORD` -- NickServ password (default account) |
| 69 | +- `IRC_NICKSERV_REGISTER_EMAIL` -- NickServ registration email (default account) |
| 70 | + |
| 71 | +## Features |
| 72 | + |
| 73 | +- Direct messages and channel support |
| 74 | +- TLS/SSL connections |
| 75 | +- NickServ authentication and registration |
| 76 | +- Per-channel access control and mention requirements |
| 77 | +- Multi-account support for connecting to multiple networks |
| 78 | +- Media attachments via URL |
| 79 | +- Configurable message chunking for long responses |
| 80 | + |
| 81 | +## License |
| 82 | + |
| 83 | +MIT -- Apilium Technologies |
0 commit comments