bots/LogBot/README.md

28 lines
1.1 KiB
Markdown
Raw Normal View History

2021-01-22 00:29:01 +01:00
# LogBot
2020-02-06 15:29:18 +01:00
A small XMPP bot written in Python that logs XMPP conversations into a HTML page, allowing collaborative log writing over time.
2020-02-06 15:29:18 +01:00
2021-01-22 00:29:01 +01:00
The bot is used in group chats, where it includes all images that are send to the group and all messages that include `@logbot`.
2020-02-06 15:29:18 +01:00
*work-in-progress*
2021-01-22 00:29:01 +01:00
## How to use LogBot?
2021-01-22 00:29:01 +01:00
*Oh dear, logbot is here!*
2021-01-22 00:29:01 +01:00
* `@logbot`: send a message to the groupchat with `@logbot` and it will add the whole message to the log
* send an image to the groupchat, it will add it to the log
* `@delete <num>` Delete posts from the log. For example: @logbot @delete 5
* `@bots`: To see who is around :)
* `@uptime`: To check how long @logbot has been around
* `@help`: Print this message
2020-02-06 15:29:18 +01:00
2021-01-22 00:29:01 +01:00
## Situated tails
2020-02-06 15:29:18 +01:00
2021-01-22 00:29:01 +01:00
* Archive bot, Relearn 2017, <https://gitlab.com/relearn/relearn2017/-/tree/master/xmpp-bots/archive-bot>
* Streambot, Varia website extension 2017-2018, <https://git.vvvvvvaria.org/varia/xmpp.streambot>
* Logbot v1, Varia XMPP extension 2017-2020, <https://git.vvvvvvaria.org/varia/bots/src/branch/master/logbot>
2020-02-06 15:29:18 +01:00
2021-01-22 00:29:01 +01:00
## Requirements
2020-02-06 15:29:18 +01:00
2021-01-22 00:29:25 +01:00
* [xbotlib](https://git.vvvvvvaria.org/decentral1se/xbotlib)