Add irc bots RFC to draft

This commit is contained in:
Robert Miles 2018-08-29 23:27:46 -04:00
parent e487929503
commit 6b1867bc9d
1 changed files with 34 additions and 0 deletions

34
draft-ircbots.md Normal file
View File

@ -0,0 +1,34 @@
---
title: Standardising IRC Bot Behavior
author: Robert Miles <khuxkm@tilde.team>
status: Proposed
---
## Abstract {#abstract}
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.
### `!botlist` command {#botlist}
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://git.tildeverse.org/khuxkm/minerbot2), my personal IRC bot)
- 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](http://tilde.town/wiki/bots/ircbots.html), bots SHOULD also respond to `!rollcall` with at least the command list.
## Procedural Information {#procedures}
### Security Considerations {#security}
There are no security considerations to this document.
### Configuration Considerations {#config}
IRC bots on tilde.chat MUST be updated to follow the botlist convention.
For bots on tilde.chat coming from tilde.town, maintainer info must be added, as well as an alias from "!botlist" to "!rollcall".