tilde.chat/wiki/pages/bots.md

43 lines
1.7 KiB
Markdown
Raw Normal View History

2018-08-30 05:40:29 +00:00
---
author: ~cmccabe
published: true
title: cool irc bots
description: information about irc bots on tilde.chat
category:
- main
---
# tilde.team irc bots
you might have seen some bots lurking about in chat. this page is intended to be a common place for documentation.
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.
## rules and etiquette for tilde.chat irc bots
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.
## tilde.team bot starter kit
[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://git.tildeverse.org/team/teambot). it's installed globally on ~team, so get coding!
## 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`
- [source](https://git.tildeverse.org/ben/sedbot)