decentral1se/xbotlib
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Trim up the docs

Browse Source
This commit is contained in:
Luke Murphy 2021-01-15 11:27:50 +01:00
parent 79b3e8e36b
commit 09b4871864
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -35,7 +35,7 @@ EchotBot()
And then `python echo.py`. You will be asked a few questions in order to load And then `python echo.py`. You will be asked a few questions in order to load
the account details that your bot will be using. This will generate a the account details that your bot will be using. This will generate a
`bot.conf` file in the same working directory for further use. See the `echobot.conf` file in the same working directory for further use. See the
[configuration](#configure-your-bot) section for more. [configuration](#configure-your-bot) section for more.
Here's the code for the `EchoBot`. Here's the code for the `EchoBot`.
@ -104,23 +104,29 @@ class MyBot(Bot):
help = "My help" help = "My help"
``` ```
The bot will then respond to: See more in the [commands](#commands) section on how to use this.
- `!uptime` commands in direct messages ## Commands
- `<nick>:!uptime` commands in group chats (use your own nick)
Using `!<command>` in direct messages and `<nick>:!<command>` in group chats,
here are the supported commands.
- **!uptime**: how long the bot has been running
- **!help**: the end-user provided help text of what the bot does
## Avatars ## Avatars
By default, `xbotlib` will look for an `avatar.png` file alongside your Python By default, `xbotlib` will look for an `avatar.png` (so far tested with `.png`
script which contains your bot implementation. You can also specify another but other file types may work) file alongside your Python script which contains
path using the `--avatar` option on the command-line interface. The images your bot implementation. You can also specify another path using the `--avatar`
should ideally have a height of `64` and a width of `64` pixels each. option on the command-line interface. The images should ideally have a height
of `64` and a width of `64` pixels each.
## Configure your bot ## Configure your bot
All the ways you can pass configuration details to your bot. All the ways you can pass configuration details to your bot.
### Using the bot.conf ### Using the `.conf` configuration file
If you run simply run your Python script which contains the bot then `xbotlib` If you run simply run your Python script which contains the bot then `xbotlib`
will generate a configuration for you by asking a few questions. This is the will generate a configuration for you by asking a few questions. This is the