diff --git a/README.md b/README.md index 8cc9ad3..c268fc8 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ Ваш личный музыкальный бот, использующий API Яндекса, потому что а почему бы и нет! -Данный репозиторий представляет текущую версию бота. Бот написан на Python с использованием Pycord и других вспомогательных библиотек. -Процесс установки не описан, так как он хостится его автором. Исходный код доступен для ознакомления. +Бот написан на Python с использованием Pycord и других вспомогательных библиотек. **YandexMusicDiscordBot или его разработчик не связаны с Яндексом или какой-либо из их компаний, сотрудников и т.д. Товарный знак и логотипы являются собственностью их владельцев.** @@ -35,6 +34,38 @@ - [Python 3.13](https://www.python.org/downloads/release/python-3130/) - [Git](https://git-scm.com/downloads) +## Установка + +Скачайте и установите зависимости. Затем клонируйте репозиторий и установите зависимости Python. + +```cmd +git clone https://github.com/Lemon4ksan/YandexMusicDiscordBot +pip install -r requirements.txt +``` + +Добавите Python и FFMPEG в PATH. Добавьте путь к папке, которую вы склонировали в PYTHONPATH. + +Создайте файл `.env` и добавьте в него переменные окружения. Пример: + +```env +TOKEN='XXXXXX' # Токен бота +EXPLICIT_EID='1325879701117472869' # ID эмодзи explicit +DEBUG='False' # Включение DEBUG логов (True/False) +``` + +Запустите сервер MongoDB (настройки по умолчанию) и создайте базу данных YandexMusicBot с коллекциями guilds и users (через Compass или mongosh). + +Запустите бота (`python ./MusicBot/main.py`). + +## Настройка бота + +Так должны выглядить настройки бота: + +![image](assets/tutorial1.png) +![image](assets/tutorial2.png) + +Если у вас есть вопросы по поводу установки, задавайте их мне в [дискорде](https://discord.com/users/528481408319094784). + ## Получение YM токена Бот использует API Яндекс Музыки, а значит, необходим его токен. diff --git a/assets/tutorial1.png b/assets/tutorial1.png new file mode 100644 index 0000000..683fae6 Binary files /dev/null and b/assets/tutorial1.png differ diff --git a/assets/tutorial2.png b/assets/tutorial2.png new file mode 100644 index 0000000..62ec432 Binary files /dev/null and b/assets/tutorial2.png differ