noham/TransmissionBot
1
0
Fork 0
mirror of https://github.com/NohamR/TransmissionBot.git synced 2025-05-24 00:48:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Tim Wilson 2020-10-20 18:44:06 -06:00 committed by GitHub
parent 18d046df96
commit bcb8ac768c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -52,10 +52,11 @@ Using the [transmissionrpc](https://pythonhosted.org/transmissionrpc/) python li
2. Invite the bot to your server 2. Invite the bot to your server
2. Configure `bot.py` 2. Configure `bot.py`
1. Set values in the `CONFIG` variable, which are described inline 1. Set values in the `CONFIG` variable, which are described inline
* Values that MUST be configured: `bot_token`, `listen_channel_ids` if you want to use in-channel, `notification_channel_id` if you wish to use in-channel notifications, `owner_user_ids` at least with your Discord user id, `tsclient` with information pointing to your Transmission remote gui, `whitelist_user_ids` at least with your Discord user id and any other Discord users you wish to be able to use the bot.
* After first run, a `config.json` file will be created in the same directory as `bot.py`. This file should then be used to make any configuration changes, and the definition of `CONFIG` in `bot.py` should be commented out or removed. * After first run, a `config.json` file will be created in the same directory as `bot.py`. This file should then be used to make any configuration changes, and the definition of `CONFIG` in `bot.py` should be commented out or removed.
2. Configure logging 2. Configure logging
* Pick a location for the logfile on line 112 * Pick a location for the logfile on line 124; default is the same directory where bot.py resides
* Optionally disable logging by setting the log level to `logger.CRITICAL` which isn't used anywhere * Optionally disable logging by setting the log level to `logging.CRITICAL` which isn't used anywhere
3. Run with `python3 /path/to/TransmissionBot/bot.py` and enjoy! 3. Run with `python3 /path/to/TransmissionBot/bot.py` and enjoy!
## Detailed features ## Detailed features