From 6b1867bc9d08dd7c54f11921c0e166808cf53438 Mon Sep 17 00:00:00 2001 From: khuxkm Date: Wed, 29 Aug 2018 23:27:46 -0400 Subject: [PATCH 1/7] Add irc bots RFC to draft --- draft-ircbots.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 draft-ircbots.md diff --git a/draft-ircbots.md b/draft-ircbots.md new file mode 100644 index 0000000..7e46fdf --- /dev/null +++ b/draft-ircbots.md @@ -0,0 +1,34 @@ +--- +title: Standardising IRC Bot Behavior +author: Robert Miles +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". From bfd88f713ef77a28c706f7d4b3dc61c389ea58ea Mon Sep 17 00:00:00 2001 From: khuxkm Date: Sun, 2 Sep 2018 11:37:38 -0400 Subject: [PATCH 2/7] Add usermode +B requirement --- draft-ircbots.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/draft-ircbots.md b/draft-ircbots.md index 7e46fdf..0c69b98 100644 --- a/draft-ircbots.md +++ b/draft-ircbots.md @@ -21,6 +21,10 @@ All conformant bots MUST respond to `!botlist` with: (examples from [minerbot2]( 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. +### Usermode +B + +All bots on tilde.chat must set usermode +B on or near connect. + ## Procedural Information {#procedures} ### Security Considerations {#security} From 928cc10ee8e7247bb8d2350b33cd135bf2f64ed0 Mon Sep 17 00:00:00 2001 From: khuxkm Date: Sun, 2 Sep 2018 11:38:56 -0400 Subject: [PATCH 3/7] Add config consideration --- draft-ircbots.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/draft-ircbots.md b/draft-ircbots.md index 0c69b98..7a49e14 100644 --- a/draft-ircbots.md +++ b/draft-ircbots.md @@ -33,6 +33,8 @@ There are no security considerations to this document. ### Configuration Considerations {#config} -IRC bots on tilde.chat MUST be updated to follow the botlist convention. +IRC bots on tilde.chat MUST be updated to follow the botlist convention and set usermode +B on connect. For bots on tilde.chat coming from tilde.town, maintainer info must be added, as well as an alias from "!botlist" to "!rollcall". + +Bots made with [teambot](//git.tildeverse.org/team/teambot) will be updated to set usermode +B. From 315660ae756e32010ed5d449b2d1e0c1d9078635 Mon Sep 17 00:00:00 2001 From: khuxkm Date: Fri, 7 Sep 2018 14:56:21 -0400 Subject: [PATCH 4/7] Assign RFC number 2 to draft-ircbots --- draft-ircbots.md => rfc2.md | 1 + 1 file changed, 1 insertion(+) rename draft-ircbots.md => rfc2.md (99%) diff --git a/draft-ircbots.md b/rfc2.md similarity index 99% rename from draft-ircbots.md rename to rfc2.md index 7a49e14..1f34da4 100644 --- a/draft-ircbots.md +++ b/rfc2.md @@ -2,6 +2,7 @@ title: Standardising IRC Bot Behavior author: Robert Miles status: Proposed +number: 2 --- ## Abstract {#abstract} From 74d533473b11c903e0fd67727ca0ccdaad2b9bcf Mon Sep 17 00:00:00 2001 From: khuxkm Date: Fri, 7 Sep 2018 15:03:35 -0400 Subject: [PATCH 5/7] Add clarification on requiring ! prefix for botlist and rollcall --- rfc2.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rfc2.md b/rfc2.md index 1f34da4..39544e6 100644 --- a/rfc2.md +++ b/rfc2.md @@ -22,6 +22,8 @@ All conformant bots MUST respond to `!botlist` with: (examples from [minerbot2]( 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. +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. + ### Usermode +B All bots on tilde.chat must set usermode +B on or near connect. From 1284cf77a2268857976be3c8830193eeaa980123 Mon Sep 17 00:00:00 2001 From: khuxkm Date: Fri, 7 Sep 2018 15:32:06 -0400 Subject: [PATCH 6/7] Convert git.tildeverse.org to tildegit.org and fix formatting --- rfc2.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rfc2.md b/rfc2.md index 39544e6..db6b91b 100644 --- a/rfc2.md +++ b/rfc2.md @@ -14,13 +14,13 @@ follow these rules. 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) +All conformant bots MUST respond to `!botlist` with: (examples from [minerbot2](https://tildegit.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. +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. 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. @@ -40,4 +40,4 @@ IRC bots on tilde.chat MUST be updated to follow the botlist convention and set For bots on tilde.chat coming from tilde.town, maintainer info must be added, as well as an alias from "!botlist" to "!rollcall". -Bots made with [teambot](//git.tildeverse.org/team/teambot) will be updated to set usermode +B. +Bots made with [teambot](https://tildegit.org/team/teambot) will be updated to set usermode +B. From 35a12addc40dfcd0bf4b002156274a1fff7a1002 Mon Sep 17 00:00:00 2001 From: khuxkm Date: Wed, 26 Sep 2018 16:24:30 -0400 Subject: [PATCH 7/7] Mark as accepted --- rfc2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rfc2.md b/rfc2.md index db6b91b..c044742 100644 --- a/rfc2.md +++ b/rfc2.md @@ -1,7 +1,7 @@ --- title: Standardising IRC Bot Behavior author: Robert Miles -status: Proposed +status: Accepted number: 2 --- ## Abstract {#abstract}