Removed default config string and added badges
This commit is contained in:
parent
de984c2b78
commit
cb3a975303
243
README.md
243
README.md
@ -1,6 +1,11 @@
|
||||
# HoloCheckerBot
|
||||
<h1 align="center">HoloCheckerBot</h1>
|
||||
|
||||
Small Telegram bot made on Pyrogram
|
||||
<p align="center">Small Telegram bot made on Pyrogram</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://git.end-play.xyz/profitroll/HoloCheckerBot/src/branch/master/LICENSE"><img alt="License: GPL" src="https://img.shields.io/badge/License-GPL-blue"></a>
|
||||
<a href="https://git.end-play.xyz/profitroll/HoloCheckerBot"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
|
||||
</p>
|
||||
|
||||
## What can this bot do?
|
||||
|
||||
@ -25,240 +30,6 @@ Small Telegram bot made on Pyrogram
|
||||
So bot has its "config_example.json" and it needs to be changed.
|
||||
Copy this file to "config.json" and open it with any text editor.
|
||||
|
||||
You can see config file with all the comments below:
|
||||
|
||||
```json
|
||||
{
|
||||
"locale": "uk",
|
||||
"debug": false,
|
||||
"owner": 0,
|
||||
"age_allowed": 0,
|
||||
"age_maximum": 70,
|
||||
"api": "http://example.com",
|
||||
"issues": "https://github.com/example/test/issues/new",
|
||||
"inline_preview_count": 7,
|
||||
"remove_application_time": -1,
|
||||
"search_radius": 50,
|
||||
"admins": [],
|
||||
"groups": {
|
||||
"admin": 0,
|
||||
"users": 0
|
||||
},
|
||||
"bot": {
|
||||
"api_id": 0,
|
||||
"api_hash": "",
|
||||
"bot_token": ""
|
||||
},
|
||||
"database": {
|
||||
"user": null,
|
||||
"password": null,
|
||||
"host": "127.0.0.1",
|
||||
"port": 27017,
|
||||
"name": "holochecker"
|
||||
},
|
||||
"geocoding": {
|
||||
"username": "demo"
|
||||
},
|
||||
"logging": {
|
||||
"size": 512,
|
||||
"location": "logs"
|
||||
},
|
||||
"features": {
|
||||
"general": {
|
||||
"enabled": true
|
||||
},
|
||||
"applications": {
|
||||
"enabled": true
|
||||
},
|
||||
"sponsorships": {
|
||||
"enabled": true
|
||||
},
|
||||
"warnings": {
|
||||
"enabled": true
|
||||
},
|
||||
"invites_check": {
|
||||
"enabled": true
|
||||
},
|
||||
"dinovoice": {
|
||||
"enabled": false
|
||||
},
|
||||
"spoilers": {
|
||||
"enabled": true,
|
||||
"allow_external": true
|
||||
}
|
||||
},
|
||||
"scheduler": {
|
||||
"birthdays": {
|
||||
"time": 9,
|
||||
"enabled": true
|
||||
},
|
||||
"sponsorships": {
|
||||
"time": 9,
|
||||
"enabled": true
|
||||
},
|
||||
"cache_avatars": {
|
||||
"interval": 6,
|
||||
"enabled": true
|
||||
},
|
||||
"cache_members": {
|
||||
"interval": 30,
|
||||
"enabled": true
|
||||
},
|
||||
"cache_admins": {
|
||||
"interval": 120,
|
||||
"enabled": true
|
||||
},
|
||||
"channels_monitor": {
|
||||
"interval": 5,
|
||||
"enabled": true,
|
||||
"channels": []
|
||||
}
|
||||
},
|
||||
"locations": {
|
||||
"cache": "cache",
|
||||
"locale": "locale"
|
||||
},
|
||||
"commands": {
|
||||
"rules": {
|
||||
"permissions": [
|
||||
"users",
|
||||
"admins"
|
||||
],
|
||||
"modules": [
|
||||
"general"
|
||||
]
|
||||
},
|
||||
"spoiler": {
|
||||
"permissions": [
|
||||
"users",
|
||||
"admins"
|
||||
],
|
||||
"modules": [
|
||||
"spoilers"
|
||||
]
|
||||
},
|
||||
"cancel": {
|
||||
"permissions": [
|
||||
"users",
|
||||
"admins"
|
||||
],
|
||||
"modules": [
|
||||
"spoilers",
|
||||
"applications",
|
||||
"sponsorships"
|
||||
]
|
||||
},
|
||||
"nearby": {
|
||||
"permissions": [
|
||||
"users",
|
||||
"admins",
|
||||
"group_admins"
|
||||
],
|
||||
"modules": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"warn": {
|
||||
"permissions": [
|
||||
"group_users_admins"
|
||||
],
|
||||
"modules": [
|
||||
"warnings"
|
||||
]
|
||||
},
|
||||
"reapply": {
|
||||
"permissions": [
|
||||
"users",
|
||||
"admins"
|
||||
],
|
||||
"modules": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"sponsorship": {
|
||||
"permissions": [
|
||||
"users",
|
||||
"admins"
|
||||
],
|
||||
"modules": [
|
||||
"sponsorships"
|
||||
]
|
||||
},
|
||||
"reboot": {
|
||||
"permissions": [
|
||||
"owner"
|
||||
],
|
||||
"modules": [
|
||||
"general"
|
||||
]
|
||||
},
|
||||
"label": {
|
||||
"permissions": [
|
||||
"admins",
|
||||
"group_admins"
|
||||
],
|
||||
"modules": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"permissions": [
|
||||
"admins",
|
||||
"group_admins"
|
||||
],
|
||||
"modules": [
|
||||
"general"
|
||||
]
|
||||
},
|
||||
"identify": {
|
||||
"permissions": [
|
||||
"admins",
|
||||
"group_admins"
|
||||
],
|
||||
"modules": [
|
||||
"applications",
|
||||
"sponsorships"
|
||||
]
|
||||
},
|
||||
"issue": {
|
||||
"permissions": [
|
||||
"users",
|
||||
"admins"
|
||||
],
|
||||
"modules": [
|
||||
"general"
|
||||
]
|
||||
},
|
||||
"application": {
|
||||
"permissions": [
|
||||
"admins",
|
||||
"group_admins"
|
||||
],
|
||||
"modules": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"applications": {
|
||||
"permissions": [
|
||||
"admins",
|
||||
"group_admins"
|
||||
],
|
||||
"modules": [
|
||||
"applications"
|
||||
]
|
||||
},
|
||||
"resetcommands": {
|
||||
"permissions": [
|
||||
"owner"
|
||||
],
|
||||
"modules": [
|
||||
"general"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
After all of that you're good to go! Happy using :)
|
||||
|
||||
## To-Do
|
||||
|
Reference in New Issue
Block a user