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

Update README.md

Browse Source
This commit is contained in:
Tim Wilson 2020-09-10 11:07:11 -06:00 committed by GitHub
parent 55ae0bb6f5
commit bde75b07a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -7,7 +7,7 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
* [Add transfers](#add) * [Add transfers](#add)
* [Modify existing transfers](#modify) * [Modify existing transfers](#modify)
* [Check transfer status](#status) (with optional realtime updating of output) * [Check transfer status](#status) (with optional realtime updating of output)
* [Notifications for transfer state changes](#notifications) * [Notification system for transfer state changes](#notifications)
* [Pretty output and highly configurable](#pretty) * [Pretty output and highly configurable](#pretty)
* [Easy setup](#setup) * [Easy setup](#setup)
* [`t/help` for usage information](#help) * [`t/help` for usage information](#help)
@ -41,15 +41,10 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
* replace `<permissions>` with the minimum permissions `92224`(*for send messages, manage messages, embed links, read message history, and add rections*) or administrator permissions `9` to keep things simple * replace `<permissions>` with the minimum permissions `92224`(*for send messages, manage messages, embed links, read message history, and add rections*) or administrator permissions `9` to keep things simple
2. Invite the bot to your server 2. Invite the bot to your server
2. Configure `bot.py` 2. Configure `bot.py`
1. Set discord options 1. Set values in the `CONFIG` variable, which are described inline
* `TOKEN` to your bot secret token * 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.
* Lists of `OWNERS`, `BLACKLIST` and/or `WHITELIST` users, and `CHANNEL_IDS` on which the bot should listen for commands 2. Configure logging
* get these ids by [enabling developer mode in your Discord client](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-) and right-clicking on a user/channel * Pick a location for the logfile on line 112
* Pick a `BOT_PREFIX` (default is `t/`)
2. Set Transmission client information
* `TSCLIENT_CONFIG` points to the Transmission web interface you already setup
* Set `DRYRUN` to `True` to enable the discord bot to *actually* make changes to existing transfers
* Pick a location for the logfile on line 45
* 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 `logger.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!
@ -85,7 +80,7 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
* Use other reactions to print filtered lists of transfers * Use other reactions to print filtered lists of transfers
* Print symbol `t/legend` * Print symbol `t/legend`
### <a name="notifications">Notifications for transfer state changes</a> ### <a name="notifications">Notification system for transfer state changes</a>
* Print notifications regarding transfer state changes in a text channel and through DMs * Print notifications regarding transfer state changes in a text channel and through DMs
* Users are notified through DM about transfers they added * Users are notified through DM about transfers they added
* Can opt in to DM notifications for other transfers by reacting with 🔔 to `t/list` message or in-channel notifications * Can opt in to DM notifications for other transfers by reacting with 🔔 to `t/list` message or in-channel notifications