Skip to content

Commit 0ffe280

Browse files
authored
Update README.md
1 parent 1a8541f commit 0ffe280

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

+26-14
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
# Music Bot
22

3-
This is a simple music bot written in Python using the Discord.py library and yt_dlp for YouTube downloads.
3+
This is a simple music bot written in Python using the Pycord library and yt_dlp to search and retrieve audio tracks from YouTube.
4+
Users can add tracks to the queue, skip the current track, remove track from queue and view the queue.
45

56
## Getting Started
67

7-
### Prerequisites
8-
9-
- Python 3.x
10-
- pip (Python package installer)
11-
128
### Installation
139

1410
1. Clone the repository:
@@ -22,30 +18,46 @@ This is a simple music bot written in Python using the Discord.py library and yt
2218
```bash
2319
cd DiscordMusicBot
2420
```
25-
26-
3. Install dependencies:
21+
3. Set up a virtual environment
22+
23+
For Windows
24+
```bash
25+
python -m venv venv
26+
venv\Scripts\activate
27+
```
28+
For Linux/MacOS
29+
```bash
30+
python3 -m venv venv
31+
source venv/bin/activate
32+
```
33+
34+
4. Install dependencies:
2735

2836
```bash
2937
pip install -r requirements.txt
3038
```
39+
5. Install ffmpeg:
40+
41+
You also need ffmpeg to work, you can download it from ffmpeg.org or using a package manager.
3142

32-
4. Create a `.env` file in the project root and add your Discord bot token:
43+
6. Create a `.env` file in the project root and add your Discord bot token:
3344

3445
```
3546
DISCORD_TOKEN=your_discord_token_here
3647
```
3748

38-
5. Run the bot:
49+
7. Run the bot:
3950

4051
```bash
4152
python main.py
4253
```
4354

4455
## Usage
4556

46-
- Use the `!play` command to play a track and add it to the queue.
47-
- Use the `!queue` command to display the current queue.
48-
- Use the `!skip` command to skip the current track.
57+
- To play a track and add it to the queue, use the /play command.
58+
- To view the current queue, use the /queue command or click on the 'Очередь' button that is sent along with the message about the playing track.
59+
- To skip the current track, use the /skip command or click on the 'Пропустить' button that is sent along with the message about the playing track.
60+
- If you want to remove a track from the queue, click on the 'Удалить' button that is sent along with the message about the added track.
4961

5062
Feel free to customize and extend the functionality as needed!
5163

@@ -55,4 +67,4 @@ Contributions are welcome. Please fork the repository, make your changes, and su
5567

5668
## License
5769

58-
This project is licensed under the Apache License - see the LICENSE file for details.
70+
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

0 commit comments

Comments
 (0)