Перейти к содержимому

Документация

Начало работы с Garita.

Первые шаги, права, которые запрашивает каждый модуль, и доступные команды. Таблица прав создаётся прямо из реестра модулей в самом коде.

Первые шаги

  1. Получите доступ

    Нажмите «Добавить в Discord» и выберите свой сервер. Discord покажет, какие права запрашивает бот.

    Добавить в Discord (откроется в новой вкладке)
  2. Поставьте роль Garita повыше

    В «Настройках сервера» → «Роли» поднимите роль Garita выше тех ролей, которыми бот должен управлять. Discord не позволяет боту действовать на роли выше его собственной.

  3. Откройте панель

    Войдите через свой аккаунт Discord и выберите сервер, который хотите настроить.

  4. Включите то, что нужно

    Перед включением каждый модуль показывает, каких прав ему не хватает. Начните с безопасности.

  5. Начните в режиме наблюдения

    Honeypot сначала только записывает, ничего не наказывая. Когда проверите записи, включите его командой /honeypot enable.

Права и интенты для каждого модуля

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

Интенты, отмеченные как привилегированные (участники, содержимое сообщений), нужно включить на портале разработчиков, а когда серверов больше 100, на них нужно одобрение Discord.

Права и интенты для каждого модуля (создано из реестра модулей)
МодульПрава ботаИнтенты
Безопасность
Honeypot
  • Просматривать каналы
  • Отправлять сообщения
  • Встраивать ссылки
  • Прикреплять файлы
  • Банить участников
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
  • Баны и журнал аудитаGuildModeration
Анти-рейд
  • Управлять ролями
  • Управлять каналами
  • Выгонять участников
  • Отправить участников подумать о своём поведении
  • Управлять сервером
  • Серверы, каналы и ролиGuilds
  • УчастникиGuildMembersПривилегированное
  • Сообщения на сервереGuildMessages
Анти-нюк
  • Просматривать журнал аудита
  • Управлять ролями
  • Управлять каналами
  • Серверы, каналы и ролиGuilds
  • Баны и журнал аудитаGuildModeration
Верификация
  • Управлять ролями
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
  • УчастникиGuildMembersПривилегированное
Модерация
Автомодерация
  • Управлять сообщениями
  • Отправить участников подумать о своём поведении
  • Управлять сервером
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
  • Содержимое сообщенийMessageContentПривилегированное
  • Срабатывания AutoModAutoModerationExecution
Модерация
  • Выгонять участников
  • Банить участников
  • Отправить участников подумать о своём поведении
  • Управлять сообщениями
  • Читать историю сообщений
  • Серверы, каналы и ролиGuilds
  • Баны и журнал аудитаGuildModeration
Логи
  • Просматривать каналы
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
  • Баны и журнал аудитаGuildModeration
  • Сообщения на сервереGuildMessages
  • Состояния голосаGuildVoiceStates
Сообщество
Приветствия
  • Просматривать каналы
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
  • УчастникиGuildMembersПривилегированное
Роли и онбординг
  • Управлять ролями
  • Отправлять сообщения
  • Серверы, каналы и ролиGuilds
  • УчастникиGuildMembersПривилегированное
  • РеакцииGuildMessageReactions
Отслеживание приглашений
  • Управлять сервером
  • Серверы, каналы и ролиGuilds
  • ПриглашенияGuildInvites
  • УчастникиGuildMembersПривилегированное
Экзамен для whitelist
  • Управлять ролями
  • Отправлять сообщения
  • Встраивать ссылки
  • Создавать приватные ветки
  • Отправлять сообщения в ветках
  • Управлять ветками
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
  • Содержимое сообщенийMessageContentПривилегированное
Монетизация сервера
  • Управлять ролями
  • Серверы, каналы и ролиGuilds
  • УчастникиGuildMembersПривилегированное
Активность
Уровни
  • Управлять ролями
  • Отправлять сообщения
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
  • Состояния голосаGuildVoiceStates
