reliable discord client irc daemon
1.0.0
Inhaltsverzeichnis
Beschreibung
WARNUNG
Merkmale
Einschränkungen
Verwendung
Misc -Funktionsinformationen
Zufällige Tipps und Tricks
Links
Weitere Informationen zur Blockierung von Kundenblockieren von Drittanbietern
API- und Implementierungsnotizen
RDIRCD ist ein Daemon, mit dem ein persönliches Discord -Konto über einen IRC -Kunden verwendet werden kann.
Es übersetzt alle privaten Chats und öffentlichen Kanäle/Threads auf "Discord -Servern" in Kanäle auf einem IRC -Server, den es erstellt hat und dass Sie anstelle eines Browser- oder Elektronen -App eine Verbindung zur Verwendung des regulären IRC -Clients herstellen können.
"Zuverlässig" ist im Namen, da eines der anfänglichen Ziele darin bestand, die Bereitstellung von Nachrichten zu bestätigen und über alle diesbezüglichen Probleme zu informieren, was zu diesem Zeitpunkt in anderen ähnlichen Kunden etwas fehlte.
Es gibt einen IRC -Kanal, der über das Ding spricht - schließen Sie sich #RDIRCD bei libera.chat an.
IRC URL: IRCS: //irc.libera.chat/rdircd (GitHub weigert sich, IRCS: // Links zu machen)
Siehe Abschnitt auch Links unten für selten aktualisierte Liste anderer alternativer Kunden.
Repository -URLs:
Letzteres hat Git-Notes mit der Todo-Liste und dergleichen im Standard-Ref für diese.
Während ich diese App nicht als "Bot" oder "Automatisierung von Standard -Benutzerkonten" nennen würde - ist die Absicht, hier keine automatisierten Nachrichten zu veröffentlichen oder etwas zu kratzen -. Die Mitarbeiter von Discord berücksichtigen alle Clients von Drittanbietern als "Bots" und verlangt, dass sie spezielle API -Bot -gegen -Benutzerkonten -API -Dokumente für die zweite Klasse verwenden. zufälliger Nicht-Adminampfer-Benutzer.
Diese App präsentiert sich nicht als "Bot" und verwendet keine Bot-spezifischen Endpunkte, sodass die Verwendung von dieser Verwendung zu einer Kontonteration führen kann, wenn sie festgestellt werden.
Weitere Informationen zum Abschnitt Drittanbieter-Client-Blockierungen finden Sie weiter unten.
Sie wurden gewarnt! :)
Zuverlässige ausgehende Nachrichtenbestellung und -zustellung mit expliziten Benachrichtigungen für erkannte Probleme jeglicher Art.
Unterstützung sowohl für private als auch für öffentliche Kanäle, Kanalbestellungen, Fäden, Foren, mit Ausnahme neuer neuer davon.
Pro-server und global cap-all-Kanäle, um allgemeine Aktivitäten zu verfolgen.
Konfigurierbare lokale Namen Aliase/Umbenennungen, ausgehende Nachrichtenblöcke/-Setze, Regexp-Filtering für empfangene Nachrichten.
Unterstützung für eine begrenzte Rennzeit -Rekonfiguration über #rdircd.Control -Kanal.
Einfache und konsistente Zwietracht zu IRC Guild/Channel/Benutzernamenübersetzung.
Keiner davon ändert sich nach der Wiederverbindung, Kanal- oder Server -Umformung usw. - Übersetzung ist größtenteils deterministisch und hängt nicht von anderen Namen ab.
Übersetzung für Discord -Erwähnungen, Antworten, Anhänge, Aufkleber und Emojis in eingehenden MSGs, anderen Ereignissen, grundlegenden Annotationen für einige eingebettete Links.
Begrenzte Unterstützung für die Übersetzung von Discord -Nutzernerwartungen und Emojis in gesendeten Nachrichten, Änderungen und Löschungen.
Einfach zugänglicher Backlog über/topic (/t) -Einbefehle in jedem Kanal, z. B. "/t log 2h", um die letzten 2 Stunden des Rückstands oder "/t log 2019-01-08" anzuzeigen, um den Rückstand von diesem Punkt auf die Gegenwart zu entwerfen und bei Bedarf mehrere Chargen zu holen.
Nachrichten, die mit anderen Mitteln gesendet werden (z. B. Browser), werden ebenfalls an IRC weitergeleitet, was jedoch möglicherweise von einem Diff-Nick stammt, wenn der IRC-Name nicht übertrifft, dass die Nick-Übersetzung von Discord-to-c-zu diskordiert wird.
Vollständige Unicode -Unterstützung/Verwendung überall.
Das IRC-Protokoll wird aus IRCV3-Dokumenten implementiert, verwendet jedoch keine Nicht-RFC-Dinge, daher sollte sie mit alten Kunden kompatibel sein. Optionale TLS -Verpackung.
Umfangreiche Protokoll- und Debug -Protokollierungsoptionen, einige zur Laufzeit über #rdircd.debug -Kanal zugänglich.
Ein einzelnes Python3 -Skript, für das nur ein AIOHTTP -Modul erforderlich ist, das trivial ausführt oder überall eingesetzt werden muss.
Läufe in einem relativ stabilen ~ 40 m Speicher Fußabdruck auf AMD64, was wahrscheinlich mehr als z. B. Bitlbee-Diskord ist, aber besser als diese undichten Browser-Registerkarten.
Einfach zu optimieren und zu debuggen, ohne Wiederaufbau, GDB, Rost und dergleichen.
Nur von IRC gesendete Benutzererwartungen und Emojis werden in Discord -Tags übersetzt (falls aktiviert und mit einigen Macken siehe unten) - nicht Kanäle, Rollen, Aufkleber, Komponenten usw.
Keine Unterstützung für das Senden von Anhängen oder Einbettungen jeglicher Art - Verwenden Sie dafür Webui, nicht IRC.
Discord kommentiert jedoch automatisch Links, sodass das Posten von Medien so einfach ist.
Es werden keine diskordspezifischen Aktionen, die über alle Arten des Lesens und Sendens von Nachrichten an vorhandene Kanäle hinausgehen, unterstützt - dh keine Konten oder Kanäle zu Zwietracht, Verwaltung von Rollen, Einladungen, Verboten, Zeitüberschreitungen usw. - Verwenden Sie Webui, Harmonie oder ordnungsgemäße Discord -Bots.
Das Erstellen neuer privaten Chats und Kanal-/Forum -Threads wird nicht unterstützt.
Für private Chats ist es möglicherweise sogar gefährlich zu unterstützen. Weitere Informationen zum Abschnitt Drittanbieter blockieren weiter unten.
Verfolgt die Benutzerpräsenz nicht (online, offline, AFK, Spiele spielen usw.).
Sendet keine Benutzerverbindungen /Teileereignisse und verarbeitet IRC /Namen auf sehr einfache Weise. Nur Nicks, die den Kanal seit dem Start von Apps und innerhalb von IRC-Names-Timeout (standardmäßig 1 Tag) verwendeten.
Ignoriert alle nicht-text-chat-Dinge im Allgemeinen vollständig (z. B. Sprache, Benutzerprofile, Spielbibliothek, Laden, Freundeslisten usw.).
Discord verfolgt "Read_State" Server -Side, die hier in keiner Weise verwendet wird. Die Auslöserverlaufs -Wiederholung erfolgt nur manuell (/T -Befehle in Chans). Manchmal können Sie bei stillen Wiederverbindungen manchmal leicht verpassen.
Unterstützt nicht, dass Discord -Multifaktorauthentifizierungsmodus, aber manuell gequerdigte Authorte kann dies wahrscheinlich umgehen - siehe Hinweis zu Captchas unten.
Slash -Befehle (für Bots) werden in keiner besonderen Weise unterstützt, aber Sie können sie wahrscheinlich trotzdem senden, wenn der IRC -Client diese durchgibt.
Nicht das benutzerfreundlichste Ding, obwohl wahrscheinlich der gleiche wie IRC selbst.
Ich führe es nur unter Linux aus, daher ist es unwahrscheinlich, dass es unter OSX/Windows "einfach funktioniert", aber IDK.
Benutzerdefinierte AD-hoc-Implementierung von Discord und IRC, die von keiner Art von Belichtung und Tests auf PYPI und einer solchen WRT-Kompatibilität, Fehler und Eckwaren profitiert.
Scheinen gegen Discord -Richtlinien zu sein, um sie zu verwenden - siehe Warnabschnitt oben, um weitere Informationen zu erhalten.
Auf der OpenBSD-Plattform muss bei der Verwendung von Scrypt-kodiertem IRC password-hash= möglicherweise auch das Scrypt-Modul separat installiert werden (über EG pkg_add py3-scrypt ), da Python-Port dort anscheinend nicht Hashlib.Scrypt in seinem STDLIB zu haben scheint.
Der einfachste Weg ist möglicherweise, ein Paket für/aus Ihrer Linux -Verteilung zu verwenden, wenn es verfügbar ist.
Derzeit bekannte Distolpakete (ab 2020-05-17):
Es gibt auch eine Dockerfile und Docker-compose.yml, um dies in einem Docker/Podman oder einer anderen OCI-kompatiblen Containerumgebung auszuführen.
(Siehe auch Readme.Docker-Permission.MD DOC für Informationen zu allgemeinen Zugriffsproblemen mit diesen))
Sollte einfach ein Skript und seine wenigen Abhängigkeiten manuell installieren, wie im Rest dieses Abschnitts unten beschrieben.
Auf Debian/Ubuntu kann die Installation von Abhängigkeiten mit diesem einen Befehl erfolgen:
# apt install --no-install-recommends python3-minimal python3-aiohttp
Andere Linux -Distributionen haben wahrscheinlich auch ähnliche Pakete, und ich würde empfehlen, diese als erste Option zu verwenden, damit sie Updates erhalten und eine zusätzliche lokale Wartungsbelastung vermeiden, und nur einen Fallback bei der Installation von Modul (en) über "PIP", wenn dies fehlschlägt.
Auf einer beliebigen Distriktion mit Python (Python3) installiert mit PIP/VenV zur Installation von AIOHTTP -Modul (und seinen DEPs) bis zum nicht privilegierten "RDIRCD" -Schirschen können das Heim -Dire des Benutzers möglicherweise funktioniert (mit der auch im nächsten Beispiel für die Ausführung von Rdircd im nächsten Beispiel).
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
Wenn Sie PIPX haben/verwenden (z. B. aus Distributionsrepos), kann es verwendet werden, um Python -Apps wie diese und automatische Abhängigkeiten zu betreiben -nur " pipx run rdircd --help Run".
Nachdem die obigen Anforderungen installiert sind, kann das Skript selbst aus diesem Repository abgerufen und so ausgeführt werden:
## 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...
Für das Einrichten von Daemon/Skript für den OS-Start kann Rdircd.Service Systemd-Einheit-Datei in den meisten Linux-Umgebungen (dort bearbeiten ecstart = optionen und Pfade dort) oder auf andere Weise über init.d-Skript oder möglicherweise in "Bildschirm" als Last Resort Ad-hoc-Option verwendet werden. Stellen Sie sicher, dass es als z. B. "RDIRCD" -Benutzer ausgeführt wird, das oben in Snippet erstellt wurde, nicht als Root.
Um das Skript später, falls erforderlich, zu aktualisieren, ersetzen Sie es durch eine neueste Version, z. B. über das Downloading mit einem Curl-Befehl oben, Git-Pull auf dem Repo-Klon, docker-compose up --build , Aktualisierung des Betriebssystempakets oder auf andere Weise, normalerweise zusammen, wie es an erster Stelle installiert wurde.
Erstellen Sie die Konfigurationsdatei mit Discord- und IRCD -Auth -Anmeldeinformationen in ~/.rdircd.ini (siehe alle --conf... opts wrt diese):
[irc]
password = hunter2
[auth]
email = [email protected]
password = discord-passwordHinweis: Das IRC -Passwort kann weggelassen werden, aber stellen Sie sicher, dass dieser Port von allem im System angewendet wird (oder es trotzdem tun).
Wenn Sie das Passwort jedoch festlegen, verwenden Sie möglicherweise keine IRC- password= Option wie oben und verwenden Sie password-hash= und -H/--conf-pw-scrypt um es stattdessen zu generieren. Verwenden Sie dieses Kennwort in jedem Fall, wenn Sie die Verbindung zu diesem Server auch im IRC -Client konfigurieren.
Starten Sie Rdircd Dämon: ./rdircd --debug
Schließen Sie den IRC -Client mit "Localhost: 6667" an - Standard -Listen/Bindungs -Host und Port.
(siehe ./rdircd --conf-dump-defaults oder entsprechende Cli -i/--irc-bind / -s/--irc-tls-pem-file Optionen zum Binden an verschiedenen Host/Port- und TLS-Socket-Verpackungen für nicht-localhost-Verbindungen)
Verwenden Sie den Befehl IRC /list um Kanäle für alle Verbindungs -Discord -Server /Gilden anzuzeigen:
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.
Anmerkungen zu Informationen hier:
/j #axsd.offtopic ( /join ), wie Sie es mit regulärem IRC tun würden, um MSGs dort zu sehen /posten.
Kanäle verbinden sich/Teile auf der IRC -Seite in keiner Weise Zwietracht.
Run /topic (oft als /t ) IRC-Command, um weitere Informationen zu kanalspezifischen Befehlen anzuzeigen, z. B. das /t log und Wiederholen von Backlogs ab dem letzten Ereignis vor dem letzten RDIRCD-Stillstand, /t log list , um alle Aktivitäts-Timestamps zu listen, die Rdircd-Tracks, oder /t log 2h um /DUILD-LOG-LOG für /abzustempeln /span /Span /Span /Span /Span /Span /Span /Span /Span /Span /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stamp /Span) (Stempel /Span) (Stempel /Span).
Die Befehle zur Steuerung/Konfiguration von Daemon sind im #rdircd.control -Kanal verfügbar, #rdircd.debug Chan kann verwendet werden, um verschiedene Protokollierung und Inspektion von Daemon -Status und Protokollen genauer zu optimieren, dort "Hilfe" zu senden, um die verfügbaren Befehle aufzulisten.
Eine umfassende Übersicht über verschiedene unterstützte Konfigurationseinstellungen finden Sie unter rdircd.defaults.ini-Datei (Ausgabe von ./rdircd --conf-dump-defaults ) und mehr zu bestimmten Verwendungen der folgenden.
Anmerkungen zu verschiedenen optionalen und weniger offensichtlichen Funktionen werden hier gesammelt.
Weitere allgemeinere Informationen finden Sie im Abschnitt "Nutzung".
Mehrere INI -Dateien können mit -c -Option angegeben werden, die sich nacheinander überschreiben.
Das letzte Mal wird der WRT [STATE], Token = und ähnliche Laufzeitmaterial sowie alle Werte über #rdircd.Control -Kanalbefehle aktualisiert, sodass es nützlich sein kann, eine anhaltende Konfiguration mit Auth und Optionen und -optionen anzugeben und einen separaten (ursprünglich leeren) für einen solchen dynamischen Zustand.
./rdircd -c config.ini -c state.ini
--conf-dump kann zum Druck hinzugefügt werden, der von all diesen zusammengestellt wurde.
-Das Flag --conf-dump-defaults kann verwendet werden, um alle Optionen und ihre Standardeinstellungen aufzulisten.
Häufige Status-Zeitstempel-Updates werden an Ort und Stelle (kleine Werte mit fester Länge) durchgeführt, aber die CTime vor dem Schreiben überprüfen, sollte daher sicherlich jederzeit manuell bearbeiten.
Das Senden von Seufzen an den Befehl Skript oder "Reload" im Steuerkanal sollte Werte in allen Konfigurationsdateien in derselben Reihenfolge geladen und anwenden. Beachten Sie, dass ein solcher Vorgang keine Werte, die in Dateien fehlen, auf ihre Standardeinstellungen zurückgesetzt werden. Wenden Sie nur Dinge explizit auf der aktuellen Konfiguration an.
Alle Chats in Rdircd (und Discord) sind ein Kanal .
IRCs /Q, /Abfrage und /MSG können nicht auf IRC-typische Weise verwendet werden .
Um in einem privaten Chat zu sprechen, schließen Sie sich einem Kanal wie #me.chat.
Derzeit gibt es keine Möglichkeit, neue private Chats von RDIRCD zu erstellen, andere Kunden oder Webui zu verwenden (oder jemanden zu bitten, sich zuerst in Verbindung zu setzen). Sobald der private Chat -Kanal erstellt wurde, kann er auch in RDIRCD verwendet werden.
Siehe auch automatische Sendungskanäle und /oder /join.
In allen IRC -Kanälen, die einen Discord -Kanal darstellen - Senden /topic (oder /t - Kurzform, das häufig in IRC -Clients unterstützt wird), die aktuelle Informationen zu allen kanalspezifischen Befehlen drucken sollten, wie diese:
/t info - Zeigen Sie einige interne Gilden-/Kanalinformationen wie IDs und dergleichen für umbenannt.
Sollte unter anderem den genauen Kanalnamen auf Discord (ohne lokale Umbenennung oder Discord-to-CR-Übersetzung) drucken.
/t info {user-name...} - Abfrageninformationen zum Benutzernamen (oder Teil davon) in dieser Zwietracht.
Zum Beispiel sucht /t info joe137 joe137 Benutzer auf einem Discord -Server, zu dem Kanal gehört, und drucken Informationen darüber, wie ihre verschiedenen Discordnamen.
/t log [state] - Wiederholungsverlauf seit "Status" Punkt (letztes Rdircd -Stopp standardmäßig).
/t log (gleich wie /t log 1 ) kann verwendet werden, z. B. nach dem Neustart von RDIRCD, um die Zwietracht für alle Nachrichten abzufragen, die möglicherweise nach dem Stoppen gepostet wurden, und bevor es wieder gestartet wurde (plus seitdem andere).
Oder /t log 0 um die Geschichte zu überprüfen, da die letzte MSG, die Rdircd gesehen hat, für Fälle, in denen Zwietracht /Netzwerk flocken und etwas auf diese Weise verloren gegangen sind.
(Wenn sich diese 1 und 0 -Nummern auf gespeicherte Zeitstempel aus /t log list beziehen, werden in der INI -Datei unter [state] gespeichert /aktualisiert)
Es kann auch mit einer absoluten oder relativen Zeit verwendet werden, z /t log 15m um den Kanalverlauf innerhalb der letzten 15 Minuten zu fordern /wiederzugeben, oder /t log 2019-01-08 12:30 um den Verlauf des Verlaufs seit dieser spezifischen RDIRCD-Local-Zeit wiederzugeben (es sei denn, TimeZone wird dort auch angegeben).
Just /t oder /topic in einem Diskord -Proxy -Kanal werden weitere solche Befehle und weitere Informationen dazu auflisten, wie sie verwendet werden.
Letzte Nachricht, die an einen Discord-Kanal gesendet wurde, kann mit dem Befehl SED-Replacement wie s/hoogle/google/ so bearbeitet werden, um einen Tippfehler zu beheben oder diese letzte Zeile schnell zu ändern/neu zu formulieren/zu klären.
Oder //del -Befehl kann verwendet werden, um ihn zu löschen - siehe Abschnitt "Schnelle Änderungen/Löschungen" unten.
@silent Prefix-Command in Nachrichten können Benutzerbenachrichtigungen dazu unterdrücken (auch irgendwo unten erläutert).
In speziellen Kanälen wie #rdircd.control und #rdircd.debug: Senden Sie h oder help .
Sie können eine etwas lange Liste unterstützter Befehle haben, z. B. hier sind einige der Befehle für #rdircd.control:
status (oder st ) kann verwendet werden, um die Infos von Discord und IRC Connection zu überprüfen.
Befehle connect / disconnect (oder on ) können verwendet werden, um die Verbindung off Discord manuell zu steuern, z. B. für eine einmalige Verwendung, oder um fehlgeschlagene Conn Warnungen vorübergehend zu unterdrücken, während das lokale Netzwerk auf diese Weise heruntergekommen ist.
set irc-disable-reacts-msgs yes -Tempel-Discord-Reaktionsbenachrichtigungen (unter Verwendung des Befehls set ).
Oder set -s irc-disable-reacts-msgs yes , um es dauerhaft zu machen ( -s/--save , um den Wert in INI-Konfigurationsdatei zu speichern) oder einfach ohne Parameter set um alle allgemeinen Konfigurationsoptionen und deren Werte anzuzeigen.
rx Block mee6 bot-noise = (?i)^<MEE6> -Temp-Block alle Nachrichten von Mee6 Bot.
(Siehe Abschnitt über diese Filterung unten oder weitere Beispiele für solche Dinge unter Tipps und Tricks)
... und es gibt mehr davon- help für vollständige Informationen.
#rdircd.Monitor kann verwendet werden, um die Aktivität von allen verbundenen Servern zu sehen. Erhält alle Nachrichten, die durch den relevanten IRC -Kanalnamen vorangestellt sind.
#rdircd.monitor.guild (wobei "Gilde" ein Hash oder Alias ist, siehe oben) ist ein ähnlicher Catch-All-Kanäle für bestimmte Discord-Server/Gilde.
#rdircd.monitor.me kann nützlich sein, um beispielsweise alle privaten Chats und Nachrichten für das Discord-Konto zu überwachen (siehe auch Beispiel für automatische Angaben).
#rdircd.leftover und ähnliche #rdircd.leftover.guild-Kanäle sind wie Überwachungskanäle, aber überspringen Nachrichten aus allen Kanälen, die der IRC-Client Join-ED haben, einschließlich EG /join #rdircd.leftover.game-x das "Game-X" -Discrord-MSGs von globaler Catch-All #ieft.leftovering versteckt, aber nicht #rdirds #itovering, aber nicht #rdirds #itovering, aber nicht #rdirds | "übrig geblieben" in irgendeiner Weise).
#rdircd.voice ist ein Kanal, der #rdircd.monitor ähnelt, aber nur die Hinweise auf Voice-Chat-Ereignisereignisse, um diese rechtzeitig zu verfolgen.
Diese Kanäle können ignoriert werden, wenn sie nicht benötigt werden, oder vollständig deaktiviert werden, indem Sie den chan-monitor . Zum Beispiel sind die Sprachaktivitätskanäle pro Diszid dort standardmäßig behindert.
Die Konfigurationsdatei hat außerdem einen Abschnitt über [Unmonitor] für eine optionale Liste von Kanalnamen, die in Monitor-/Restkanälen ignorieren können, z. B.:
[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 Keys (as in part before "=") in such config section are ignored, and can be anything, eg comments explaining the patterns (like in example above), while values are either exact channel names (with discord prefix, optional #-prefix), or a "glob:"/"re:"-prefixed glob / regexp pattern (shell-like globs or python regexps), written as <some-key/comment> = glob:<wildcard-pattern> oder <some-key/comment> = re:<regexp-pattern> Zeilen-Siehe Beispiele direkt darüber.
Kanalnamen, die von diesen Filtern übereinstimmen, werden von Überwachungskanälen fallen gelassen, sodass dies verwendet werden kann, um eine Liste von Spammy-Dingen zu definieren, die Sie sich nicht interessieren und nicht einmal dort sehen möchten.
Befehl "Unmonitor" (oder "UM") in #rdircd.control kann solche Filter jederzeit im Fliege hinzufügen/entfernen. Siehe auch die Konfigurationsoption match-counters um zu verfolgen, ob bestimmte Regel (n) noch benötigt werden/verwendet werden.
Nachrichten in Überwachungskanälen sind auf bestimmte Länge/Linien beschränkt, um übermäßige Überschwemmungen durch lange und/oder Multi-Line-MSGs zu vermeiden. "Len-Monitor" und "Len-Monitor-Lines" -Parameter im Abschnitt [IRC] -Konfiguration können diese Grenzwerte verwendet werden, siehe "./RDIRCD--CONF-DUMP-DEFAULTS" Ausgabe für ihre Standardwerte. Es gibt auch Optionen, um das Namensformat von Monitorkanälen zu ändern.
Bei IRC hat jeder einen Namen, aber das ist bei Discord nicht der Fall, bei dem jeder Benutzer folgende Namen haben kann:
login - Discord "Benutzername", die jeden Benutzer einzigartig identifizieren.display - "Anzeigename" vom Benutzer in Discord -Kontoeinstellungen festgelegt, nicht eindeutig.nick - Server und Freund "Spitznamen", in Discord Server -Einstellungen festgelegt, nicht immer von Ihnen. login ist das engste Konzept für IRC-Spitznamen, da es weltweit einheitlich, konsistent, kurz, ascii-einzeln und durch Einstellen name-preference-order = login Option in [Discord] verwendet werden kann (nicht der Standard).
Offizielle Discord-Clients zeigen zuerst andere Namen an, weshalb die Option name-preference-order -Standard für nick display login wird, der diktrord-/Freundspezifische Spitznamen verwendet, falls vorhanden, und der Benutzer, der in den Kontoeinstellungen festgelegt ist, und deren Anmeldennamen ansonsten zurückfällt.
Andere Dinge in ausgefallenen Spitznamen der Benutzer-Set, die IRC nicht zulässt, werden auch auch durch gemeinsame Unicode-Zeichen, Leerzeichen mit "·" Mittelpunkten ersetzt, zum Beispiel oder <> übliche IRC-Nick-Klammern mit ◄► Unicode-Pfeilen. Lange Zwietrachticke sind abgeschnitten.
Es gibt keine IRC-Benachrichtigungen darüber, dass Benutzer im Moment ihre diskordspezifische Anzeige/Spitznamen ändern, und sie müssen nicht einzigartig sein, was es schwierig machen könnte, zu sagen, wer ist, wenn sie aus irgendeinem Grund Nicks ändern.
All dies ist über Ini name-preference-order = login Dateieinstellungen (oder im #rdircd.control-Kanal) konfiguriert.
IRC /who -Befehl oder /topic info können helfen, zwischen diesen Namen zu übersetzen, z. B. /t info john1234 kann verwendet werden, um Informationen für diesen Namen /Login im Kanalpuffer zu drucken, die alle Benutzer mit teilweise Übereinstimmung mit diesem Namen auf dieser spezifischen Zwietracht enthalten sollten, während /who -Befehlssuche alle miteinander verbundenen Discords.
(eher wie "umbenannt" als "Aliase", da alte Namen nicht weiterhin für diese funktionieren)
Kann in der Konfigurationsdatei definiert werden, um Hash-basierte Discord-Präfixe oder Serverkanalnamen durch etwas Lesbareres/unvergesslicheres oder Sinnvolleres zu ersetzen:
[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 = joeDies sollte:
Verwandeln Sie EG #JVPP.info in #game-x.info-landesoup guild-id zum aussagekräftigeren Präfix. Dies gilt für alle Kanäle in dieser Zwietracht - "Gilde" umbenannt.
Ändern Sie das Format für Kanalnamen von "SN3Y" -Disskord von so etwas wie #sn3y.debug zu #logs/debug.log - Änderung des Kanalnamenformats.
Die Formatvorlage verwendet die Python Str.Format -Syntax mit "Name" (Kanalname) und "Präfix" (Guild Prefix - werden in diesem Beispiel "Protokoll -Bot") Werte sein. Das Standardformat ist {prefix}.{name} .
Diese Formatoption hat keinen Einfluss auf den Monitor-/Restkanalnamen (e) (z. B. #rdircd.monitor.log-bot oder #rdircd.leftover.game-x)-Siehe "Chan-Monitor-Guild" und "Chan-Link-Guild" -Optionen unter [IRC] -Aption, um dies zu ändern.
Benennen Sie diesen langen Kanal um, um einen kürzeren Namen (Präfix der Gilde zu erhalten) - "Chan" umbenannt.
Beachten Sie, dass dies alle Gilden betrifft, in denen ein solcher Kanalname existiert, und der Quellname im IRC-Format sein sollte, wie in /list, und ist RFC1459-Casemapt (wie auf IRC).
Kanal umbenennen mit ID = 710035588048224269 in "memes" (Prefix der Gilde beibehalten) - "Chan" mit @Channel -ID -Spezifikation umbenannt.
Diese Long Discord Channel Identifier (auch "Snowflake" genannt) kann durch Eingabe /t info -Themen-Command im entsprechenden IRC-Kanal gefunden werden und kann verwendet werden, um auf diesen spezifischen Kanal zu verweisen, dh dieses eine #-General auf diesem einen Discord-Server, anstatt alle #General-Kanäle überall umzubenennen.
Dies ist besonders nützlich, wenn zwei Kanäle in derselben Zwietracht den gleichen Namen haben und normalerweise zugewiesen werden .<id-hash>
Benennen Sie Paarbenutzer um, auf die sich der Benutzername und die ID von Discord verwiesen.
/t info <nick-or-part-of-it> -Befehl in Discord Channel oder ähnlich /who IRC-Command kann helfen, Discord-IDs zu suchen, wie dort verwendet.
Derzeit werden nur aufgeführte Arten der Umbenennung implementiert, für Präfixe und Kanäle von Discords, aber es gibt auch Optionen im Abschnitt [IRC], um Namen für System/Monitor/Rest und private Chat-Kanäle festzulegen-"Chan-Sys", "Chan-Private", "Chan-Monitor" und dergleichen (siehe ".
Legen Sie chan-monitor-guild = {prefix} dort zum Beispiel, um #Game-X-Kanal für alle Nachrichten in dieser Zwietracht zu haben, ohne dass long #rdircd.monitor.* Präfix.
Discord private Nachrichten erstellen und werden auf Kanäle in "ME" -Server/Gilde erstellen und veröffentlicht.
Treten Sie #rdircd.monitor.me (oder #rdircd.monitor, siehe oben) bei, um alle neuen MSGs/Chats dort sowie Relationship Change -Benachrichtigungen (Freundschaftsanfragen/Fügt/Entfernungen) als Mitteilungen zu erhalten.
Das Akzeptieren von Freundschaftsanfragen und das Hinzufügen/Entfernen dieser Informationen kann über regelmäßige Discord -Webui erfolgen und wird in diesem Client nicht auf besondere Weise implementiert.
Siehe Abschnitt auch automatische Angaben von Kanälen unten für eine einfache Möglichkeit, neue private Chats im IRC-Kunden über Einladungen zu pop-up.
"Threads" ist eine Discord-Funktion, mit der Nicht-Adminamente Benutzer jederzeit vorübergehende Ad-hoc-Unterkanäle für ein bestimmtes Thema erstellen können, das nach einer relativ kurzen Inaktivitätszeitüberschreitung (wie einem Tag) automatisch ("archiviert").
Das Discord "Forum" -Kanäle sind im Grunde genommen Kanäle, in denen Menschen nur in Theads erstellen und sprechen können, wobei die Auflistung derjenigen, die das Standardkanal -Chatter ersetzen, auflistet.
Alle nicht architivierten Threads sollten in der Liste der RDIRCD-Kanalliste als reguläre IRC-Kanäle angezeigt werden, mit Namen wie #gg.general.
Es gibt verschiedene Optionen, um Threads aus dem übergeordneten Kanal zu sehen und mit dem Abschnitt über die Diskordung zu interagieren (hauptsächlich im Abschnitt [Discord], siehe-CONF-DUMP-DEFATTS-Ausgabe):
[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
...Aber selbst bei all diesen Behinderungen sollte eine einfache Mitteilung an den Kanal gesendet werden, wenn Threads gestartet werden, so dass man sie nicht vollständig verpassen wird.
Es gibt keine Unterstützung für das Erstellen neuer Threads von IRC, nicht architivierende alte oder auf andere Weise verwaltete und das Verbinden des Thread -Kanals in IRC "Thread" in Discord UI (Pinsen unter Kanalname), aber das Veröffentlichen von etwas dort automatisch.
"Chan-auto-join-re" -Aufeinstellung im Abschnitt [IRC] ermöglicht das Angeben von Regexp, den Kanalnamen (ohne # Präfix) zu übereinstimmen, um automatisch zu streben, wenn Nachrichten in ihnen angezeigt werden.
Zum Beispiel kann verwendet werden, um einen automatischen Ausdruckswert (Python "Re" -Syntax) automatisch zu bejahen.
[irc]
chan-auto-join-re = ^me. Oder um alle Kanäle automatisch zu einem IRC-Client zu haben, verwenden Sie chan-auto-join-re = .
Der leere Wert für diese Option (Standard) stimmt mit nichts überein.
Dies kann als Alternative zur Verfolgung neuer Sachen über #rdircd.Monitor/übrig gebliebene Kanäle verwendet werden.
Dieser Regexp kann zur Laufzeit mit "Set" -Befehl in #rdircd.control -Kanal, wie alle anderen Werte, optimiert werden, um diese Funktion für bestimmte Zwietracht oder Kanäle vorübergehend zu aktivieren/zu deaktivieren.
Erwähnungen sind @username -Tags auf Discord, um jemanden auf eine direkte Nachricht aufmerksam zu machen.
Mit der Standardkonfiguration, wenn Sie z <Galaxy?·Brain> Hi! Und möchte antworten, um sie hervorzuheben, Hey @galaxy and welcome zu senden, sollte wahrscheinlich funktionieren. Kann auch ihren vollständigen IRC Nick verwenden, um sicher zu sein.
Wie es funktioniert: Wenn RDIRCD msg-mention-re Regexp-Konf-Option gegen etwas in einer Nachricht entspricht (z. @galaxy @-mention oben), würde dies als "Erwähnung" behandelt werden, was entweder einzigartig übereinstimmt und in eine diskordierte Erwähnung übersetzt oder in der gesendeten Nachricht zurückgegeben wird (bei Nicks.
Der Standardwert dafür sollte so aussehen:
[discord]
msg-mention-re = (?:^|s)(@)(?P<nick>[^s, ; @+!]+) Dies würde zu einer wortähnlichen Raum- oder Interpunktions-getrennten @nick -Erwähnung in gesendeten Zeilen übereinstimmen.
Regexp (Python "Re" -Syntax) muss "Nick" -Gruppe mit Nick/Benutzername -Such -Zeichenfolge benannt haben, die durch Discord -Erwähnungs -Tag ersetzt wird, und alle anderen Erfassungsgruppen ( @ eine ohne ?: .
Die obige Standard-Regexp sollte noch zulassen, dass EG @something in WebApp (und ohne aufgrund von Markdown) nicht hohe Erscheinung erscheint, da es aufgrund dieses Backslash-Präfixs nicht mit (?:^|s) teilnehmen wird.
Als ein weiteres Beispiel, um klassische Highlights im IRC-Stil zu Beginn der Linie zu haben, kann Regexp wie dieses verwendet werden:
msg-mention-re = ^(?P<nick>S+)(:)(?:s|$)
Und sollte EG mk-fg: some msg in @mk-fg some msg (wobei @-Part erwähnt wird) übersetzen. Der nachverfolgende Platz ist in Regexp dort enthalten, um die entsprechenden URL -Links zu vermeiden.
In idspezifischer Discord -Benutzer wird die "Nick" -Gruppe auf folgende Weise verwendet:
Fall-unempfindliche Übereinstimmung gegen alle aktuellen IRC-Namen im Zusammenhang mit Gilden (Nachrichtenautoren, Reaktionen, private Kanalbenutzer usw.). user-mention-cache-timeout -Konfigurationsoption steuert "Neue" Zeitüberschreitung.
SOKOUP einzigartiger Name Fertigstellung nach Präfix, wie Discord in Webui für die automatische Vervollständigung nach @ eingegeben.
Wenn keine zwischengespeicherte oder eindeutige Übereinstimmung gefunden wurde - wird die Fehlerbekanntmachung ausgegeben und nicht gesendet.
Ein solches striktes Verhalten soll unbeabsichtigte Fehlübersetzungen vermeiden, und das Hervorheben einer falschen Person sollte im Allgemeinen nur durch Fehlschriften möglich sein.
Die damit verbundene Option msg-mention-re-ignore Option (Regexp, die gegen die volle Erfassung des oben genannten Musters übereinstimmt) können auch verwendet werden, um einige Nicht-Mention-Dinge aus der Behandlung als solche zu überspringen.
Beachten Sie, dass die Listen von Discordbenutzern sehr massiv sein können (500K+ Benutzer), nicht über den Kanal geteilt werden und nicht vom Client vorgeholt werden sollen, nur für Fertigstellungen oder sichtbare Teile abgefragt werden, die IRC nicht gut zugeordnet sind, daher all diese Magie.
Ähnliches Regexp ist für pro-Discord-Emojis konfiguriert:
msg-emoji-re = (?:^|s)(:)(?P<emoji>w+)(:)(?=[^w]|$)
Wo zum Beispiel I use :Arch: btw von IRC übereinstimmen mit dieser Regexp, such/ersetzen Sie die "Emoji" -Gruppe dort unter Verwendung der Emojis dieses Zwietracht (Fall-unempfindlich) und senden Sie sie entweder übersetzt, während I use ? btw oder Rückgabefehler, wenn ein solches Emoji in dieser Zwietracht nicht verfügbar ist und nicht auf einer Liste generischer Unicode.
Setzen Sie msg-mention-re / msg-emoji-re auf einen leeren Wert, um solche Übersetzungen zu deaktivieren.
Ähnlich wie oben erwähnt Discord-Benutzer gibt es eine spezielle Regexp-Option, die die Befehle entspricht, die als Bearbeiten oder Entfernen der an diesen Kanal gesendeten Nachricht interpretiert werden sollen.
Standard-Regexps sehen ungefähr so aus (check-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*$ Sie stimmen mit SED/Perl/IRC-ähnlichen Follow-up-Änderungslinien wie s/spam/ham/ und //del Zeile überein, die niemals an Discord gesendet werden, nur als interne Befehle.
( s|/some/path|/other/path| und s:cat /dev/input/mouse0 | hexdump:hexdump </dev/input/mouse0: Syntaxes sind ebenfalls standardmäßig zulässig.
Beide Befehle, die mit diesen übereinstimmten, werden bei der letzten Nachricht von RDIRCD an denselben Discord-Kanal gesendet, wobei //del einfach diese letzte Nachricht entfernen und die Auslauf-Python re.sub () (pcre-like) Regexp-Replacement-Funktion darauf bearbeiten.
"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.
