rfcs/rfcs/rfc2.md

44 lines
1.7 KiB
Markdown
Raw Normal View History

2018-08-30 03:27:46 +00:00
---
title: Standardising IRC Bot Behavior
author: Robert Miles <khuxkm@tilde.team>
2018-09-26 20:24:30 +00:00
status: Accepted
2018-09-07 18:56:21 +00:00
number: 2
2018-08-30 03:27:46 +00:00
---
2019-06-19 23:10:32 +00:00
## Abstract
2018-08-30 03:27:46 +00: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.
2019-06-19 23:10:32 +00:00
### `!botlist` command
2018-08-30 03:27:46 +00:00
The botlist command is our answer to not knowing the functions a bot provides.
All conformant bots MUST respond to `!botlist` with: (examples from [minerbot2](https://tildegit.org/khuxkm/minerbot2), my personal IRC bot)
2018-08-30 03:27:46 +00:00
- Maintainer (e.x.; "Maintainer: khuxkm@tilde.team")
- Small description (optional) (e.x.; "A utility bot that does some other cool things too!")
- Command list (e.x; "Commands: !foo !bar")
For conformance with [previous standards on other tilde boxes](https://tilde.town/wiki/bots/ircbots.html), bots SHOULD also respond to `!rollcall` with at least the command list.
2018-08-30 03:27:46 +00: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 15:37:38 +00:00
### Usermode +B
All bots on tilde.chat must set usermode +B on or near connect.
2019-06-19 23:10:32 +00:00
## Procedural Information
2018-08-30 03:27:46 +00:00
2019-06-19 23:10:32 +00:00
### Security Considerations
2018-08-30 03:27:46 +00:00
There are no security considerations to this document.
2019-06-19 23:10:32 +00:00
### Configuration Considerations
2018-08-30 03:27:46 +00:00
2018-09-02 15:38:56 +00:00
IRC bots on tilde.chat MUST be updated to follow the botlist convention and set usermode +B on connect.
2018-08-30 03:27:46 +00: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 15:38:56 +00:00
Bots made with [teambot](https://tildegit.org/team/teambot) will be updated to set usermode +B.