bots/LogBot/README.md

# LogBot

A small XMPP bot written in Python that logs XMPP conversations into a HTML page, allowing collaborative log writing over time.

The bot is used in group chats, where it includes all images that are send to the group and all messages that include `@logbot` or `logbot` or `logbot:`.

_work-in-progress_

## How to use LogBot?

```
*Oh dear, logbot is here!*

(You can speak to the bot using @logbot or logbot:)

<image>: Your image is added to the log.

logbot @help: Print this message

logbot @add <message>: Add a message to the log.

logbot @delete <num>: Delete posts from the log. For example: @logbot @delete 5

logbot @title <string>: Set the title of your log.

logbot @style <stylesheet>: Switch to another stylesheet. For example: logbot @style log. Available stylesheets include: log. See https://git.vvvvvvaria.org/varia/bots/ for examples.

logbot @font <font>: Switch to another font. For example: logbot @font font. Available fonts include: polsku, notcouriersans; or select None to switch back to default serif. See https://git.vvvvvvaria.org/varia/bots/ for examples.

logbot @uptime: To check how long @logbot has been around

@bots: To see who is around :)
```

## Stylesheets

Examples soon.

## Fonts

Examples soon.

## Situated tails

- 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>

## Requirements

- [xbotlib](https://git.vvvvvvaria.org/decentral1se/xbotlib)