HoloUA/Telegram
HoloUA/Telegram
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 4 Activity

Updated README

Browse Source
This commit is contained in:
Profitroll 2022-12-06 13:22:55 +01:00
parent 4363ef9d78
commit 1f7890dc53
1 changed files with 42 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -27,35 +27,53 @@ You can see config file with all the comments below:
```json
{
"locale": "uk", # locale file. it's a json located under locale folder
"debug": false, # whether config_debug.json should be used instead of config.json
"owner": 0, # telegram ID of a bot owner
"age_allowed": 0, # minimum age of user that submits application
"birthdays_notify": true, # notify admin group about birthdays
"birthdays_time": "09:00", # server time when to notify about birthdays
"api": "http://example.com", # API server's external address
"admin_group": 0, # telegram ID of a admin's group
"destination_group": 0, # telegram ID of a user's group
"admins": [], # list of telegram ID's of users that are admins
"locale": "uk",
"debug": false,
"owner": 0,
"bot_id": 0,
"age_allowed": 0,
"birthdays_notify": true,
"birthdays_time": "09:00",
"api": "http://example.com",
"inline_preview_count": 7,
"admin_group": 0,
"destination_group": 0,
"remove_application_time": -1,
"admins": [],
"bot": {
"api_id": 0, # telegram API ID
"api_hash": "", # telegram API hash
"bot_token": "" # telegram bot's token
"api_id": 0,
"api_hash": "",
"bot_token": ""
},
"logging": {
"size": 512, # size of log file in kbytes after which it should be rotated
"location": "logs" # location of logs folder. can be relative or absolute
"size": 512,
"location": "logs"
},
"locations": {
"data": "data", # location of data folder. can be relative or absolute
"locale": "locale" # location of locale folder. can be relative or absolute
"data": "data",
"cache": "cache",
"locale": "locale"
},
"commands": { # user command and its description
"reapply": "Fill the application again"
"commands": {
"rules": "Check out the rules",
"reapply": "Resubmit the application"
},
"commands_admin": { # admin commands and their description
"commands_admin": {
"reboot": "Restart the bot",
"applications": "Get all applications as JSON"
"message": "Send a message",
"warnings": "Check user's warnings",
"application": "Check user's application",
"applications": "Retrieve all applications as a JSON"
},
"commands_group_admin": {
"reboot": "Restart the bot",
"message": "Send a message",
"warnings": "Check user's warnings",
"application": "Check user's application",
"applications": "Retrieve all applications as a JSON"
},
"commands_group_destination": {
"warn": "Warn a user"
}
}
```
@ -64,11 +82,6 @@ After all of that you're good to go! Happy using :)
## To-Do
* [x] Check if link belongs to admin
* [x] Inline query user's application
* [x] Get applications .json
* [ ] Complete messenger between user and admins
* [ ] Check sponsorship on Holo girls
* [ ] Get application by id and user_id
* [x] Age as a DD.MM.YYYY
* [x] Notify about upcoming birthdays
* [x] Change the application data
* [x] Check if user is already in group