reliable discord client irc daemon
1.0.0
Оглавление
Описание
ПРЕДУПРЕЖДЕНИЕ
Функции
Ограничения
Использование
Информация о функции Misc
Случайные советы и хитрости
Ссылки
Больше информации о блокировке сторонних клиентов
API и примечания к реализации
RDIRCD - это демон, который позволяет использовать личную учетную запись Discord через клиент IRC.
Он переводит все частные чаты и общедоступные каналы/потоки на «Серверах дисколов» в каналы на сервере IRC, которые он создает и что вы можете подключиться к использованию обычного клиента IRC, а не к приложению браузера или электронов.
«Надежный» находится в названии, потому что одной из первоначальных целей было подтверждение доставки сообщений и уведомить о любых проблемах в этом отношении, которых в то время не было у других подобных клиентов.
Есть канал IRC, чтобы поговорить об этом - присоединиться к #rdircd на Libera.chat.
IRC URL: IRCS: //IRC.LIBERA.CHAT/RDIRCD (GitHub отказывается делать IRCS: // ссылки)
См. Также раздел ссылок ниже для редко обновления списка других альтернативных клиентов.
URL -адреса репозитория:
Последний из них имеет Git-Notes с Todo List и тому подобное по умолчанию для них.
Хотя я бы не назвал это приложение «ботом» или «автоматизацией стандартных учетных записей пользователей» - намерение здесь не публиковать какие -либо автоматизированные сообщения или что -либо соскребить - почти уверен, что сотрудники Discord считают всех сторонних клиентов «ботами», и требует, чтобы они использовали специальный API второго класса (см. Секции BOT VS Discounts в DiscORDS/Discord/Discord/Discord/Discord/Discord/Gultilly, на все они одобрены, по админозам, подключенные к Discord, не соответствующие его. Пользователь, не являющийся админом.
Это приложение не представляется как «бот» и не использует специфичные для бота конечные точки, поэтому использование его может привести к завершению учетной записи, если обнаружено.
См. Также больше информации о стороннем разделе блокировки клиентов ниже.
Вы были предупреждены! :)
Надежный исходящий заказ сообщений и доставка, с явными уведомлениями о обнаруженных вопросах.
Поддержка как частных, так и для публичных каналов, заказа каналов, потоков, форумов, за исключением создания любых из них.
За сервер и глобальные каналы ловушки для отслеживания общей деятельности.
Настраиваемые локальные псевдонимы/переименование, блок/замены исходящих сообщений, Filexp-Filtering для полученных сообщений.
Поддержка реконфигурации ограниченного времени выполнения через канал #rdircd.control.
Простые и последовательные разногласия для IRC Guild/Channel/Translation имени пользователя.
Ни один из них не будет изменяться после повторного подключения, пересмотра канала или сервера и т. Д. - перевод в основном детерминирован и не зависит от других имен.
Перевод для раздора упоминаний, ответов, вложений, наклеек и смайликов в входящих MSG, других событиях, основных аннотаций для некоторых встроенных ссылок.
Ограниченная поддержка для перевода упоминаний пользователя Discord и смайликов в отправленных сообщениях, изменениях и удалениях.
Легко доступно команды через/тему (/T) в любом канале, например, «/T log 2H», чтобы показать последние 2 часа от отставания или «/T log 2019-01-08», чтобы сбросить отставание с этого момента, в настоящее время, при необходимости, при необходимости, при необходимости, выплачивая несколько партий.
Сообщения, отправленные другими способами (например, браузер), будут переданы и IRC, возможно, исходя из различия, если имя IRC не соответствует переводу Discord-ric Nick.
Полная поддержка Unicode/Использование везде.
Протокол IRC реализован от DOCS IRCV3, но не использует какие-либо не RFC, поэтому должен быть совместим с любыми старыми клиентами. Необязательная обертка.
Обширные параметры протокола и журнала отладки, некоторые доступны во время выполнения через канал #rdircd.debug.
Single Python3 Script, который требует только модуля AIOHTTP, тривиального для запуска или развертывания в любом месте.
Запускается в относительно стабильной площадке памяти ~ 40 м на AMD64, что, вероятно, больше, например, EG Bitlbee-Discord, но лучше, чем эти вкладки Teaky Browser.
Легко настроить и отлаживать без перестройки, GDB, ржавчины и тому подобного.
Только упоминания пользователя и смайлики, отправленные из IRC, переводятся в теги Discord (если включены и с некоторыми причудами, см. Ниже), а не каналы, роли, наклейки, компоненты и т. Д.
Нет поддержки для отправки вложений или встроений любого рода - используйте WebUI для этого, а не IRC.
Discord автоматически аннотирует ссылки, поэтому публикация носителя так же проста.
Не поддерживается никаких действий, специфичных для вынесения внимания, помимо всех видов чтения и отправки сообщений в существующие каналы - т.е. не создавать учетные записи или каналы для раздора, управления ролями, приглашениями, запретами, тайм -аутами и т. Д. - используйте WebUI, гармонию или надлежащие боты.
Создание новых частных чатов и потоков канала/форума не поддерживается.
Для частных чатов это может быть еще опасно для поддержки - см. Больше информации о стороннем разделе блокировки клиентов ниже для получения подробной информации.
Вообще не отслеживает присутствие пользователей (онлайн, офлайн, AFK, игра в игру и т. Д.).
Не излучает пользовательские присоединения /события деталей и очень простым обрабатывает IRC /имена, только перечисляя только ники, которые использовали канал со времен стартапа приложения и в IRC-Name-Timeout (1 день по умолчанию).
Полностью игнорирует все материалы для не текстового чата в целом (например, голос, профили пользователей, библиотека игр, магазин, списки друзей и т. Д.).
Discord Smerks "read_state" на стороне сервера, которая здесь не используется - воспроизведение запуска истории выполняется только вручную (/t команды в Chans), так что иногда его можно легко пропустить при тихих повторных подключениях.
Не поддерживает режим Multifactor Authentication Multifactor, но Auth Rinal -Token, вероятно, может обойти это - см. Примечание на Captchas ниже.
Команды SLASH (для ботов) не поддерживаются каким -либо особым образом, но вы, вероятно, все еще можете отправить их, если клиент IRC пройдет их через.
Не самая удобная вещь, но, вероятно, такая же, как и сам IRC.
Я запускаю его только на Linux, так что вряд ли он будет «просто работать» на OSX/Windows, но IDK.
Пользовательская специальная реализация как Discord, так и IRC, не пользуясь каким-либо экспозицией и тестированием на PYPI и такой совместимости WRT, ошибок и угловых категорий.
Кажется, противоречат руководящим принципам для его использования - см. Раздел предупреждения выше для получения более подробной информации.
На платформе OpenBSD при использовании Scrypt-кодированного IRC password-hash= , также может потребоваться установить модуль Scrypt отдельно (eg pkg_add py3-scrypt ), так как порт Python, похоже, не имеет Hashlib.crypt в его stdlib.
Самым простым способом может быть использование пакета для/из вашего распределения Linux, если он доступен.
В настоящее время известные дистрибутивные пакеты (по состоянию на 2020-05-17):
Также есть Dockerfile и Docker-Compose.yml для запуска этого в докере/подмане или в какой-либо другой, совместимой с OCI в контейнерной среде.
(См. Также readme.docker-permissions.md Doc для информации о проблемах общего доступа с ними)
Должно быть легко установить один сценарий и несколько его зависимостей вручную, как описано в остальной части этого раздела ниже.
На Debian/Ubuntu установка зависимостей может быть сделана с помощью этой одной команды:
# apt install --no-install-recommends python3-minimal python3-aiohttp
Другие дистрибуты Linux, вероятно, также имеют аналогичные пакеты, и я бы порекомендовал использовать их в качестве первого варианта, чтобы они получали обновления и избегали дополнительного локального бремени по техническому обслуживанию, и только отступление на установку модуля (ы) через «PIP», если это не удается.
На любом произвольном дистрибутивах с установленным Python (Python3), использующим PIP/VENV для установки модуля AIOHTTP (и его DEPS) для непривилегированного «RDIRCD» Домашний Дирешн (который также используется для запуска RDIRCD в следующем примере ниже), но выпустить это, если вы уже установили через менеджер пакета ОС или такому: такому: такому: таковой: Такой:
root # useradd -m rdircd
root # su - rdircd
## Option 1: use venv to install dependencies into "_venv" dir
rdircd % python3 -m venv _venv
rdircd % ./_venv/bin/pip install aiohttp
## Option 2: install pip (if missing) and use it directly
rdircd % python3 -m ensurepip --user
rdircd % python3 -m pip install --user aiohttp
Если у вас есть/используете PIPX (например, из репозиторов Distro), его можно использовать для запуска приложений Python, таких как этот, и Auto -Maintain -зависимости -просто «PIPX запустить» Основной скрипт: pipx run rdircd --help -без необходимости прикоснуться к VENV или PIP (PIPX будет делать это «под капюшоном»).
После установки выше требований, сам сценарий может быть извлечен из этого репозитория и запустить так:
## Ignore "useradd" if you've already created a user when running "pip" above
root # useradd -m rdircd
root # su - rdircd
## If using "venv" install example above - load its env vars
# Or alternatively run script via "./_venv/bin/python rdircd ..." command line
rdircd % source ./_venv/bin/activate
rdircd % curl -OL 'https://raw.githubusercontent.com/mk-fg/reliable-discord-client-irc-daemon/master/rdircd{,.unicode-emojis.txt.gz}'
rdircd % chmod +x rdircd
## Use "pipx run rdircd ..." here and below, if using pipx instead of pip/venv/distro-pkgs
rdircd % ./rdircd --help
...to test if it runs...
rdircd % ./rdircd --conf-dump-defaults
...for a full list of all supported options with some comments...
...alternatively, to create rdircd.ini template: ./rdircd -c rdircd.ini --conf-init
rdircd % nano rdircd.ini
...see below for configuration file info/example...
rdircd % ./rdircd --debug -c rdircd.ini
...drop --debug and use init system for a regular daemon...
Для настройки Daemon/Script для запуска на загрузке ОС, файл блока SystemD RDIRC.Service может использоваться в большинстве средств Linux (EDIT EXECSTART = параметры и пути там), или, вероятно, через Script init.d или, возможно, в сеансе «экран» в качестве специального опции Ad-Hoc. Убедитесь, что он работает как пользователь, например, «rdircd», созданный в фрагменте выше, а не как root.
Чтобы обновить сценарий позже, при необходимости, замените его последней версией, например, через повторную загрузку с помощью команды Curl, Git-Pull на клоне Repo, docker-compose up --build , обновление пакета ОС или в некотором роде, обычно связанный с тем, как он был установлен в первую очередь.
Создайте файл конфигурации с учетными данными Discord и IRCD в ~/.rdircd.ini (см. All --conf... выбирайте это):
[irc]
password = hunter2
[auth]
email = [email protected]
password = discord-passwordПримечание. Пароль IRC может быть опущен, но обязательно убедитесь, что брандмауэр из всего в системе (или, возможно, это все равно сделает это).
Если вы устанавливаете пароль, возможно, не используйте параметр IRC password= как выше, и используйте password-hash= и -H/--conf-pw-scrypt чтобы вместо этого генерировать его. В любом случае, обязательно используйте этот пароль при настройке подключения к этому серверу в клиенте IRC.
Start rdircd daemon: ./rdircd --debug
Подключите IRC Client к «Localhost: 6667» - по умолчанию прослушивание/привязка хоста и порт.
-i/--irc-bind -s/--irc-tls-pem-file ./rdircd --conf-dump-defaults
Используйте команду IRC /list , чтобы просмотреть каналы для всех соединенных серверов /гильд:
Channel Users Topic
------- ----- -----
#rdircd.control 1 rdircd: control channel, type "help" for more info
#rdircd.debug 1 rdircd: debug logging channel, read-only
#rdircd.monitor 1 rdircd: read-only catch-all channel with messages from everywhere
#rdircd.leftover 1 rdircd: read-only channel for any discord messages in channels ...
#rdircd.voice 1 rdircd: read-only voice-chat notifications from all discords/channels
#rdircd.monitor.jvpp 1 rdircd: read-only catch-all channel for discord [ Server-A ]
#rdircd.leftover.jvpp 1 rdircd: read-only msgs for non-joined channels of discord [ Server-A ]
...
#me.chat.SomeUser 1 me: private chat - SomeUser
#me.chat.x2s456gl0t 3 me: private chat - some-other-user, another-user, user3
#jvpp.announcements 1 Server-A: Please keep this channel unmuted
#jvpp.info 1 Server-A:
#jvpp.rules 1 Server-A:
#jvpp.welcome 1 Server-A: Mute unless you like notification spam
...
#axsd.intro 1 Server-B: Server info and welcomes.
#axsd.offtopic 1 Server-B: Anything goes. Civility is expected.
Примечания об информации здесь:
/j #axsd.offtopic ( /join ), как вы делаете с обычным IRC, чтобы увидеть /публиковать там MSG.
Каналы соединения/детали в стороне IRC не влияют на раздоры.
Запустить /topic (часто работает как /t ) IRC-Command, чтобы показать больше информации о командах специфики для канала, например, для /t log и воспроизведения, начиная с последнего события до последнего отключения RDIRCD, /t log list , чтобы перечислить все временные метки активности, которые RdIRCD-треки или /t log 2h в журнал /дамп для /из определенного времени (штамп /SPAN) (ISO8601.
Команды управления Daemon/конфигурация доступны в канале #rdircd.control, #rdircd.debug Chan можно использовать для настройки различных журналов и более внимательно осмотреть состояние демона и протоколы, отправьте «справку», чтобы указать доступные команды.
Для широкого обстановки различных поддерживаемых настроек конфигурации см. Файл rdircd.defaults.ini (вывод ./rdircd --conf-dump-defaults ), а также о конкретном использовании тех, которые ниже.
Примечания по различным дополнительным и менее очевидным функциям собираются здесь.
См. Раздел «Использование» для более общей информации.
Несколько файлов INI могут быть указаны с помощью опции -c , переопределяя друг друга в последовательности.
Последнее будет обновлено wrt [state], token = и аналогичные вещи выполнения, а также любые значения, установленные через команды #rdircd.control Channel, поэтому можно было бы быть полезным для указания постоянной конфигурации с помощью Auth и Options, и отдельный (изначально пустой) один для такого динамического состояния.
Например ./rdircd -c config.ini -c state.ini сделает это.
--conf-dump может быть добавлен в печати, получая INI, собранные из всех этих.
-Flag --conf-dump-defaults можно использовать для перечисления всех вариантов и их знаний.
Частые обновления временных лапотоков состояния выполняются на месте (небольшие значения с фиксированной длиной), но проверяют CTME перед записи, поэтому в любом случае должно быть безопасно редактировать любой из этих файлов вручную.
Отправка Shighup в команду «Перезагрузить» в контрольном канале должна загружать и применять значения из всех файлов конфигурации в одном и том же порядке. Обратите внимание, что такая операция не будет сброшена каких -либо значений, отсутствующих в файлах, в их значениях по умолчанию, примените только материал, явно устанавливаемые там поверх текущей конфигурации.
Все чаты в RDIRCD (и Discord) являются каналом .
IRC /Q, /Query и /MSG не могут быть использованы IRC-типичным образом.
Чтобы поговорить в любом частном чате, присоединяйтесь к каналу, таким как #me.chat.
В настоящее время нет способа создать новые частные чаты из RDIRCD, использовать других клиентов или webui для этого (или попросить кого -нибудь связаться с вами в первую очередь), но после создания канала частного чата его также можно использовать в RDIRCD.
См. Также автоматические каналы и /или /или присоединяйтесь к EG #RDIRCD.LEFTOVER.ME Канал для надежного мониторинга частных сообщений, если это необходимо.
Во всех каналах IRC, представляющих канал Discord - Send /topic (или /t - Shorthand для него, часто поддерживаемых у клиентов IRC) - которая должна распечатать актуальную информацию во всех командах, специфичных для каналов, таких как эти:
/t info - покажите некоторую внутреннюю информацию/информацию о канале, например, идентификаторы и тому подобное для переименования.
Следует напечатать точное имя канала на Discord (без каких-либо локальных переимов или перевода раздора на ru-irc, который делает RDIRCD), его тема, тип и т. Д., Помимо прочего.
/t info {user-name...} - Информация о запросе на имя пользователя (или его часть) в этом разногласии.
Например, /t info joe137 будет поиск пользователя joe137 на сервере Discord, которому принадлежит канал, печатает информацию о них, например, их различные имена раздоров.
/t log [state] - история воспроизведения со времен «состояния» (последняя остановка rdircd по умолчанию).
/t log (такой же, как /t log 1 ) может использоваться, например, после перезапуска RDIRCD, чтобы запросить Discord для любых сообщений, которые могли быть опубликованы после того, как он был остановлен, и до того, как он был начат снова (плюс любые другие с тех пор).
Или /t log 0 чтобы проверить историю с момента последнего MSG, который видел RDIRCD, для случаев, когда Discord /Network Flakey, и что -то, возможно, было потеряно таким образом.
(Где эти номера 1 и 0 относятся к сохраненным временным меткам из вывода /t log list , хранящиеся /обновляются в соответствии с [state] в файле INI)
Он также может использоваться с абсолютным или относительным временем, например /t log 15m для запроса /повторной истории канала в течение последних 15 минут, или /t log 2019-01-08 12:30 чтобы воспроизвести историю, так как это конкретное время RDIRCD-локальное (если не указан часовой зон).
Just /t или /topic в любом прокси -канале Discord будет перечислять больше таких команд и больше информации о том, как их использовать.
Последнее сообщение, отправленное на канал Discord, может быть отредактировано с помощью команды SED-повторного обозначения, такую как s/hoogle/google/ для исправления опечатки или быстро изменить/изменить/уточнить эту последнюю строку.
Или //del можно использовать для удаления его - см. Раздел «Быстрые редактирования/удаления» ниже.
@silent Prefix-Command в сообщениях может подавлять уведомления об пользователях об этом (также где-то ниже).
В специальных каналах, таких как #rdircd.control и #rdircd.debug: отправить h или help .
Они могут иметь несколько длинный список поддерживаемых команд, например, вот некоторые команды для #rdircd.control:
status (или st ) может использоваться для проверки Discord и IRC Connection Infos.
Команды connect / disconnect (или on / off ) могут использоваться для ручного управления соединением Discord, например, для более одноразового использования или для временного подавления неудачных предупреждений Conn, в то время как локальная сеть падает таким образом.
set irc-disable-reacts-msgs yes -Уведомления о реакции дискордов Tempable Discord (с помощью команды set ).
Или set -s irc-disable-reacts-msgs yes , чтобы сделать его постоянным ( -s/--save флаг для сохранения значения в файл конфигурации INI) или простой set без параметров, чтобы увидеть все общие параметры конфигурации и их значения.
rx Block mee6 bot-noise = (?i)^<MEE6> -температура все сообщения от Mee6 Bot.
(См. Раздел об этой фильтрации ниже, или больше примеров таких вещей под советами и трюками)
... И есть еще больше из них-тип help там для полной актуальной информации.
#rdircd.monitor может использоваться для вида деятельности с всех подключенных серверов - получает все сообщения, префиксированные соответствующим именем канала IRC.
#rdircd.monitor.guild (где «гильдия» является хэш или псевдонимом, см. Выше)-это аналогичные каналы с уловами для конкретного сервера/гильдии.
#rdircd.monitor.me может быть полезен, например, для мониторинга любых частных чатов и сообщений для учетной записи Discord (см. Также пример автоматических каналов).
#rdircd.leftover и аналогичные каналы #rdircd.leftover.guild похожи на каналы монитора, но пропускают сообщения из любых каналов, которые есть у клиента IRC, включая EG /join #rdircd.leftover.game-x скрывая это, что «Game-X» MSGS от Global Catch-All # # # # # # #zer-hant. «Остатки» в любом случае).
#rdircd.voice-это канал, похожий на #rdircd.monitor, но только улавливает уведомления о событиях голосового чата, чтобы своевременно отслеживать их.
Эти каналы могут быть проигнорированы, если не требуются, или полностью отключены путем настройки, например, chan-monitor к пустому значению в разделе [IRC] INI Config-файл. Например, каналы голосовой активности для каждого рассеяния по умолчанию с ограниченными возможностями.
Файл конфигурации также имеет раздел [UNMONITOR] для необязательного списка имен каналов, чтобы игнорировать в мониторе/оставшихся каналах, например:
[unmonitor]
# All filters are applied to channel names and are case-insensitive
Ignore this particular " bot-commands " channel = game-X.bot-commands
skip forum threads in " game-X " guild = glob:game-X.forum.=*
" wordle " threads in any guild (and chans ending in .wordle) = glob:*.wordle
Don ' t show threads in any forum-like channels = re:^[^.]+ . (forum|discuss) . =.*
disregard all voice-chat stuff = glob:*.vc Ключи (как частично ранее «=») в таком разделе конфигурации игнорируются, и могут быть чем угодно, например, комментарии, объясняющие шаблоны (как в примере выше), в то время как значения являются либо точными именами канала (с префиксом Discord, необязательным #-prefix) или «Glob:»/«Re:»-Prefixed Glob/REGEXP (Shell-like-like или Python regexps), написанные as-heale/e-hepexper/somply-globe <some-key/comment> = glob:<wildcard-pattern> или <some-key/comment> = re:<regexp-pattern> строки-см. Примеры чуть выше.
Имена каналов, соответствующие этими фильтрами, будут отброшены из каналов монитора, так что это можно использовать для определения списка спам-вещей, о которых вам не волнует и не хотите видеть даже там.
Команда "Unmonitor" (или "UM") в #rdircd.control может добавлять/удалять такие фильтры на лето в любое время. См. Также опция конфигурации match-counters , чтобы отслеживать, необходимы ли конкретные правила (ы)/используются.
Сообщения в каналах монитора ограничены определенной длиной/линиями, чтобы избежать чрезмерного наводнения на длинных и/или многострочных MSG. Параметры «Len-Monitor» и «Len-Monitor-Lines» в разделе конфигурации [IRC] могут использоваться для управления этими пределами, см. Существуют также параметры для изменения формата имени монитора.
На IRC у каждого есть одно имя, но это не так с Discord, где каждый пользователь может иметь следующие имена:
login - Discord «Имя пользователя», однозначно идентифицируя каждого пользователя.display - «Показать имя», установленное пользователем в настройках учетной записи Discord, не уникально.nick - сервер и друг "псевдонимы", установленные в настройках сервера Discord, не всегда вам. login является ближайшей концепцией для IRC Percname, так как он является глобально уникальным, последовательным, коротким, только ASCII, и может использоваться путем установки name-preference-order = login в разделе [Discord] (не по умолчанию).
Официальные клиенты Discord сначала отображают другие имена, поэтому опция name-preference-order по умолчанию nick display login , которое сначала использует псевдонимов, специфичные для Discord/Friend, если таковые имеются, возвращаются к имени бесплатной формы, которые пользователь устанавливает в настройках учетной записи, и в противном случае их имя входа в систему.
Другие вещи в причудливых прозвищах пользователя, которые IRC не позволяет заменять общими символами Unicode, пространства с «·», например, средними точками, или <> общими кронштейнами IRC-Nick со стрелками Unicode. Длинные разбороны усечены.
В настоящее время нет уведомлений о IRC о том, что пользователи меняют свой дисплей-дисплей/никюристы, и они не должны быть уникальными, что может затруднить то, чтобы сказать, кто есть кто, если они продолжают менять ники по какой-либо причине.
Все это настраивается через настройки файлов INI (или в канале #rdircd.control), поэтому, если он становится слишком глупым и смягчившим, установите name-preference-order = login для использования уникальных последовательных IRC-дружелюбных ников вместо всех.
IRC /who Command или /topic info может помочь переводу между этими именами, например /t info john1234 может использоваться для печати информации для этого имени /входа в систему в буфере канала, который должен включать всех пользователей с частичным соответствием этого имени в этом конкретном несогласии, в то время как /who командовает все объединенные дискорды.
(больше похоже на «переименование», чем «псевдонимы», так как старые имена не продолжают работать для них)
Может быть определен в файле конфигурации, чтобы заменить префиксы дискордов на основе хэша или имена серверов на что-то более читаемое/запоминающее или значимое для вас:
[renames]
guild.jvpp = game-x
guild.sn3y = log-bot
guild.sn3y.chan-fmt = logs/{name}.log
chan.some-long-and-weird-name = weird
chan.@ 710035588048224269 = general-subs
user.noname123 = my-pal-bob
user.@ 123980071029577864 = joeЭто должно:
Поверните, например, #jvpp.info в #game-x.info-guildoup Guild-ID в более значимый префикс. Это будет применяться ко всем каналам в этом разногласии - «гильдия» переименована.
Изменить формат для названий каналов «sn3y» Discord от чего -то вроде #sn3y.debug на #logs/debug.log - изменение формата имен канала.
Шаблон формата использует синтаксис Python str.format с «именем» (имя канала) и «префикс» (Prefix гильдии - будет «log -bot» в этом примере) значения. Формат по умолчанию {prefix}.{name} .
Эта опция формата не влияет на имя монитора/оставшегося канала (ы) (например, #rdircd.monitor.log-bot или #rdircd.leftover.game-x)-см. «Чан-монитор-гилд» и «варианты« chan-leftover-guild »в разделе [IRC] для изменения этого.
Переименуйте этот длинный канал, чтобы иметь более короткое имя (префикс -поддержание гильдии) - «Чан» переименование.
Обратите внимание, что это затрагивает все гильдии, где существует такое имя канала, и имя источника должно быть в формате IRC, так же, как в /списке, и является RFC1459-Casemaped (так же, как на IRC).
Переименовать канал с ID = 710035588048224269 на «Memes» (префикс поддержанной гильдии) - «Chan» переименование с использованием @Channel -ID Spec.
Этот идентификатор длинного дискорда (также называемый «Snowflake») можно найти путем ввода /t info Teape Command в соответствующем канале IRC, и может использоваться для обозначения этого конкретного канала, то есть переименование этого #General на этом одном сервере Discord вместо переименования всех #General каналов повсюду.
Это особенно полезно, когда два канала имеют одинаковое точное имя в одном разногласии и обычно будут назначены .<id-hash>
Переименовать пары пользователей, на которые ссылаются их имя пользователя Discord и ID.
/t info <nick-or-part-of-it> команда в канале Discord или аналогичном /who IRC-Command может помочь поискать идентификаторы дискордов, как используемые там.
В настоящее время внедряются только переименованные типы переименования для префиксов и каналов раздора, но в разделе [IRC] также есть варианты, чтобы установить имена для системных/мониторов/оставшихся каналов и лично-чата-«CHAN-SYS», «Chan-Private», «Чан-монитор» и тому подобное (см.
Установите, например, chan-monitor-guild = {prefix} чтобы #Game-X Channel был уловлен для всех сообщений в этом разногласии, без по умолчанию long #rdircd.monitor.* Префикс.
Отдельные частные сообщения создают и отправляются в каналы на сервере/гильдии «Me», так же, как и в Discord Webui, и могут взаимодействовать так же, как и любая другая гильдия/каналы (список, присоединение/часть, отправка/Recv MSG и т. Д.).
Присоединяйтесь к #rdircd.monitor.me (или #rdircd.monitor, см. Выше), чтобы получить там все новые MSG/чаты, а также уведомления об изменении отношений (запросы/добавление/добавление/удаление) в качестве уведомлений.
Принятие запросов в друзья и добавление/удаление их можно сделать с помощью обычного Webui и не реализована в этом клиенте каким -либо образом.
См. Также раздел «Автообольный канал» ниже для проста для проможенного способа всплывать новые частные чаты в клиенте IRC с помощью Invites.
«Потоки»-это функция Discord, позволяющая пользователям, не являющимся админом, в любое время создавать переходные специальные подканалы для конкретной темы, которые автоматически восстанавливаются («архивировано») после относительно короткого тайм-аута бездействия (например, день).
Каналы Discord «Forum» - это в основном каналы, где люди могут создавать и говорить только в Theads, со списком тех, кто заменяет болтовню канала по умолчанию.
Все неархивные потоки должны быть показаны в списке каналов RDIRCD в качестве обычных каналов IRC, с такими именами, как #gg.general. = Vot5.Lets · обсудить · материал, расширяя имя родительского имени потока ("= vot5" в этом примере) и, возможно, спяченное имя потока (см. «Поток-черновой вариант конфигурации).
Существует несколько вариантов того, как увидеть и взаимодействовать с потоками из родительского канала (в основном в разделе [Discord], см.
[irc]
thread-chan-name-len = 30
[discord]
thread-id-prefix = =
thread-msgs-in-parent-chan = yes
thread-msgs-in-parent-chan-monitor = no
thread-msgs-in-parent-chan-full-prefix = no
thread-redirect-prefixed-responses-from-parent-chan = yes
...Но даже со всеми этими отключенными, на канал следует отправлять простое уведомление, чтобы запустить потоки, чтобы никто не пропустил их полностью.
Не существует поддержки создания новых потоков из IRC, неотъемлемых старых или иных управления этими, и присоединение к каналу потока в IRC на самом деле не «соединять поток» в пользовательском интерфейсе Discord (прикрепление под именем канала), но публикация чего -либо должно делать это автоматически.
Настройка «Chan-Auto-join-re» в разделе [IRC] позволяет указать regexp в соответствии с именем канала (без # prefix) с автоматическим Join, когда в них появляются какие-либо сообщения.
Например, для автоматической инстанции любого #me.* Можно использовать каналы (прямые сообщения), следуя регулярному значению выражения (Python «re»):
[irc]
chan-auto-join-re = ^me. Или для того, чтобы иметь ARC Client Auto-join все каналы, используйте chan-auto-join-re = .
Пустое значение для этого параметра (по умолчанию) ничего не совпадает.
Это можно использовать в качестве альтернативы отслеживанию новых вещей через #rdircd.monitor/оставшиеся каналы.
Эта Regexp может быть настроена во время выполнения, используя команду «Установить» в канале #rdircd.control, так же, как и любые другие значения, например, для временного включения/отключения этой функции для конкретных разногласий или каналов.
Упоминания-это теги @username на Discord, предназначенные для того, чтобы предупредить кого-то о прямом сообщении.
С помощью конфигурации по умолчанию, когда вы видите, например, <Galaxy?·Brain> Hi! И хочу ответить на них подчеркнуть, отправив Hey @galaxy and welcome , вероятно, должно работать. Можно также использовать свой полный IRC Nick, чтобы быть уверенным.
Как это работает: если RDIRCD соответствует msg-mention-re Regexp Conf-Option против чего-то в отправленном сообщении (например, @galaxy @-mention выше), это рассматривается как «упоминание», которое либо однозначно сопоставлено и переводится в упоминание о присвоении в отправленном сообщении, либо возвращает уведомление об ошибке (с ники, которые совпадают, что существенно, если все).
Значение по умолчанию должно выглядеть так:
[discord]
msg-mention-re = (?:^|s)(@)(?P<nick>[^s, ; @+!]+) Что будет соответствовать любому слову, похожее на пространство или пунктуацию, разделенные @nick упоминаться в отправленных строках.
REGEXP (Python «RE» синтаксис) должен назвать группу «NICK» со строкой LICK/USERNAME Lookup, которая будет заменена на тег Discord Mange, и все другие группы захвата ( @ ONES без ?:
Regexp выше по умолчанию должна по-прежнему разрешать отправлять @something , чтобы показаться не зажиганным в веб-приложении (и без из-за разметки), так как это не будет сопоставлено (?:^|s) часть из-за этого префикса BackSlash.
В качестве другого примера, чтобы иметь классические основные моменты в стиле IRC в начале линии, может быть использован режим regexp:
msg-mention-re = ^(?P<nick>S+)(:)(?:s|$)
И должен перевести, например, mk-fg: some msg в @mk-fg some msg (с @-part упоминается). Тяжелое пространство включено в REGEXP, чтобы избежать соответствия ссылок на URL.
Для идентификационного пользователя Discord Group будет использоваться следующими способами:
Нечувствительный матч со всеми недавними именами IRC, связанных с гильдией (авторы сообщений, реакции, частные пользователи канала и т. Д.). user-mention-cache-timeout Config Option Controls «Недавний» тайм-аут.
Поиск уникального имени
Если не найдено кэшируемого или уникального совпадения - уведомление об ошибке будет выпущено, а сообщение не отправлено.
Такое строгий поведение предназначено для того, чтобы избежать каких-либо непреднамеренных неправильных трансляций, и выделение неправильного человека, как правило, должно быть возможным только путем написания неправильно.
Связанный вариант msg-mention-re-ignore (REGEXP, чтобы соответствовать полному захвату шаблона выше), также может использоваться для пропущения некоторых безымянных вещей из обработки как таковых, которые в противном случае были бы подняты с помощью первого режима режима, что также лишает улавливания групп, которые можно использовать, например, отменить сбежание.
Обратите внимание, что списки пользователей Discord могут быть довольно массивными (500K+ пользователи), не разделены каналом и не предназначены для предварительного вынесения клиентом, запрашиваемые только для завершений или видимых частей, которые не хорошо сопоставляются с IRC, отсюда и все это волшебство.
Подобный regexp настроен для смайликов для каждого дискарда:
msg-emoji-re = (?:^|s)(:)(?P<emoji>w+)(:)(?=[^w]|$)
Где, например, I use :Arch: btw от IRC будет соответствовать этой группе Regexp, поиска/замены группы "Emoji", используя эмодзи этого разногласий (нечувствительны к случаю), и либо отправляйте его переводящимся по I use ? btw , или уведомление об ошибке возврата, если такой эмодзи недоступен в этом разногласии, а не в списке общих юникодных.
Установите msg-mention-re / msg-emoji-re на пустое значение, чтобы отключить такие переводы.
Подобно упоминаниям пользователя Discord, упоминается выше, существует специальная переоборудование, которое соответствует командам, которые будут интерпретироваться как редактирование или удаление последнего сообщения, отправленного на этот канал.
Руководство по умолчанию выглядят примерно так (проверьте-conf-dump-defaults jic):
[discord]
msg-edit-re = ^s*s(?P<sep>[/|:])(?P<aaa>.*)(? P =sep)(?P<bbb>.*)(? P =sep)s*$
msg-del-re = ^s*//dels*$ Они соответствуют SED/PERL/IRC-подобным линиям последующих последующих линий, таких как s/spam/ham/ и //del Line, которые никогда не будут отправлены в Discord, используемые только в качестве внутренних команд.
( s|/some/path|/other/path| and s:cat /dev/input/mouse0 | hexdump:hexdump </dev/input/mouse0: синтаксисы также разрешены по умолчанию, как в них, так же, как с SED, для более легкой обработки общих вещей, таких как пути, которые могут иметь в них эти чары), как с SED, для более легкого обработки общих вещей, таких как эти чары), как и с SED, для более легкой обработки общих вещей, которые могут иметь эти чары).
Обе команды, соответствующие этим, работают на последнем сообщении, отправленном RDIRCD в один и тот же канал дискордов, с //del просто удаляет это последнее сообщение и редактируйте функцию запуска Python re.sub () (PCRE-подобное) функцию Regexp, воспроизводимую.
"msg-edit-re" regexp option value matching sed-like command must have named "aaa" and "bbb" groups in it, which will be used as pattern and replacement args to re.sub(), respectively.
If edit doesn't seem to alter last-sent message in any way, it gets discarded, and also generates IRC notice response, to signal that replacement didn't work.
Successful edit/deletion should also be signaled as usual by discord, with [edit] or such prefix (configurable under [irc] section).
Any older-than-last messages can be edited through Discord WebUI - this client only tracks last one for easy quick follow-up oops-fixes, nothing more than that.
Somewhat similar to quick edits/deletes above, "msg-flag-silent-re" option is there to match/remove "@silent" prefix in messages (by default), which disables sending discord push notifications for it, same as with the official client.
That and similar message flags on incoming messages are not represented in any way, as they don't seem to be relevant for an irc client anyway.
Config can have a [send-replacements] section to block or regexp-replace parts of messages sent (by you) from IRC on per-discord basis.
This can be used to add discord-specific tags, unicode shorthands, emojis, stickers, block/replace specific links or maybe even words/language before proxying msg to discord.
Here's how it can look in the ini file(s):
[send-replacements]
*. unicode-smiley = (^| ):)( |$) -> 1?2
*. twitter-to-nitter = ^(https?://)((mobile|www).)?twitter.com(/.*)?$ -> 1nitter.ir4
guildx.never-mention-rust! = (?i)brustb -> <block!>
guildx.localize-color-word = bcolor(ed|iS+)b -> colour1 Where each key has the form of discord-prefix> "." comment , with a special * prefix to apply rule to all discords, while values are regexp " -> " <replacement_or_action with one special <block!> action-value to block sending msg with error-notice on regexp match. "comment" part of the key can be any arbitrary unique string.
So when sending eg test :) msg on IRC, discord will get test ? Полем
Same as with other regex-using options, regexps have python "re" module syntax, applied via re.sub() function, using raw strings from config value as-is, without any special escapes or interpretations.
Replacements are applied in the same order as specified, but with * keys preceding per-discord ones, and before processing to add discord tags, so anything like @username that can normally be typed in messages can be used there too.
#rdircd.control channel has "repl" command to edit these rules on-the-fly.
If you join #rdircd.monitor channel, see - for example - a message like this:
<helper-bot> #pub.welcomes :: Welcome!
...and think "don't want to see messages like that again!" - config files' [recv-regexp-filters] section or corresponding "rx" command in #rdircd.control channel can help.
Depending on what "messages like that" means, here are some ways to filter those out:
[recv-regexp-filters]
discard msgs from this bot = ^<helper-bot>
ignore all msgs in that channel of that discord = ^S+ # pub.welcomes ::
drop all msgs from " pub " discord = ^S+ # pub.
no messages from # welcomes channels of any discord pls = ^S+ #w+.welcomes ::
never see " Welcome! " message-text again!!! = ^S+ # S+ :: Welcome!$
some combination of the above = (?i)^<helper-bot> # w+.welcomes ::
...(tweak eg last example on regex101.com for more hands-on understanding)
Lines in that section have the usual <key> = <regexp> form, where <key> part can be anything (eg comment to explain regexp, like in examples above), and <regexp> value is a regular expression to match against the message in <user> #discord.channel-name :: message text format like that helper-bot msg presented above, and same as can be seen in monitor-channels.
Any message received from discord will be matched against all regexps in order, stopping and discarding the message everywhere on first (any) match. So it might be a good idea to write as precise patterns as possible, to avoid them matching anything else and dropping unrelated messages accidentally.
Same as with some other conf options, basic knowledge of regular expressions might be needed to use such filters - here's a link to nice tutorial on those (though there are 100s of such tutorials on the web).
Particular regexps here use PCRE-like python re syntax, with re.DOTALL flag set ( . matches newlines in multiline messages). I'd also recommend commonly adding (?i) case-insensitive-match flag, as IRC nicks and channel names ignore character case and can be displayed in misleading/inprecise ways in the client.
More random examples of [recv-regexp-filters], incl. more advanced CNF weirdness:
[recv-regexp-filters]
disregard wordle thread there = ^S+ # pub.general.=w8mk.wordle ::
ignore " wordle " threads everywhere = ^S+ # S+.=w{4}.wordle ::
activity-level bots are annoying = (?i) advanced to level d+[ !]
gif replies of YY in ZZ = (?i)^<YY> # ZZ.S+ :: (-- re:[^n]+n)?[att] .*/imaged.gif?
; ; Advanced stuff: connect multiple regexps via CNF logic (Conjunctive Normal Form)
; ; If key starts with "∧ " (conjunction symbol), it's AND'ed with previous regexp
; ; ¬ (negation) in that prefix inverts the logic, so e.g. "∧¬ ..." is "and not ..."
; ; Disjunction (∨) is the default behavior and doesn't need the (implied) prefix
; ; Any complex logical expression can be converted to such CNF form -
; ; - use calculators like https://www.dcode.fr/boolean-expressions-calculator
Drop welcome msgs in welcome-chans = (?i)^S+ # w+.S*welcomeS* :: .*bwelcomeb.*
∧ but only if they have an exclaimation mark in them somewhere = :: .*!
∧¬ and not from this specific " lut " discord-prefix = ^S+ # lut.
Most channels here are not relevant = ^S+ # myc.
∧¬ except these ones = ^S+ # myc.(announcements|changelog|forum)[. ]
∨ but skip github CI logs there = ^<github> # myc.Pretty much anything can be matched with clever regexps, so CNF-logic stuff like in last examples is seldom useful, but might still be simpler than expressing arbitrary ordering or negation in regexps.
See also match-counters config option to keep track of whether specific rule(s) are still needed/being-used.
Mostly useful for debugging - /who command can resolve specified ID (eg channel_id from protocol logs) to a channel/user/guild info:
/who #123456 - find/describe channel with id=123456./who %123456 - server/guild id info./who @123456 - user id lookup.All above ID values are unique across Discord service within their type.
/who @John·Mastodon - user IRC nick or name/login lookup.
Queries all joined discords for that name, and can return multiple results for same or similar non-unique names. Can be useful to check exact nick/display/login names corresponding to an IRC name, or other user info.
/who *665560022562111489 - translate discord snowflake-id to date/time.
Results of all these commands should be dumped into a server buffer (not into channels), regardless of where they were issued from.
In irc channels corresponding to ones on discord, /topic info command (often works as shortened /t info in clients too) can be used to print more information about linked discord channel and its server/guild.
/t info <username> can also print info on user in that discord (unlike /who @<username> which looks the name up in all connected discords), for example /t info john will print info for anyone with "john" in the name.
Usernames in these queries can match exact irc name or discord username, in which case that result is returned, or otherwise more general server-side lookup is made, which can return matches in any type of discord name(s) (see People's names on discord for more info on those).
Discord name translation is "mostly" deterministic due to one exception - channels with same (casemapped) IRC name within same server/guild, which discord allows for.
When there is a conflict, chan names are suffixed by .<id-hash> (see chan-dedup-* config options), to allow using both channels through IRC. Renaming conflicting channels on Discord will rename IRC chans to remove no-longer-necessary suffixes as well. Such renames affect thread-channels too.
Note that when channels are renamed (including name conflicts), IRC notice lines about it are always issued in affected channels, and any relevant monitor/leftover channels, topic should be changed to reflect that old-name channel is no longer useful, and posting msgs there should emit immediate warnings about it.
Discord CDN URLs for attachments can end up being quite long with same host, long discord/channel IDs in there, then actual filename, and ?ex=...&is=...&hm=... trail of CDN parameters after that.
Many Linux IRC clients run in Terminal Emulators though, which often support OSC 8 terminal hyperlink standard, so can display clickable links in a much more compact and readable form.
For example, this attachment URL to a Discord CDN:
https://cdn.discordapp.com/attachments/1183893786254905414/1206216641877377024/20240211_My_Cat_Photo.jpg?ex=65db33c9&is=65c8bec9&hm=9c1dbecbfb2f9edf2302ec078f5e62fffa7f8c2f32e5cd6e3563ae25d8a356e1&
Can be displayed in a terminal like this instead: 20240211_My_Cat_Photo.jpg
Ie same as how one would see hyperlinks displayed in a browser.
This is disabled by default, but if you use terminal IRC client that might support those, set terminal-links = yes option in config file or via set command in an #rdircd.control channel to try it out.
Adjacent terminal-links-re and terminal-links-tpl options can be used to control which part of the link to display as its visible name, which terminal-specific escape characters to use, and such customization.
Discord has voice channels, where in addition to text people can talk verbally, share camera or screen capture (aka streaming, screen sharing). IRC protocol does not support anything like this of course, but it can be useful to get notified when someone starts talking, to hop into different discord client (eg open it in a browser), and use these channels from there.
All IRC channels corresponding to discord voice chats automatically get .vc suffix (unless renamed), and get notice messages about voice activity in there, but limited to following events, to avoid being too spammy:
voice-notify-after-inactivity timeout of inactivity (ie since previous voice-status notification there), default = 20 minutes. And with additional rate-limit set by voice-notify-rate-limit-tbf value, to notify about up to 5 events in a row, but otherwise no more often than once in 5 minutes ("token bucket algorithm" is technically how this limit is implemented/works).
If description above sounds confusing, here's config tweaks to remove all limits on voice-activity event notifications - try those, and maybe re-read this section later if they get too spammy (maybe never!):
[discord]
voice-notify-after-inactivity = 0
voice-notify-rate-limit-tbf = 0#rdircd.voice monitor-channel(s) can also be used to only track voice-chat notifications across discords/channels, potentially filtered via "um" command in #rdircd.control or [unmonitor] in ini config(s).
IRC convention is to treat mention of a nickname as a "highlight" - a more notification-worthy event than a regular channel message, so it might be useful if messages in private channels did always highlight the nick for IRC client.
prefix-all-private option can be used for that:
[irc]
prefix-all-private = mynick: Might also be necessary to either join monitor/leftover channels or setup auto-joining channels for new PMs to be received by IRC client at all.
Private chats are not implemented via direct IRC messages for various practical reasons, ie to have everything work via channels, because it works that way on the discord side, they can have multiple users, to list those easily, to query topic/history/etc there, and such stuff.
There is a similar prefix-all option, to add prefix to all messages, if prefix-all-private doesn't go far enough.
By default, [discord] msg-ack=yes enables sending (delayed) ACKs for received messages in private chats, so that discord counts those as read and doesn't send an email notification about them. This can be disabled or adjusted in config file.
Messages blocked by eg [recv-regexp-filters] or received when there are no IRC clients connected don't count.
If IRC client supports IRCv3 typing notifications and has these enabled, rdircd will forward those from discord users/channels by default, which can be disabled by setting typing-interval = 0 in [irc] configuration section, or interval/timeout values can be adjusted there to work better for IRC app.
Separate typing-send-enabled option controls whether typing notifications from IRC are sent to a discord channel. It is disabled by default for privacy reasons, and likely needs to be explicitly enabled in IRC client as well.
Any IRCv3 features like that typing stuff can also be disabled via ircv3-caps option, eg if there're problems with them in rdircd or client.
This should happen by default when discord gateway responds with op=9 "invalid session" event to an authentication attempt, not reconnecting after that, as presumably it'd fail in the same way anyway.
This would normally mean that authentication with the discord server has failed, but on (quite frequent) discord service disruptions, gateway also returns that opcode for all logins after some timeout, presumably using it as a fallback when failing to access auth backends.
This can get annoying fast, as one'd have to manually force reconnection when discord itself is in limbo.
If auth data is supposed to be correct, can be fixed by setting ws-reconnect-on-auth-fail = yes option in [discord] ini section, which will force client to keep reconnecting regardless.
Don't know why or when it happens, but was reported by some users in this and other similar discord clients - see issue-1 here and links in there.
Fix is same as with bitlbee-discord - login via browser, maybe from the same IP Address, and put auth token extracted from this browser into configuration ini file's [auth] section, eg:
[auth]
token = ...See "Usage" in README of bitlbee-discord (scroll down on that link) for how to extract this token from various browsers.
Note that you can use multiple configuration files (see -c/--conf option) to specify this token via separate file, generated in whatever fashion, in addition to main one.
Extra token-manual = yes option can be added in that section to never try to request, update or refresh this token automatically in any way. Dunno if this option is needed, or if such captcha-login is only required once, and later automatic token requests/updates might work (maybe leave note on issue-1 if you'll test it one way or the other).
Never encountered this problem myself so far.
Most likely source of that should be missing handling for some new/uncommon discord events, or maybe a bug in the code somewhere - either can be reported as a github issue.
To get more information on the issue (so that report won't be unhelpful "don't work"), following things can be monitored and/or enabled:
Standard error stream (stderr) of the script when problem occurs and whether it crashes (unlikely).
If rdircd is run as a systemd service, eg journalctl -au rdircd should normally capture its output, but there are other ways to enable logs listed just below.
rdircd shouldn't normally ever crash, as it handles any errors within its own loop and just reconnects or whatever, but obviously bugs happen - there gotta be some python traceback printed to stderr on these.
Find a way to reproduce the issue.
When something weird happens, it's most useful to check whether it can be traced to some specific discord and event there (eg some new feature being used), or something specific you did at the time, and check whether same thing happens again on repeating that.
That's very useful to know, as then problem can be reproduced with any kind of extra logging and debugging aids enabled until it's perfectly clear what's going on there, or maybe how to avoid it, if fixing is not an option atm.
Join #rdircd.debug channel - any warnings/errors should be logged there.
Send "help" (or "h") msg to it to see a bunch of extra controls over it.
Sending "level debug" (or "d") there for example will enable verbose debug logging to that channel (can be disabled again via "level warning"/"w"), but it might be easier to use log files for that - see below.
Enable debug and protocol logs to files.
In any loaded rdircd ini file(s), add [debug] section with options like these:
[debug]
log-file = /var/log/rdircd/debug.log
proto-log-shared = no
proto-log-file = /var/log/rdircd/proto.log /var/log/rdircd dir in this example should be created and accessible only to running rdircd and ideally nothing else, eg creating it as: install -m700 -o rdircd -d /var/log/rdircd
Such opts should enable those auto-rotating log files, which will have a lot of very information about everything happening with the daemon at any time.
Both of these can also be enabled/controlled and/or queried at runtime from #rdircd.debug chan.
proto-log-shared option (defaults to "yes") and be used to send discord/irc protocol logging to same log-file or #rdircd.debug channel, but it might be easier to have two separate logs, as in example above.
Log file size and rotation count can be set via log-file-size , log-file-count , proto-log-file-size , proto-log-file-count options - run rdircd --conf-dump-defaults to see all those and their default values (rdircd.defaults.ini has some recent-ish copy too).
When running with protocol logs repeatedly or over long time, proto-log-filter-ws option can be handy to filter-out spammy uninteresting events there, like GUILD_MEMBER_LIST_UPDATE.
Note that these files will contain all sorts of sensitive information - from auth data to all chats and contacts - so should probably not be posted or shared freely on the internet in-full or as-is, but can definitely help to identify/fix any problems.
Running /version IRC-command should at least print something like host 351 mk-fg 22.05.1 rdircd rdircd discord-to-irc bridge on the first line, which is definitely useful to report, if it's not the latest one in this git repo.
Generally if an issue is easy to reproduce (eg "I send message X anywhere and get this error"), it can be reported without digging much deeper for more info, as presumably anyone debugging it should be able to do that as well, but maybe info above can still be helpful to identify any of the more non-obvious problems, or maybe give an idea where to look at for fixing or working around these.
Some configuration tweaks that I use, or mentioned in #rdircd on IRC and such.
Feel free to suggest any other lifehacks to add here.
Normally rdircd uses these long strange "#rdircd.monitor" channel name templates, as well as unnecessary "#me.chat." prefixes, instead of this:
#DMs
#@some-friend
#@some-friend+other-friend+more-ppl
#rdircd
#rdircd.rest
#rdircd.voice
#rdircd.control
#rdircd.debug
#minecraft
#minecraft.general
#minecraft.modding
#minecraft.rest
Use these lines in any loaded ini config file to make it work like that:
[irc]
chan-monitor = rdircd
chan-leftover = rdircd.rest
chan-monitor-guild = {prefix}
chan-leftover-guild = {prefix}.rest
chan-private = {names}
[renames]
guild.me = DMs
guild.me.chan-fmt = @{name}What these options do, in the same order: rename "#rdircd.monitor" to "#rdircd", set names for all discord-specific monitor channels to just "{prefix}" (eg "#dm" or "#minecraft"), set private-chat channels to use people's name(s) without "chat." prefix, rename default "me" guild (private chats) to "DMs", use simpler @ + name format for any channels there.
Defaults are that way to try to be more explicit and descriptive, but once you know what all these channels are for, can easily rename them to something shorter/nicer and more convenient for yourself.
When message is edited, you normally get something like [edit] new msg text , but it can be ✍️ new msg text or new msg text instead:
[irc]
prefix-edit =
prefix-embed = ?.{}
prefix-attachment = ?️
prefix-uis =
prefix-interact = ?
prefix-poll = ?️.{} Note the "space and backslash" at the end in these options, which is to preserve trailing spaces in values, from both text editors that strip those and configuration file parser (which ignores any leading/trailing spaces, unless punctuated by backslash). prefix-embed and poll values need {} placeholder for where to put short id/tag.
Alternatively, set-command like set irc-prefix-edit '✍️ ' can be used in #rdircd.control to configure and tweak this stuff on-the-fly (or -s/--save into config too).
Unless OSC 8 hyperlinks for terminal IRC clients option is enabled, attachments normally are just a long link with a filename buried in there:
<user> ?️ https://cdn.discordapp.com/attachments/813633048368761786/1313964897464246919/cat-pic.jpg?ex=674e6959&is=674d17d9&hm=2519bb427b1392bce87a0749ed664520d25493e509b8272170a66512f9e143d2&
But same OSC8-formatting feature can be used to get a bit more readable version for eg GUI IRC clients:
<user> ?️ cat-pic.jpg LCak :: https://cdn.discordapp.com/attachments/813633048368761786/1313964897464246919/cat-pic.jpg?ex=674e6959&is=674d17d9&hm=2519bb427b1392bce87a0749ed664520d25493e509b8272170a66512f9e143d2&
Using config like this:
[discord]
terminal-links = yes
terminal-links-emojis = no
terminal-links-tpl = {name} :: {url}("LCak" bit at the end of "cat-pic.jpg LCak" is hash of the link, so that it's possible to tell different "image.jpg" attachments apart at a glance)
Using discord through IRC can be a bit noisy due to edits or spammy notifications ending up in various monitor/leftover channels or other un-irc-like features, which rdircd can help mitigate to some degree, but often doesn't by default, as it's hard to know what other people actually care about.
Here are some random commands to try out in #rdircd.control channel:
um Noise from any bot-channels = re:.bots?(-.*)?$
um Ignore welcome chans = glob:*.welcomes
um Disregard all voice-chat events = glob:*.vc
um Memes belong in a circus = glob:*.memes
um Make food channels opt-in = glob:*.food
um Internet "politics" can get really spammy = glob:*.politic*
um There're probably better places for porn = glob:*.nsfw
rx MEE6 bot-noise anywhere = (?i)^<MEE6>
rx THX discord: people spamming edits = (?i)^<(person1|person2)> #THX.S+ :: [edit]
rx NSC: don't care about deletes = ^S+ #NSC.S+ :: --- message was deleted ::
rx NSC/THX: disable reactions here = ^S+ #(NSC|THX).S+ :: --- reacts:
Enable rule-hit counters to check whether these rules are still relevant later:
set discord-match-counters '1d 2d 4d 1w 2w 1mo 2mo runtime'
With these enabled, running um or rx should show [ rule hits: ... ] under each rule, if there's anything to show (but reset on rdircd restarts!), otherwise it's probably safe to drop unused rules to keep lists more tidy.
Disable "reacts" noise everywhere: set irc-disable-reacts-msgs yes
Remove long, confusing and silly nicknames full of unicode junk:
set discord-name-preference-order 'login'
If even ascii logins of specific users get annoying, use [renames] in config to change those locally (see Local Name Aliases section for more info):
[renames]
user.somereallylongandsillyloginbecausewhynot = bob
user.@ 374984273184829999 = andy Keep threads only as channels, and in #rdircd.leftover.* and such:
set discord-thread-msgs-in-parent-chan no
Don't show voice-chats or "monitor" channels on the /list :
set irc-chan-voice '' set irc-chan-monitor ''
All of these examples are not persistent, just to try them out and see, but all commands used there support -s flag to save changed values to last .ini config file, or it can be done manually as well, if any of these are useful to keep around.
There is a good and well-maintained list of alternative clients here:
There are many alt-clients these days, with a lot of churn among them, and dedicated lists like that are probably best way to discover those.
As mentioned in the "WARNING" section above, Bot vs User Accounts section in API docs seem to prohibit people using third-party clients, same as Discord Community Guidelines. Also maybe against their Discord Developer Terms of Service, but dunno if those apply if you're just using the alt-client.
I did ask discord staff for clarification on the matter, and got this response around Nov 2020:
Is third-party discord client that uses same API as webapp, that does not have any kind of meaningful automation beyond what official discord app has, will be considered a "self-bot" or "user-bot"?
Ie are absolutely all third-party clients not using Bot API in violation of discord ToS, period?
Or does that "self-bot" or "user-bot" language applies only to a specific sub-class of clients that are intended to automate client/user behavior, beyond just allowing a person to connect and chat on discord normally?
Discord does not allow any form of third party client, and using a client like this can result in your account being disabled. Our API documentation explicitly states that a bot account is required to use our API: "Automating normal user accounts (generally called "self-bots") outside of the OAuth2/bot API is forbidden, and can result in an account termination if found."
Another thing you might want to keep in mind, is that apparently it's also considered to be responsibility of discord admins to enforce its Terms of Service, or - presumably - be at risk of whole guild/community being shut down.
Got clarification on this issue in the same email (Nov 2020):
Are discord server admins under obligation to not just follow discord Terms of Service themselves (obviously), but also enforce them within the server to the best of their knowledge?
Ie if discord server admin knows that some user is in violation of the ToS, are they considered to be under obligation to either report them to discord staff or take action to remove (ban) them from the server?
Should failing to do so (ie not taking action on known ToS violation) result in discord server (and maybe admins' account) termination or some similar punitive action, according to current discord ToS or internal policies?
Server owners and admin are responsible for moderating their servers in accordance with our Terms of Service and Community Guidelines. If content that violates our Terms or Guidelines is posted in your server, it is your responsibility to moderate it appropriately.
So unless something changes or I misread discord staff position, using this client can get your discord account terminated, and discord admins seem to have responsibility to ban/report its usage, if they are aware of it.
Few other datapoints and anecdotes on the subject:
Don't think Discord's "Terms of Service" document explicitly covers third-party client usage, but "Discord Community Guidelines" kinda does, if you consider this client to be "self-bot" or "user-bot" at least.
Only thing that matters in practice is likely the actual staff and specific server admins' position and actions on this matter, as of course it's a private platform/communities and everything is up to their discretion.
Unrelated to this client, one person received following warning (2020-01-30) after being reported (by another user) for mentioning that they're using BetterDiscord (which is/was mostly just a custom css theme at the time, afaik):
In September 2021 there was a bunch of issues with people using different third-party clients being asked to reset their passwords daily due to "suspicious activity", raised here in issue-18 (check out other links there too), which seem to have gone away within a week.
At least one person in that issue thread also reported being asked for phone account verification for roughly same reason about a week after that, so maybe "suspicious activity" triggering for 3p clients haven't really gone away.
Cordless client developer's acc apparently got blocked for ToS violation when initiating private chats. This client doesn't have such functionality, but maybe one should be more careful with private chats anyway, as that seem to be a major spam vector, so is more likely to be heavily-monitored, I think.
In the #rdircd IRC channel, a person mentioned that their discord account got some anti-spam mechanism enabled on it, disallowing to log-in without providing a phone number and SMS challenge (and services like Google Voice don't work there), immediately after they've initiated private chat with someone in Ripcord client.
"I contacted support at the time and they just responded that they can't undo the phone number requirement once it has been engaged"
It also seems like Ripcord currently might be trying to mimic official client way more closely than rdircd script here does (where latter even sends "client"/"User-Agent" fields as "rdircd" and appears that way under Devices in User Settings webui), and such similarity might look like Terms of Service violation to Discord (modifying official client), instead of Community Guidelines violation (third-party client), but obviously it's just a guess on my part as to whether it matters.
There are also some HN comments clarifying Discord staff position in a thread here, though none of the above should probably be taken as definitive, since third-party and even support staff's responses can be wrong/misleading or outdated, and such treatment can likely change anytime and in any direction, without explicit indication.
Note: only using this API here, only going by public info, can be wrong, and would appreciate any updates/suggestions/corrections via open issues.
Last updated: 2024-11-26
Discord API docs don't seem to cover "full-featured client" use-case, likely because such use of its API is explicitly not supported, and is against their rules/guidelines (see WARNING section above for details).
It's possible that more recent official OpenAPI spec in discord/discord-api-spec repo has a more complete documentation though.
Discord API protocol changes between versions, which are documented on Change Log page of the API docs.
Code has API number hardcoded as DiscordSession.api_ver, which has to be bumped there manually after updating it to handle new features as necessary.
Auth uses undocumented /api/auth/login endpoint for getting "token" value for email/password, which is not OAuth2 token and is usable for all other endpoints (eg POST URLs, Gateway, etc) without any prefix in HTTP Authorization header.
Found it being used in other clients, and dunno if there's any other way to authorize non-bot on eg Gateway websocket - only documented auth is OAuth2, and it doesn't seem to allow that.
Being apparently undocumented and available since the beginning, guess it might be heavily deprecated by now and go away at any point in the future.
There are some unofficial docs for officially-undocumented APIs and quirks:
Sent message delivery confirmation is done by matching unique "nonce" value in MESSAGE_CREATE event from gateway websocket with one sent out to REST API.
All messages are sent out in strict sequence (via one queue), waiting on confirmation for each one in order, aborting rest of the queue if first one fails/times-out to be delivered, with notices for each failed/discarded msg.
This is done to ensure that all messages either arrive in the same strict order they've been sent or not posted at all.
Discord message-posting API has enforce_nonce parameter (since 2024-02-12), which allows to retry posting messages safely from duplication, but at the moment retries are only performed here on API rate-limiting.
Fetching list of users for discord channel or even guild does not seem to be well-supported or intended by the API design.
There are multiple opcodes that allow doing that in a limited way, none of which work well for large discords (eg 10k+ users).
request_guild_members (8) doesn't return any results, request_sync (12) doesn't work, request_sync_chan (14) can be used to request small slice of the list, but only one at a time (disconnects on concurrent requests).
Latter is intended to only keep part of userlist that is visible synced in the client, doesn't support proper paging through whole thing, and only gets updates for last-requested part with indexes in it - basically "I'm in this guild/channel, what should I see?" request from the client.
Some events on gateway websocket are undocumented, maybe due to lag of docs behind implementation, or due to them not being deemed that useful to bots, idk.
Discord allows channels and users to have exactly same visible name, which is not a big deal for users (due to one-way translation), but still disambiguated irc-side.
Discord emojis like :smile: are handled in multiple different ways:
Looked up among unicode emoji names that work in all discords and translated to a unicode character, eg :smile: to
Can be found in current discord's custom emojis and replaced by a message formatting tag for it, like :debian: to a tag like <:debian:12345> , which discord clients will display as debian logo in a linux-related discord.
If user has Discord Nitro subscription, custom emoji from any discord works in any other discord as well.
rdircd doesn't handle last Nitro case at all (looks-up custom emojis in one discord), while first two cases are distinguished from each other via rdircd.unicode-emojis.txt.gz file (optional/configurable), which has list of all non-custom emojis (~6k of them), pulled from Discord WebUI using extract-unicode-emojis-from-js.py script.
If generic emojis stop working in the future (incorrectly treated as if they're discord-custom ones), due to renames or new additions, that script can be used to update the list of them easily.
Gateway websocket can use zlib compression (and zstd in non-browser apps), which makes inspecting protocol in browser devtools a bit inconvenient.
gw-ws-har-decode.py helper script in this repo can be used to decompress/decode websocket messages saved from chromium-engine browser devtools (pass -h/--help option for info on how to do it).
Run ./rdircd --test for info on some extra development/testing helper commands.
dev-cmds = yes under [debug] also enables some runtime helpers in #rdircd.control.
Adding support for initiating private chats might be a bad idea, as Cordless dev apparently got banned for that, and since these seem to be main spam vector, so more monitoring and anomaly detection is likely done there, leading to potentially higher risk for users.
