Skip to content

Latest commit

 

History

History
102 lines (102 loc) · 14.1 KB

README.md

File metadata and controls

102 lines (102 loc) · 14.1 KB

Yuko / Юко (Discord File Loader Bot)

Бот предназначен для скачивания вложений с каналов Discord-а, доступных боту и вам.

Содержание

Yuko Client

Стандартный клиент, позволяет скачивать вложения из сообщений посредством правил.

Что за правила?

Правила описывают, из каких сообщений нужно получить вложения. Правила содержат следующие настройки: канал, тип получения (указывает из каких сообщений достать вложения), id сообщения, количество сообщений для обработки.

Как это работает?

  1. Вы в клиентском приложении задаете правила
  2. Бот вытаскивает ссылки на эти вложения (если они есть) и отправляет эти ссылки вам в приложение
  3. Вы скачиваете файлы по этим ссылкам (можно выбрать в каком количестве скачивать файлы за условную единицу времени) в приложении

Использование приложения

Если вы впервые используете или хотите использовать любое из двух приложений, сначала прочитайте главу: Первый запуск приложения.
Запускаем приложение и логинимся (YukoClient.exe).
После того как мы залогинились открывается главное окно приложения.

Описание главного окна

Главное окно

  1. Шапка программы. Слева находится информация о текущем пользователе, справа - кнопка настроек приложения.
  2. Список серверов, на которых есть данный пользователь и к которым бот имеет доступ
  3. Список правил для выбранного сервера
  4. Список ссылок для выбранного сервера и выполненных (смотрите меню списка правил) правил

Описание окна добавления правила

Окно добавления правила

  • Канал - канал, с которого будут браться сообщения для вытаскивания ссылок
  • Получить - указывает из каких сообщений взятых с канала (указанного выше) следует вытащить ссылки (под полем отображается описание режима)
  • Сообщение (Id) - id сообщения, из которого нужно достать ссылки
  • Количество - количество сообщений, из которых надо вытащить ссылки

Yuko Collection Client

Клиент, для скачивания вложений из сообщений, сгруппированных по коллекциям.

Команды для работы с сообщениями и коллекциями

Эти команды доступны для зарегистрированных и не забаненых на сервере (где используется команда) пользователей!

Команда Алиасы Описание
add - Добавить вложенное сообщение в указанную коллекцию. Если коллекция не указана сообщение добавляется в коллекцию по умолчанию
add-by-id - Добавить указанное сообщение в указанную коллекцию. Если коллекция не указана сообщение добавляется в коллекцию по умолчанию
add-collection - Создать новую коллекцию
clear-collection - Удалить все сообщения из коллекции
end - Задать вложенное сообщение конечным сообщением для промежутка (входит в промежуток) и добавить входящие в промежуток сообщения в заданную коллекцию. Если коллекция не указана сообщения добавляются в коллекцию по умолчанию
remove rm Удалить вложенное сообщение из коллекции
remove-collection rm-collection Удалить коллекцию
remove-item rm-item Удалить сообщение из коллекции
rename-collection - Переименовать указанную коллекцию
show-collections collections Показать список коллекций
show-items items Показать последние 25 сообщений коллекции
start - Задать вложенное сообщение начальным сообщением для промежутка (входит в промежуток)

Использование приложения

Если вы впервые используете или хотите использовать любое из двух приложений, сначала прочитайте главу: Первый запуск приложения.
Запускаем приложение и логинимся (YukoCollectionClient.exe).
После того как мы залогинились открывается главное окно приложения.

Описание главного окна

Главное окно

  1. Шапка программы. Слева находится информация о текущем пользователе, справа - кнопка настроек приложения.
  2. Поле для фильтрации списка коллекций по названию
  3. Список коллекций
  4. Список сообщений выбранной коллекции
  5. Список ссылок из сообщений выбранной коллекции

Команды

Команда Алиасы Описание Владелец
бота
Aдминистратор
сервера
Остальные
участники
сервера
add-command-response add-response Отправка сообщения об успешности выполнения команды add на сервере (сообщение будет приходить в ЛС, а не в канал где выполнена команда) ✔️ ✔️
app - Показать ссылку на скачивание актуальной версии клиента ✔️ ✔️ ✔️
bag-report - Сообщить об ошибке ✔️ ✔️ ✔️
ban - Запретить пользователю скачивать с этого сервера ✔️ ✔️
ban-reason reason Причина бана на текущем сервере ✔️ ✔️ ✔️
extend-premium ep Продлить премиум доступ ✔️
info - Информация о боте и его возможностях ✔️ ✔️ ✔️
info-message-pm - Отправка сообщения об успешности выполнения команды add в ЛС (работает если сообщения об успешности выполнения команды add отключены на сервере) ✔️ ✔️ ✔️
member-ban-reason m-reason Причина бана участника сервера ✔️ ✔️
profile me Показать информацию о моей учетной записи бота ✔️ ✔️ ✔️
register reg Зарегистрироваться и получить пароль и логин от своей учетной записи или сбросить текущий пароль ✔️ ✔️ ✔️
set-app - Установить новую ссылку для команды app ✔️
set-art-channel - Установить канал для поиска сообщений для команды add-by-id ✔️ ✔️
settings - Показать настройки для подключения к боту ✔️ ✔️ ✔️
shutdown sd Выключить бота ✔️
status stat Сведения о боте ✔️
unban - Удалить пользователя из забаненых (пользователю снова разрешено скачивать с этого сервера) ✔️ ✔️

Первый запуск приложения

Что бы получить ссылку на актуальную версию приложения и доступ к основному функционалу бота нужно выполнить регистрацию, для этого выполняем команду register бота (не забываем про префикс бота), после чего в личные сообщения придет логин и пароль от учетной записи (понадобятся для входа в приложения). Затем выполняем команду app бота и переходим по ссылке, скачиваем архив с клиентами (начинается со слова clients), распаковываем его, куда вам удобно.
Запускаем нужное нам приложение (YukoClient.exe или YukoCollectionClient.exe). Перед нами появится окно входа, вводим туда логин и пароль от учетной записи. Если мы нажмем на кнопку "Войти" нам выдастся следующее сообщение "Сначала настройте программу! Значок в правом нижнем углу", следуем этому указанию (если у вас не появляется такое сообщение или появляется другое, то все равно выполните действия описанные далее).
Нажимаем на значок шестерёнки в правом нижнем углу. Открывается окно с настройками, все параметры кроме параметров в разделе "Подключение" настраиваем под свое усмотрение (либо не трогаем).
Для настройки параметров в разделе "Подключение" выполняем команду settings бота и заполняем поля соответствующими значениями. Нажимаем кнопку "Применить" и выполняем вход.

Премиум доступ

Премиум доступ позволяет заранее сохранять необходимые данные (при добавлении сообщения в коллекцию) для скачивания вложений из сообщения. Это в разы уменьшает время получения ссылок клиентом для скачивания вложений. На данный момент выдается владельцем бота.

Вопросы

Как добавить бота на сервер к себе?

Для получения ссылки для добавления бота на сервер обращаться к владельцу репозитория (Discord: Hlebushek#4209)

Как удалить сообщение бота в ЛС?

Для удаления сообщения бота в ЛС поставьте реакцию :negative_squared_cross_mark: на это сообщение