Add config file to example
This commit is contained in:
parent
7024686ff2
commit
2215e75c34
1 changed files with 14 additions and 1 deletions
15
README.md
15
README.md
|
|
@ -39,7 +39,17 @@ class EchoBot(yaboli.Bot):
|
||||||
await message.reply(args.raw)
|
await message.reply(args.raw)
|
||||||
```
|
```
|
||||||
|
|
||||||
The bot's nick, cookie file and default rooms are specified in a config file.
|
The bot's nick, cookie file and default rooms are specified in a config file,
|
||||||
|
like so:
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[general]
|
||||||
|
nick = EchoBot
|
||||||
|
cookie_file = bot.cookie
|
||||||
|
|
||||||
|
[rooms]
|
||||||
|
test
|
||||||
|
```
|
||||||
|
|
||||||
The help command from the botrulez uses the `HELP_GENERAL` and `HELP_SPECIFIC`
|
The help command from the botrulez uses the `HELP_GENERAL` and `HELP_SPECIFIC`
|
||||||
fields.
|
fields.
|
||||||
|
|
@ -52,6 +62,9 @@ In the `cmd_echo` function, the echo command is implemented. In this case, the
|
||||||
bot replies to the message containing the command with the raw argument string,
|
bot replies to the message containing the command with the raw argument string,
|
||||||
i. e. the text between the end of the "!echo" and the end of the whole message.
|
i. e. the text between the end of the "!echo" and the end of the whole message.
|
||||||
|
|
||||||
|
The full version of this echobot can be found [in the
|
||||||
|
examples](examples/echo/).
|
||||||
|
|
||||||
## TODOs
|
## TODOs
|
||||||
|
|
||||||
- [ ] document yaboli (markdown files in a "docs" folder?)
|
- [ ] document yaboli (markdown files in a "docs" folder?)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue