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-09-13 11:14:29 -06:00 committed by GitHub
parent c4fa2dd47c
commit 2c7d1475ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,5 +1,5 @@
# Transmission Discord Bot # Transmission Discord Bot
A python Discord bot for controlling an instance of [Transmission](https://transmissionbt.com), the bittorrent client, using the [transmissionrpc](https://pythonhosted.org/transmissionrpc/) python library. A python [Discord.py](https://github.com/Rapptz/discord.py) bot for controlling an instance of [Transmission](https://transmissionbt.com), the bittorrent client, using the [transmissionrpc](https://pythonhosted.org/transmissionrpc/) python library.
This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Python-Discord-Bot-Template) and adapted from [leighmacdonald's transmission scripts](https://github.com/leighmacdonald/transmission_scripts). This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Python-Discord-Bot-Template) and adapted from [leighmacdonald's transmission scripts](https://github.com/leighmacdonald/transmission_scripts).
## Features overview ## Features overview
@ -13,8 +13,13 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
* [`t/help` for usage information](#help) * [`t/help` for usage information](#help)
## Example images ## Example images
* Transfer summary (and symbol legend)
![example images](https://github.com/twilsonco/TransmissionBot/blob/master/example%20images.png) ![summary](https://github.com/twilsonco/TransmissionBot/blob/master/out-summary.png)
* Modifying existing transfers
![modify](https://github.com/twilsonco/TransmissionBot/blob/master/out-modify.png)
## Install ## Install
@ -90,6 +95,7 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
* Use of Embeds and unicode symbols where appropriate. * Use of Embeds and unicode symbols where appropriate.
* Remove reactions from messages when no longer necessary for prettier scroll-back (in-channel only, not through DM) * Remove reactions from messages when no longer necessary for prettier scroll-back (in-channel only, not through DM)
* Configure user access using whitelist, blacklist and owner list * Configure user access using whitelist, blacklist and owner list
* Control whether whitelisted users are able to remove and/or delete transfers (with optional override specifically for transfers added by the user)
* Protect transfers using private trackers from removal * Protect transfers using private trackers from removal
* Set realtime update and notification frequency * Set realtime update and notification frequency
* Set realtime update timeout * Set realtime update timeout
@ -139,6 +145,7 @@ This bot is built on [kkrypt0nn's bot template](https://github.com/kkrypt0nn/Pyt
## Thanks to: ## Thanks to:
* Rapptz
* kkrypt0nn * kkrypt0nn
* leighmacdonald * leighmacdonald