iceflowre / irc-discord-relay

IRC - Discord Relay, with message and other information sharing

ircDiscordRelay

---

General Behaviour

Sending to Discord

• Discord mentions are converted to a real mention (using the first matching name)
• IRC formatting will be removed

Sending to IRC

• Discord mentions are reduced to its name
• server specific emojis are reduced to its name
• multi line messages are sent line by line

Configuration

The configuration is a json formatted file. One example configuration is part of this repository.

• discord - map, required - contains all settings related to the Discord part
  • token - string, required - the bot token
  • channelId - string, required - the channel id where the messages will be send
  • sharing - list of string - the actions which will be shared to IRC, an absence of this will imply to share all actions
    • "message" - discord message
• irc - map, required - contains all settings related to the IRC part
  • channel - string, required - the IRC channel where the bot connects to
  • nick - string, required - the IRC nick
  • onConnection - list of string - every string will send as a raw message
  • sharing - list of string - the actions which will be shared to Discord, an absence of this will imply to share all actions
    • "message" - discord message
    • "me" - /me messages
    • "join" - joining users
    • "leaving" - leaving users
    • "nick" - nick change
    • "quit" - quiting users (e.g. timeout)
    • "kick" - user got kicked
    • "mode" - a mode changed by another user (this includes e.g. ChanServ!)

---

Requirements

• Go (>= 1.16)

Build

• go build -x -o irc-discord-relay

Update

Pull from git and build again.

Run

• create a config.json, with their needed values, look into the example for more
• place the config and the executable in one folder
• execute with irc-discord-relay -c config.json

---

Web

https://github.com/IceflowRE/irc-discord-relay

Credits

• Developer
  • Iceflower S
    • [email protected]

Third Party

• DiscordGo by Bruce Marriner (bwmarrin)
  • https://github.com/bwmarrin/discordgo
  • BSD-3-Clause
• errors by Dave Cheney
  • https://github.com/pkg/errors
  • BSD-2-Clause
• go-ircevent by Thomas Jager (thoj)
  • https://github.com/thoj/go-ircevent
  • BSD-3-Clause

Some code snippets were taken from:

• Snowflower by Iceflower S (Iceflower)
  • (unpublished)
  • https://gitlab.com/Iceflower/snowflower
  • GPL-3.0-or-later

License

Copyright 2018-present Iceflower S ([email protected])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

irc-discord-relay's Issues

Update readme 1.9 -> 1.10 as minimum version

Odd @ mention behaviour.

Passing a message from IRC with a mention and then an empty mention (e.g. @Beha @) will result in the second mention being replaced by someone in the discord.

Relay IRC formatted message correctly to Discord

---

Ref.: thoj/go-ircevent#106

Add on connect commands

Should allow RAW messages.
Not nice but covers everything.

Add ability to process formatting.

Currently the discord input and output is not formatted, so it appears in raw form and is not translated.
Adding to ability to @ users and display @'s correctly would be very useful.
An example is included:

IRC log:

21:54 <rediscord> <Beha> <@!331517669662654464> nice
21:54 <@behalebabo> uhoh
21:55 <rediscord> <Beha> <@396094340176543755>
21:55 <rediscord> <Beha> <:pzap:396123516875046912>
21:55 <@behalebabo> @Beha

The first two @'s were trying to @ a person in the server. They appeared in IRC like this.
The line with 'pzap' was attempting to use an inline image.
Note that the final @Beha did not notify the user in discord.
--- Edit: @IceflowRE
https://github.com/IceflowRE/irc-discord-relay/tree/discordMention

Cover other IRC formatting too

Different /me

* <name> <thing>

Add ability to run custom command upon connection.

Example command would be a nickserv identify message or vhost command.

Preventing impersonation.

Currently people on discord can change their name so that it is identical to someone else when relayed to IRC.

Some option should be added to prevent this, perhaps including the #xxxx tag or using the account name if that's available.

Use Discord nick before username