bots/LogBot/README.md

71 lines
3.0 KiB
Markdown
Raw Normal View History

2021-01-22 00:29:01 +01:00
# LogBot
2020-02-06 15:29:18 +01:00
2021-04-28 15:51:37 +02:00
LogBot is a bot for asynchronous collective logging and log writing over longer periods of time. The bot operates in a chat environment, from where it saves images, messages and other media files into a webpage. The bot is made by members of Varia and is used hand in hand with event preparations`[1]`, collective research`[2][3]` or as a tool for publishing materials on the go`[4]`. The bot runs on a self-hosted XMPP chat infrastructure, hosted and maintained by members of Varia.
2020-02-06 15:29:18 +01:00
2021-04-28 15:51:37 +02:00
`[1]`: https://vvvvvvaria.org/logs/x-y/ X-Y log, in preparation of Plaintext Partyline \
`[2]`: https://vvvvvvaria.org/logs/digital-autonomy/log.html Collective research log, around the term "digital autonomy" \
`[3]`: https://vvvvvvaria.org/logs/afijeno/ Pub.club research log, around community publishing initiatives \
`[4]`: https://vvvvvvaria.org/logs/zamopuzo/ Backlog, the making of the streaming infrastructure of Varia
2021-04-28 15:42:38 +02:00
2021-04-28 16:00:52 +02:00
![](screenshots/logbot-screenshot-1.png)
![](screenshots/logbot-screenshot-2.png)
2021-04-28 15:51:37 +02:00
2021-04-28 16:05:21 +02:00
## How is LogBot made?
2021-04-28 15:42:38 +02:00
LogBot is small XMPP bot written in Python that is used in group chats. It uses the [xbotlib library](https://git.vvvvvvaria.org/decentral1se/xbotlib) written by [decentral1se](https://git.vvvvvvaria.org/decentral1se).
2020-02-06 15:29:18 +01:00
2021-04-28 16:05:21 +02:00
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>
- Bots as Infrapunctures @ Obfuscation Workshop, May 2021, Cristina Cochior & Manetta Berends, <https://3rd.obfuscationworkshop.org/> & <https://bots-as-digital-infrapunctures.dataschool.nl/>
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!*
(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 @folder <string>: Change the foldername of your log (by default, the roomname of the groupchat is used). Small warning: this changes the URL to your log page.
logbot @style <stylesheet>: Switch to another stylesheet. For example: logbot @style log. Available stylesheets include: timeline (default), float, opentab.
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.
logbot @uptime: To check how long @logbot has been around
@bots: To see who is around :)
```
2020-02-06 15:29:18 +01:00
## Stylesheets
* timeline
* float
2021-04-28 15:42:38 +02:00
* opentab
2021-04-28 15:42:38 +02:00
These can be found in the folder `stylesheets/`.
## Fonts
* polsku
* notcouriersans
* None
2021-01-22 00:29:01 +01:00
## Requirements
2020-02-06 15:29:18 +01:00
2021-04-28 16:08:00 +02:00
- [xbotlib](https://git.vvvvvvaria.org/decentral1se/xbotlib) (`pip3 install xbotlib`)
- [jinja2](https://jinja.palletsprojects.com/) (`pip3 install jinja2`)