Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos and make readme clearer #173

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix typos and make readme clearer #173

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
323e88c
Fix typos and make readme clearer
SmolParascythe Jul 20, 2022
e593e94
Fix grammar
SmolParascythe Jul 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A Torrent, youtube-dl Leecher, and Uploader!

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [COPYING](./COPYING) for more details.

## installing
## Installing

### The Eas(iest) Way

Expand Down Expand Up @@ -45,87 +45,87 @@ python3 -m publicleechgroup

##### Mandatory Variables

* `TG_BOT_TOKEN`: Create a bot using [@BotFather](https://telegram.dog/BotFather), and get the Telegram API token.
* `TG_BOT_TOKEN`: Create a bot using [@BotFather](https://telegram.dog/BotFather) and get the Telegram API token.

* `APP_ID`
* `API_HASH`: Get these two values from [my.telegram.org/apps](https://my.telegram.org/apps).
* N.B.: if Telegram is blocked by your ISP, try our [Telegram bot](https://telegram.dog/UseTGXBot) to get the IDs.
* N.B.: If Telegram is blocked by your ISP, try our [Telegram bot](https://telegram.dog/UseTGXBot) to get the IDs.

* `AUTH_CHANNEL`:
Create a Super Group in Telegram, add `@GoogleIMGBot` to the group, and send /id in the chat, to get this value.
You can add multiple IDs seperated by space.
* `AUTH_CHANNEL`: Create a Super Group in Telegram. Add `@GoogleIMGBot` to the group and send /id in the chat to get this value. You can add multiple IDs separated by a space.

##### Optional Configuration Variables

* `SHOULD_USE_BUTTONS`: because, [BlameTelegram](https://t.me/c/1494623325/5603)
* `SHOULD_USE_BUTTONS`: Because, [BlameTelegram](https://t.me/c/1494623325/5603)

* `ARIA_TWO_STARTED_PORT`: The port on which aria2c daemon must START. This should be an integer, between 1001 and 65535.
* `ARIA_TWO_STARTED_PORT`: The port aria2c daemon must START with. This should be an integer between 1001 and 65535.

* `EDIT_SLEEP_TIME_OUT`: The number of seconds to sleep after editing a Telegram message.

* `MAX_TIME_TO_WAIT_FOR_TORRENTS_TO_START`: The number of seconds to wait before auto-cancelling a dead link.

* `FINISHED_PROGRESS_STR`: any character(s) that might be displayed in the progress string.
* `FINISHED_PROGRESS_STR`: Any character(s) that might be displayed in the progress string.

* `UN_FINISHED_PROGRESS_STR`: any character(s) that might be displayed in the progress string.
* `UN_FINISHED_PROGRESS_STR`: Any character(s) that might be displayed in the progress string.

* `TG_OFFENSIVE_API`: ~~DO NOT USE THIS~~.

* `R_CLONE_CONF_URI`:
![a help, maybe](https://telegra.ph/file/073bcbc0b69b03d75ea04.jpg)

* `R_CLONE_DEST`: Destination folder for rclone copying. Set your path starting with '/'. Or just leave '/' to set root folder
* `R_CLONE_DEST`: Destination folder for rclone copying. Set your path starting with '/'. Or just leave '/' to set the root folder

* `DOWNLOAD_LOCATION`: optional download directory, where the temporary downloads should ideally reside.
* `DOWNLOAD_LOCATION`: Optional download directory where the temporary downloads should ideally reside.

* `MAX_FILE_SIZE`: The maximum file_size allowed by Telegram [BOT API](https://core.telegram.org/bots/api), kept for [legacy purposes](https://t.me/c/1235155926/33801).

* `TG_MAX_FILE_SIZE`: The maximum file_size, allowed by Telegram [API](https://core.telegram.org/api).
* `TG_MAX_FILE_SIZE`: The maximum file_size allowed by Telegram [API](https://core.telegram.org/api).

* `FREE_USER_MAX_FILE_SIZE`: The file_size that was [supposed to be allowed](https://t.me/c/1331081386/147445) by the bot.

* `MAX_TG_SPLIT_FILE_SIZE`: The file_size at which it should be splitted if the file_size is greater than `TG_MAX_FILE_SIZE`.
* `MAX_TG_SPLIT_FILE_SIZE`: The file_size at which it should be split if the file_size is greater than `TG_MAX_FILE_SIZE`.

* `CHUNK_SIZE`: ~~not used~~, kept for [legacy purposes](https://t.me/c/1235155926/33801).
* `CHUNK_SIZE`: ~~Not used~~, kept for [legacy purposes](https://t.me/c/1235155926/33801).

* `MAX_MESSAGE_LENGTH`: The maximum message length, allowed by [Telegram](https://t.me/c/1097142020/1224).
* `MAX_MESSAGE_LENGTH`: The maximum message length allowed by [Telegram](https://t.me/c/1097142020/1224).

* `PROCESS_MAX_TIMEOUT`: ~~not used~~, kept for [legacy purposes](https://t.me/c/1235155926/33801).
* `PROCESS_MAX_TIMEOUT`: ~~Not used~~, kept for [legacy purposes](https://t.me/c/1235155926/33801).

* `SP_LIT_ALGO_RITH_M`: allowed values can be `hjs` or `rar`.
* `SP_LIT_ALGO_RITH_M`: Allowed values can be `hjs` or `rar`.
- VIDEO files are not affected based on this value.

* `DIS_ABLE_ST_GFC_COMMAND_I`: setting this to ANYTHING will enable `/exec` and `/eval` commands.
* `DIS_ABLE_ST_GFC_COMMAND_I`: Setting this to ANYTHING will enable `/exec` and `/eval` commands.


## Available Commands

* The available commands depends on the ENVironment / CONfig variables that is set by you.
* You can read the [Commandi](./publicleechgroup/dinmamoc.py) file, to know about the ENVironment variables to use.
* You can read the [Loilacaztion](./publicleechgroup/amocmadin.py) file, to know about the ENVironment variables to use.
* The available commands depend on the ENVironment / CONfig variables that are set by you.
* You can read the [Commandi](./publicleechgroup/dinmamoc.py) file to learn about the ENVironment variables used.
* You can read the [Loilacaztion](./publicleechgroup/amocmadin.py) file to learn about the ENVironment variables used.


## How to Use?

* send any link, and click on the available buttons.
* Send any link and click on the available buttons.

* if you have disabled `SHOULD_USE_BUTTONS`, you can read the [Commandi](./publicleechgroup/dinmamoc.py) file, to know about the commands.
- [COMMANDI_LEECH](./publicleechgroup/dinmamoc.py#L23) can take multiple arguments
* `archive`: if you want a `.tar.gz` file, in your Telegram Chat.
* `leech_rc_0`: if you want to mirror to an rClone supported host, `0` is an example, and should be replaced with the index of your required host, in your uploaded `rclone.conf` file.
* If you have `SHOULD_USE_BUTTONS` disabled, you can read the [Commandi](./publicleechgroup/dinmamoc.py) file to learn about the commands.

* if file is larger than `TG_MAX_FILE_SIZE`, [read this](https://t.me/c/1434259219/113).
* [COMMANDI_LEECH](./publicleechgroup/dinmamoc.py#L23) can take multiple arguments

* `archive`: if you want a `.tar.gz` file in your Telegram Chat.

* `leech_rc_0`: if you want to mirror to a rClone supported host. `0` is an example and should be replaced with the index of your required host in your uploaded `rclone.conf` file.

* if file is a TAR archive, [read this](https://t.me/c/1434259219/104) to know how to uncompress.
* If the file is larger than `TG_MAX_FILE_SIZE`, [read this](https://t.me/c/1434259219/113).

* If the file is a TAR archive, [read this](https://t.me/c/1434259219/104) to learn how to uncompress.

## Issues or Feature Requests

* search for known issues, [here](https://t.me/c/1434259219/118) or in the [GitHub Issues](https://github.com/SpEcHiDe/PublicLeech/issues).
* Search for known issues [here](https://t.me/c/1434259219/118) or in the [GitHub Issues](https://github.com/SpEcHiDe/PublicLeech/issues).

* add issues / feature requests, [here](https://github.com/SpEcHiDe/PublicLeech/issues/new).
* Add issues / feature requests [here](https://github.com/SpEcHiDe/PublicLeech/issues/new).

* the GitHub Issue Tracker is only for Issue / Feature Requests. For any support, please use the Telegram Group.
* The GitHub Issue Tracker is only for Issue / Feature Requests. For any support, please use the Telegram Group.

## Credits, and Thanks to

Expand Down