rfcs/rfcs/rfc2.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

2018-08-29 21:27:46 -06:00
---
title: Standardising IRC Bot Behavior
author: Robert Miles <khuxkm@tilde.team>
2018-09-26 14:24:30 -06:00
status: Accepted
2018-09-07 12:56:21 -06:00
number: 2
2018-08-29 21:27:46 -06:00
---
2019-06-19 17:10:32 -06:00
## Abstract
2018-08-29 21:27:46 -06:00
2019-06-19 17:41:45 -06:00
IRC bots are programs that communicate with users through Internet Relay Chat.
These bots can do a wide assortment of things, from getting weather information
to running games. We accept IRC bots on tilde.chat, but we ask that any
prospective bot operator follow these rules.
2018-08-29 21:27:46 -06:00
2019-06-19 17:10:32 -06:00
### `!botlist` command
2018-08-29 21:27:46 -06:00
The botlist command is our answer to not knowing the functions a bot provides.
2019-06-19 17:41:45 -06:00
All conformant bots MUST respond to `!botlist` with: (examples from
[minerbot2](https://tildegit.org/khuxkm/minerbot2), my personal IRC bot)
2018-08-29 21:27:46 -06:00
- Maintainer (e.x.; "Maintainer: khuxkm@tilde.team")
2019-06-19 17:41:45 -06:00
- Small description (optional) (e.x.; "A utility bot that does some other cool
things too!")
2018-08-29 21:27:46 -06:00
- Command list (e.x; "Commands: !foo !bar")
2019-06-19 17:41:45 -06:00
For conformance with [previous standards on other tilde
boxes](https://tilde.town/wiki/socializing/irc/list-of-bots.html), bots SHOULD
also respond to `!rollcall` with at least the command list.
2018-08-29 21:27:46 -06:00
2019-06-19 17:41:45 -06:00
Please note that the prefix of `!` is constant: no matter the usual prefix of
the bot, it MUST respond to `!botlist` and/or `!rollcall` with the given prefix.
2018-09-02 09:37:38 -06:00
### Usermode +B
2019-06-19 17:41:45 -06:00
All bots on tilde.chat MUST set usermode +B on or near connect.
2018-09-02 09:37:38 -06:00
2019-06-19 17:10:32 -06:00
## Procedural Information
2018-08-29 21:27:46 -06:00
2019-06-19 17:10:32 -06:00
### Security Considerations
2018-08-29 21:27:46 -06:00
There are no security considerations to this document.
2019-06-19 17:10:32 -06:00
### Configuration Considerations
2018-08-29 21:27:46 -06:00
2019-06-19 17:41:45 -06:00
IRC bots on tilde.chat MUST be updated to follow the botlist convention and set
usermode +B on connect.
2018-08-29 21:27:46 -06:00
2019-06-19 17:41:45 -06:00
For bots on tilde.chat coming from tilde.town, maintainer info must be added,
as well as an alias from "!botlist" to "!rollcall".
2018-09-02 09:38:56 -06:00
Bots made with [teambot](https://tildegit.org/team/teambot) will be updated to set usermode +B.