Skip to content

Commit

Permalink
README update :)
Browse files Browse the repository at this point in the history
  • Loading branch information
@TiDurak
TiDurak committed Mar 25, 2023
1 parent 34e3e2b commit e417362
Showing 1 changed file with 35 additions and 32 deletions.
67 changes: 35 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<a href="https://discord.com/api/oauth2/authorize?client_id=699912361481470032&permissions=8&scope=bot"><img src="https://img.shields.io/badge/DebilBot-Add to Discord server-orange?logo=probot&logoColor=orange"></a>
<br>
<img src="https://img.shields.io/badge/Python-3.10x-yellow">
<img src="https://img.shields.io/badge/Discord.Py-1.7.3-blue">
<img src="https://img.shields.io/badge/Discord.Py-2.2.2-blue">

***

Expand All @@ -19,9 +19,9 @@
+ **Python 3.10.0**

#### Python modules
+ discord
+ discord_components
+ googletrans==3.1.0a0
`pip install -r requirements.txt`
+ discord 2.2.2
+ googletrans 3.1.0a0
+ requests
+ youtube_dl
+ asyncio
Expand All @@ -36,42 +36,45 @@

### Usage

***Recomendation: before using, please, read the LICENSE file!***
***Recomendation: before using read the LICENSE file!***

1. Install all dependencies (`pip install -r requirements.txt`)
2. Get your bot token in [discord dev portal](https://discord.com/developers/applications)
3. Set DEBIL_TOKEN environment variable, **OR** put it in `settings.token` in `config.py`
4. Run main.py file

Open `config.py` file in root directory, and edit prefix value, token value (or make environment variable DEBIL_TOKEN with your token value),
path to ffmpeg, and in dict with emojis set up values with emoji id.

To launch music commands, as **play**:
Windows: [download ffmpeg build](https://www.gyan.dev/ffmpeg/builds/), unpack archive, `path_to_ffmpeg` value must be your path to ffmpeg.
Linux: just install ffmpeg (`sudo apt install ffmpeg`, `sudo apt-get install ffmpeg`, etc), in `path_to_ffmpeg` value type `ffmpeg`

**For bot starting, open `main.py` file**


---

### Commands List

Command | Description
----------------------------------------|---------------------------------------------------------------------------------
help | Show command list
help *command name* | Show details about command
play *song name* | Starts playing the song (U need to be connected in the Voice Chat)
pause | Pausing the song
resume | Resume song playing
stop | Stopping the song
leave | Disconnects the bot from voice chat
clear *number of messages* | Delete messages from text chat
fetch *ID of the message* | Delete one message from chat by ID
kick *member mention* | Kicks member from server
ban *member mention* | Bans member on server
avatar *member mention* | Sends user avatar
user_info *member mention* | Shows user information
server_info | Shows server information
encode_b64 *text* | Coverts text to base64
decode_b64 *base64* | Converts Base64 to the text
encode_binary *text* | Coverts text to the binary code
decode_binary *binary code* | Converts binary code to the text
translate *lang in ISO 639-1* *text* | Translates the text
poll *question* *answer1* *answ2* | Creates a poll. Minimum 2 answers, max 10. !!!Questions and answers take IN QUOTES
echo *text* | Repeats your text
slots | Slot machine
| Command | Description |
|--------------------------------------|------------------------------------------------------------------------------------|
| help | Show command list |
| help *command name* | Show details about command |
| play *song name* | Starts playing the song (U need to be connected in the Voice Chat) |
| pause | Pausing the song |
| resume | Resume song playing |
| stop | Stopping the song |
| leave | Disconnects the bot from voice chat |
| clear *number of messages* | Delete messages from text chat |
| fetch *ID of the message* | Delete one message from chat by ID |
| kick *member mention* | Kicks member from server |
| ban *member mention* | Bans member on server |
| avatar *member mention* | Sends user avatar |
| user_info *member mention* | Shows user information |
| server_info | Shows server information |
| encode_b64 *text* | Coverts text to base64 |
| decode_b64 *base64* | Converts Base64 to the text |
| encode_binary *text* | Coverts text to the binary code |
| decode_binary *binary code* | Converts binary code to the text |
| translate *lang in ISO 639-1* *text* | Translates the text |
| poll *question* *answer1* *answ2* | Creates a poll. Minimum 2 answers, max 10. !!!Questions and answers take IN QUOTES |
| echo *text* | Repeats your text |
| slots | Slot machine |

0 comments on commit e417362

Please sign in to comment.