Skip to content

Commit 104b7c9

Browse files
author
respasha
committed
Update README.md to v0.3.0
1 parent 11c9f92 commit 104b7c9

File tree

1 file changed

+34
-20
lines changed

1 file changed

+34
-20
lines changed

README.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#<p align="center">Telegram Proxy Bot
22
A simple BITM, for [Telegram](https://telegram.org/) acting as some kind of "proxy". Can use it as "virtual" second account for your purposes without revealing your "actual" identity.
33

4-
Credits to **Groosha** for the actual version
4+
Credits to **Groosha** for the actual version.
55

6-
Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional features
6+
Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional features.
77

88

99
* [ChangeLog!](#changelog)
@@ -12,6 +12,8 @@ Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional
1212
* [What's new ?](#whats-new-)
1313
* [How it works ?](#how-it-works)
1414
* [Basic Functionality](#basic-functionality)
15+
* [Viewing Log](#viewing-log)
16+
* [Setting Start Message](#setting-start-message)
1517
* [Blocking and Unblocking Feature](#blocking-and-unblocking-feature)
1618
* [Available and Unavailable Feature](#available-and-unavailable-feature)
1719
* [Notes and restrictions](#notes-and-restrictions)
@@ -21,9 +23,16 @@ Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional
2123
* [Contact](#contact)
2224

2325
##ChangeLog!
26+
####Version0.3.0
27+
* **Major Update**: Basic log viewing.
28+
* **Bugs in this version**:
29+
1. To reply back to user, you still have to find a message forwarded from this user, and reply to it. Not a bug, but it bugs me right now.
30+
2. Log looks unreadable now. Not a bug, needs beautification.
31+
3. Pager buttons don't look fancy enough for me. Not a bug, too.
32+
2433
####Version0.2.0
2534
* **Major Update**: Start Message editing by `/setstartmessage`
26-
Start message is the fist message user sees, when he/she starts the bot.
35+
Start message is the first message user sees, when he/she starts the bot.
2736
* **Bugs in this version**: Hopefully no
2837

2938
####Version0.1.0
@@ -39,8 +48,8 @@ Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional
3948
## Prerequisites
4049
* Python 3 (works only with Python3);
4150
* [pyTelegramBotAPI](https://github.com/eternnoir/pyTelegramBotAPI/) library (with bot 2.0 support);
42-
* [pyMongo](https://pypi.python.org/pypi/pymongo) driver and MongoDB credentials
43-
* Telegram account.
51+
* [pyMongo](https://pypi.python.org/pypi/pymongo) driver and MongoDB credentials;
52+
* Telegram account;
4453
* Basic Knowledge about coding of course!
4554
* And the ability to read the manual patiently :D
4655

@@ -52,6 +61,7 @@ Credits to [Mr_Gigabyte](https://github.com/mrgigabyte/proxybot) for additional
5261
* Start bot: `bash launch.sh`
5362

5463
## What's new ???
64+
* You can now examine full message history with one user. Just use *Show Log* button in _usercard_.
5565
* You can now set Start Message the same way you do with the Block Message and Unavailable Message. New commands are `/setstartmessage` and `/viewstartmessage`
5666
* Bot sends _usercard_ with each user's message (which increases the number of messages, i know. I hope, I'll get to it later). _Usercard_ shows all info about user. Ream more about blocking and unblocking [here](#blocking-and-unblocking-feature).
5767
* Admins can set their status as `/available` or `/unavailable`. This means that when you will not be available bot will notify the user if he/she tries to text you by sending him your unavailable message, just like the way you have a pre-recorded message on answering machines! The bot will however forward you the message. You can set and view your unavailable message by typing `/setunavailablemessage` and `/setunavailablemessage` respectively.
@@ -71,7 +81,21 @@ The idea of this bot is pretty simple: you just place the bot between you and th
7181

7282
<p align="center">![Screenshot](http://i.imgur.com/YZoiTjd.png)
7383

74-
#### Setting Start Message
84+
### Viewing Log
85+
I've added **Show log** button to _usercard_ which turns _usercard_ into list of messages. You can read text messages right in the list. Non-text messages, such as stickers, files, photos, voice, location, etc are converted into command, which will forward you specified message.
86+
87+
So, to view log:
88+
1. Find user, which log do you want to see, in list of users (`/viewuserlist`) or in list of blocked (`/viewblocklist`)
89+
2. Request his _usercard_ by `/userNNNNNN` command, which can be found in lists
90+
3. Tap **Show log** button
91+
92+
To view non-text messages tap on `/msgABCDEF` commands which would be placeholders for non-text messages in the list.
93+
94+
To reply back to user, you still have to find a message, which is forwarded from this user, and reply to it.
95+
96+
![Screenshot](http://i.imgur.com/2wEvnjx.png)
97+
98+
### Setting Start Message
7599
You can set Start Message -- the message, which user sees when he/she starts the bot.
76100
Use `/setstartmessage` command for setting it and `/viewstartmessage` for viewing it.
77101

@@ -138,12 +162,7 @@ Well as stated before/in the previous version. The admins were not able to see t
138162

139163

140164
## Notes and restrictions
141-
1. Message formatting (both Markdown and HTML) is disabled. You can easily add `parse_mode` argument to `send_message` function to enable it.<br>
142-
**example:**
143-
``` python
144-
bot.send_message(message.chat.id, "Please click on [this](www.google.com)to search on Google",parse_mode="Markdown")
145-
```
146-
165+
1. Message formatting (both Markdown and HTML) is not supported.
147166
2. You(Admins) should **always** use "reply" function, because bot will check `message_id` of selected "message to reply".
148167
3. Database is needed to store users' statuses and log messages.
149168
4. Supported message types in reply: `text`, `sticker`, `photo`, `video`, `audio`, `voice`, `document`, `location`.
@@ -153,23 +172,18 @@ bot.send_message(message.chat.id, "Please click on [this](www.google.com)to sear
153172
![screenshot](http://i.imgur.com/hgWuEuz.png)
154173

155174
## Upcoming Features
156-
* Viewing messages log per user
157-
* In Reply To feature for users
158175
* Anti-Spam Feature, limiting messages sent per-second
159176
* Broadcast feature for admins, they can broadcast a certain message to selected users they want
160177

161178
## Remember!
162179
I understand, that "proxy" bots can be used to prevent spammers from being reported, so if you encounter such bots that are used to do "bad" things, feel free to report them: [[email protected]](mailto:[email protected])
163180

164181
## F.A.Q
165-
#### 1. Will this bot work in groups/supergroups/channels ?
182+
#### 1. Will this bot work in groups/supergroups/channels?
166183
For the time being this bot just works in private chats.
167184

168-
#### 2. Can I use Emojis in my unavailable message ?
169-
Yes! You can use **ONLY** emojis or text in your unavailable message, you cannot save stickers/gifs in the unavailable message
170-
171-
#### 3. Will I be able to skip my school/college/job ?
172-
Unfortunately nope :(
185+
#### 2. Can I use Emojis in my saved messages (start, block and unavailable)?
186+
Yes! You can use **ONLY** emojis or text in your saved messages, you cannot save stickers/gifs or any other media. Hope that links could help in your particular case.
173187

174188
## Contact
175189
You can contact me via my [Proxy Bot](https://telegram.me/phash_bot).<br>

0 commit comments

Comments
 (0)