Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hackndo/discord-irc-sync
Python synchronization between IRC and Discord
https://github.com/hackndo/discord-irc-sync
discord irc python synchronization
Last synced: 2 months ago
JSON representation
Python synchronization between IRC and Discord
- Host: GitHub
- URL: https://github.com/hackndo/discord-irc-sync
- Owner: Hackndo
- License: gpl-2.0
- Created: 2017-11-14T13:36:14.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-13T21:57:02.000Z (over 1 year ago)
- Last Synced: 2024-05-04T00:10:31.165Z (8 months ago)
- Topics: discord, irc, python, synchronization
- Language: Python
- Size: 77.1 KB
- Stars: 18
- Watchers: 7
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord-IRC Synchronization
Description
-----------
**Python3.5+** implementation of a synchronization between IRC and Discord
Requirements
------------
* Python 3.5+
* Discord Bot
Discord Bot
-----------
1. Go to [Discord developer application](https://discord.com/developers/applications)
2. Add a new application
3. Create a Bot User
4. Follow https://discordapp.com/oauth2/authorize?&client_id=CLIENT_ID&scope=bot&permissions=0 with your application **Client ID**
5. Choose your server
Then, enable `Message Content Intent` by navigating to your bot page (https://discord.com/developers/applications then choose your bot), under the bot menu, enable the `Message Content Intent` parameter so the bot can read messages and transfer them to IRC.
Initialization
--------------
```sh
git clone [email protected]:Hackndo/discord-irc-sync.git
cd discord-irc-sync
mkvirtualenv discordirc -p $(which python3)
pip install -r requirements.txt
```
Configuration
-------------
Copy configuration template
```sh
cp config/config.json.dist config/config.json
```
Configuration file looks like this
```javascript
{
"irc": {
"server": "irc.server.com", // IRC Server
"port": "6667", // IRC Port
"ssl": false, // Use SSL
"channel": "#channel", // IRC Channel
"nickname": "h_bot", // Bot Nickname
"owner": "username", // Bot Owner Nickname (admin commands)
"cmd_prefix": "!", // Channel commands prefix (if any)
"output_msg": "<:username:> :message:", // Message format when IRC message is received
"output_cmd": "CMD by :username:", // Message format when IRC command is received
"log_events": true // Send part/join/kick/quit to discord
},
"discord": {
"server": , // Discord Server ID
"channel": , // Discord Channel ID
"token": "", // Discord Bot Token
"owner": "username", // Discord Bot Owner username (admin commands)
"cmd_prefix": "!", // Channel commands prefix (if any)
"output_msg": "<:username:> :message:", // Message format when Discord message is received
"output_cmd": "CMD by :username:", // Message format when Discord command is received
"log_events": true // Send part/join/kick/quit to IRC
},
"formatting": {
"irc_to_discord": false, // Keep bold|underline|italic from IRC to Discord
"discord_to_irc": true // Keep bold|underline|italic from Discord to IRC
}
}
```
Usage
-----
```
(discordirc) pixis@kali:~/Tools/discord-irc-sync $ python discord-irc-sync.py
[IRC] Logged in as:
[IRC] hacknbot
[Discord] Logged in as:
[Discord] irc-sync
[Discord] : Can you hear me IRC Tom? 😃
[IRC] : Yes, I can
```
TODO
----
- [X] Format message from Discord to IRC
- [X] Format message from IRC to Discord : Difficult because not everything is possible, especially when formatting is overlapping
- [ ] Multi channel
- [ ] Multi server
- [ ] Dynamically relaod conf when changed
- [ ] Change conf with IRC or Discord commands