tilde.chat/wiki/pages/bots.md

116 lines
5.6 KiB
Markdown
Raw Permalink Normal View History

2018-08-30 05:40:29 +00:00
---
author: ~cmccabe
published: true
2022-02-16 17:57:58 +00:00
title: irc bots on tilde.chat
2018-08-30 05:40:29 +00:00
description: information about irc bots on tilde.chat
category:
- main
---
you might have seen some bots lurking about in chat. this page is intended to be a common place for documentation.
2022-01-16 20:11:20 +00:00
bots should be well-behaved and efficient with system resources. if you see a bot that is not, please remind the botmaster about this and/or notify an admin. naughty bots can make the system less enjoyable for everyone, and we all have to work together to police them.
2018-08-30 05:40:29 +00:00
## rules and etiquette for tilde.chat irc bots
2020-05-15 20:30:52 +00:00
please set usermode +B on your bot on connect to identify it as a bot.
this is also documented in [rfc-2](https://rfc.tildeverse.org/rfcs/2#usermode--b).
2018-08-30 05:40:29 +00:00
your bot must respond to !botlist with the following information:
- your system username (as creator/botmaster) - so we can contact you if the bot misbehaves
- one line description of the bot's functionality
- list of the bots public commands
be conservative about automatically re-connecting to the server or channel.
if your bot's code is not yet stable, keep it in the #bots channel and do testing there.
2019-06-26 15:44:03 +00:00
don't join #chaos or unless you want your bot to be spammed to hell and back.
2022-01-16 20:11:20 +00:00
all bots should also adhere to the following RFC specification: [RFC 2: Standardising IRC Bot Behavior](https://rfc.tildeverse.org/rfcs/2).
2018-08-30 05:40:29 +00:00
## tilde.team bot starter kit
2018-10-15 22:29:34 +00:00
[khuxkm](https://khuxkm.tilde.team) is hard at work developing a starter kit framework in python that you can use to build your own irc bot. find the [source here](https://tildegit.org/team/teambot). it's installed globally on ~team, so get coding!
2018-08-30 05:40:29 +00:00
## add your bot to the list below
follow the example of sedbot when you add your bot in a PR to the wiki
* sedbot
- botmaster: [~ben](https://ben.tilde.team)
- short description: sent a typo in chat? fix it up with a sed expression and sedbot will try to correct it
- list of functions:
+ s/needle/replace/flags
+ most regex character classes match here
+ flags include `g` and `i`
2018-10-15 22:29:34 +00:00
- [source](https://tildegit.org/ben/sedbot)
* tildebot
- botmaster: [~ben](https://ben.tilde.team)
- short description: an instance of BitBot for the tildeverse.
2019-07-09 05:56:53 +00:00
- list of functions:
+ `sed`-like corrections like `sedbot`
+ weather/time per user (`,weather`/`,w`/`,time`)
+ user pronouns: `,pronouns`
+ wolfram alpha integration: `,wa`
+ translation services: `,translate le pain est sale`
+ some per-user configuration available via `,config`
+ git hooks (including gitea) - notifications on push/etc
+ write your own functionality with a plugin!
+ tilderadio notifications and other tilderadio functionality
+ ducc frens (when a duck appears: `,bef`/`,trap`, see stats with `,friends`/`,enemies`/`,duckstats`)
- [BitBot source](https://github.com/jesopo/bitbot), [tildebot-specific modules repo](https://tildegit.org/ben/bitbot-modules)
2019-06-26 15:44:03 +00:00
* tracer
- botmaster: [~ben](https://ben.tilde.team)
- short description: generate tracery output from grammars in you ~/.tracery (on ~team) -
forked and ported from [selfsame/tracer](https://notabug.org/selfsame/tracer) for py3 support
- list of functions:
+ !!list
+ !!<grammar>
+ !!fuse <grammar1> <grammar2>
+ | at the end of commands will echo the output in a new message
eg: !!drink | !toot
- [source](https://tildegit.org/ben/tracer)
* tooter
- botmaster: [~ben](https://ben.tilde.team)
- short description: toots from @tildeverse@tilde.zone (@tildeteam@tilde.zone in #team)
- list of functions:
+ !toot <message>
- [source](https://tildegit.org/ben/tooter)
* Babili
2018-12-07 22:18:04 +00:00
- botmaster: [~aewens](https://aewens.tilde.team)
- short description: A data aggregating bot for the IRC server, can as an API for other bots for handling historical data from the network
2018-12-07 22:18:04 +00:00
- list of functions:
+ View aggregated data at https://babili.xyz
- [source](https://tildegit.org/babili)
2020-02-03 18:37:26 +00:00
* circles
- botmaster: [~lickthecheese](https://lickthecheese.fuckup.club)
- short description: a nice bot to solve geometry problems
- list of functions:
+ do ?help to list commands
- [source](https://tildegit.org/lickthecheese/circles)
2020-03-14 22:59:07 +00:00
* [badger](./badger)
- botmaster: [~khuxkm](https://khuxkm.tilde.team)
2022-01-16 20:11:20 +00:00
- short description: the Twitch Plays Pokémon badge system, ported to tildeverse IRC?
2020-03-14 22:59:07 +00:00
- list of functions:
- `+listbadges` - List the badges in your possession.
- `+transmute <badge> <badge> <badge> [badge...]` - Transmute 3 or more badges into one, hopefully rarer badge.
- just be active in #meta and you should get badges. you'll get a message when you get your first!
- [source](https://tildegit.org/khuxkm/badger)
2020-04-27 14:40:24 +00:00
* pink_dragon
- botmaster: [~absalom](https://tildegit.org/baruchel)
2020-04-27 14:42:36 +00:00
- short description: idle hack'n slash game on the `#legend` channel
2020-04-27 14:40:24 +00:00
- list of functions: see the rules at [Legend of the Pink Dragon](https://pink-dragon.surge.sh)
- [source](https://gitlab.com/baruchel/pink-dragon)
2020-06-09 22:50:19 +00:00
* k
- botmaster: [~kiedtl](https://kiedtl.tilde.team)
- short description: a small bot with a bunch of miscellaneous functions
- list of functions:
+ `:dc`: `/bin/dc` expression evaluator.
+ `:fortune`: print a random fortune.
+ `:usrstats`: print statistics about users.
+ `:chanstats`: print statistics about channels.
+ `:owo`, `:pig`, `:rot13`, `:rev13`: random text manipulation functions.
+ and many more in the making!
- [source](https://github.com/kiedtl/ircbot)