mb/bots
1
0
Fork 0
forked from varia/bots
Code Issues Pull Requests Projects Releases Wiki Activity

syncing the help text with the readme file

Browse Source
This commit is contained in:
manetta 2021-02-01 11:14:57 +01:00
parent a3670e70e6
commit e0ff0ee72a
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LogBot/README.md
View File

@ -2,20 +2,25 @@
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`.
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!*
* `@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
(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 <element> <css-rule>: Edit the css of your log. For example: logbot @style body background-color: pink; [future-feature]
logbot @uptime: To check how long @logbot has been around
@bots: To see who is around :)
```
## Situated tails
@ -25,4 +30,4 @@ The bot is used in group chats, where it includes all images that are send to th
## Requirements
* [xbotlib](https://git.vvvvvvaria.org/decentral1se/xbotlib)
* [xbotlib](https://git.vvvvvvaria.org/decentral1se/xbotlib)