diff --git a/README.md b/README.md index 6ef2bbb..cd0480e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,50 @@ # Misskey Bot -[Ранняя стадия разработки, авось что получится съедобное] Какой функционал планируется у бота: -1. Бот-группа -2. Бот-ретранслятор с Twitter -3. Автопостер картинок из заданного каталога (готово на 80%) - -## 1 Как заставить бота работать? -1.1 В первую очередь нужно зайти в аккаунт бота на вашем инстансе, после этого перейти в настройки (шестерёнка) - API - создать токен доступа. -Предоствьте боту тот доступ, который будет предостаточен для выполнения ваших потребностей. - -1.2 Правильно заполните конфиг. Это очень важно, иначе бот не будет работать! - +* Бот-группа (репостер упоминаний) +* Бот-ретранслятор с Twitter +* Автопостер картинок из заданного каталога (готово на 80%) (отменено) + +## 1. Как заставить бота работать? +## 1.1. Технические моменты +* Python 3.8+ +* Готовый misskey инстанс (не обязательно свой) + +## 1.2. Административные моменты +* Свободных 200 мб RAM памяти +* Свободного времени на поиск и устранение проблем, в случае чего +* Тематика вашего бота + + +## 2. Настройка бота +### 2.1. Достаём API +В первую очередь нужно зайти в аккаунт бота на вашем инстансе (создайте, если еще не сделали этого.). Дальше перейдите в +`Настройки (шестерёнка) -> API -> Создать токен ` +Выберите необходимые расширения (я выбираю все) и нажмите галочку, после чего появится всплывающие окно с токеном вашего бота. + +!ВНИМАНИЕ! +Создав токен один раз вы больше не сможете его посмотреть (неизвестно, баг это misskey или фича, но что есть то есть). + +### 2.2. Настраиваем config.json +Дальше переходим в config.json и заполняем его под ваш инстанс, где +`"name"` - название вашего инстанса, +`"url"` - веб-адрес вашего инстанса (!не бота!), +`"token"` - ваш токен, который вы получили в пункте 1.1, +`"visibility" - "public"` (обязательно) + +### 2.3. Запускаем бота +Запускаем скрипт `python main.py`. По сути, бот сейчас должен работать. + +### 2.4. Проверка бота +Проверяем работоспособность бота: +* Подпишитесь на бота +* Отправьте что-нибудь с его упоминанием (главное, чтобы пост был либо "Глобальным", либо "Домашним") +* Получаем сообщение о том, что бот нас репостнул +* ...???? +* PROFIT! + + +## 3. Добавляем бота в автозагрузку системы diff --git a/test.jpg b/test.jpg old mode 100755 new mode 100644