Виртуальная экономика
  • Управлять ролями
  • Отправлять сообщения
  • Серверы, каналы и ролиGuilds
Розыгрыши
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
Опросы
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
События и напоминания
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
Дни рождения
  • Отправлять сообщения
  • Управлять ролями
  • Серверы, каналы и ролиGuilds
Доска звёзд
  • Отправлять сообщения
  • Встраивать ссылки
  • Читать историю сообщений
  • Серверы, каналы и ролиGuilds
  • РеакцииGuildMessageReactions
Достижения
  • Отправлять сообщения
  • Управлять ролями
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
  • Состояния голосаGuildVoiceStates
  • УчастникиGuildMembersПривилегированное
  • РеакцииGuildMessageReactions
Игры
  • Отправлять сообщения
  • Встраивать ссылки
  • Прикреплять файлы
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
Музыка
  • Просматривать каналы
  • Отправлять сообщения
  • Встраивать ссылки
  • Подключаться
  • Говорить
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
  • Состояния голосаGuildVoiceStates
Голосовые эффекты
  • Просматривать каналы
  • Отправлять сообщения
  • Встраивать ссылки
  • Подключаться
  • Говорить
  • Серверы, каналы и ролиGuilds
  • Состояния голосаGuildVoiceStates
Поддержка
Тикеты и апелляции
  • Управлять каналами
  • Управлять ролями
  • Отправлять сообщения
  • Встраивать ссылки
  • Читать историю сообщений
  • Прикреплять файлы
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
  • Содержимое сообщенийMessageContentПривилегированное
Уведомления из соцсетей
Уведомления из соцсетей
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
Рынки
  • Просматривать каналы
  • Отправлять сообщения
  • Встраивать ссылки
  • Прикреплять файлы
  • Серверы, каналы и ролиGuilds
Утилиты
Временные голосовые каналы
  • Управлять каналами
  • Перемещать участников
  • Подключаться
  • Серверы, каналы и ролиGuilds
  • Состояния голосаGuildVoiceStates
Автоматизации
  • Управлять ролями
  • Отправлять сообщения
  • Серверы, каналы и ролиGuilds
Свои команды
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
  • Сообщения на сервереGuildMessages
Конструктор embed-сообщений
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
Каналы со статистикой
  • Управлять каналами
  • Просматривать каналы
  • Подключаться
  • Серверы, каналы и ролиGuilds
Эмодзи
  • Создавать выражения
  • Управлять выражениями
  • Серверы, каналы и ролиGuilds
Поиск
  • Отправлять сообщения
  • Встраивать ссылки
  • Серверы, каналы и ролиGuilds
Запись
  • Просматривать каналы
  • Подключаться
  • Отправлять сообщения
  • Встраивать ссылки
  • Изменить никнейм
  • Серверы, каналы и ролиGuilds
  • Состояния голосаGuildVoiceStates
Платформа
АналитикаДополнительных нет
  • Серверы, каналы и ролиGuilds
Резервные копии
  • Управлять ролями
  • Управлять каналами
  • Серверы, каналы и ролиGuilds
Настройка бота
  • Изменить никнейм
  • Прикреплять файлы
  • Серверы, каналы и ролиGuilds

Команды

Слеш-команды, которые есть в текущем коде. Остальные модули опишут свои команды, когда будут готовы.

Команды
КомандаЧто делаетКто может использовать
/helpПомощь и полезные ссылки.Все
/pingЗадержка и состояние бота.Все
/honeypot setupКанал-ловушка, наказание и удаление сообщений (начинает в режиме наблюдения).Команда с правами
/honeypot publishПубликует или заново публикует предупреждение.Команда с правами
/honeypot enableВключает ловушку — с наказаниями или без, с подтверждением.Команда с правами
/honeypot statusНастройки и счётчики.Команда с правами
/honeypot disableВыключает ловушку (уже начатые софтбаны завершаются).Команда с правами

В клиенте Discord на испанском языке команды называются /ayuda, /honeypot configurar, publicar, activar, estado и desactivar.