You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
misskey_bot/README.md

55 lines
2.6 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Misskey Bot
Какой функционал планируется у бота:
* Бот-группа (репостер упоминаний)
* Бот-ретранслятор с 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. Добавляем бота в автозагрузку системы
##