Connects Discord and IRC channels by sending messages back and forth.
Note: discord-irc requires Node.js version 6 or newer, as it depends on discord.js.
Before you can run discord-irc you need to create a configuration file by
following the instructions here.
After you've done that you can replace /path/to/config.json in the commands
below with the path to your newly created configuration file - or just config.json if it's
in the same directory as the one you're starting the bot from.
When you've done that you can install and start the bot either through npm:
$ npm install -g discord-irc
$ discord-irc --config /path/to/config.jsonor by cloning the repository:
In the repository folder:
$ npm install
$ npm run build
$ npm start -- --config /path/to/config.json # Note the extra double dashIt can also be used as a module:
import discordIRC from 'discord-irc';
import config from './config.json';
discordIRC(config);First you need to create a Discord bot user, which you can do by following the instructions here.
[
// Bot 1 (minimal configuration):
{
"nickname": "test2",
"server": "irc.testbot.org",
"discordToken": "botwantsin123",
"channelMapping": {
"#other-discord": "#new-irc-channel"
}
},
// Bot 2 (advanced options):
{
"nickname": "test",
"server": "irc.bottest.org",
"discordToken": "botwantsin123",
"autoSendCommands": [ // Commands that will be sent on connect
["PRIVMSG", "NickServ", "IDENTIFY password"],
["MODE", "test", "+x"],
["AUTH", "test", "password"]
],
"channelMapping": { // Maps each Discord-channel to an IRC-channel, used to direct messages to the correct place
"#discord": "#irc channel-password" // Add channel keys after the channel name
},
"channelReMappingStatus": { // channel to send status messages to such as joining and leaving, mapped to base channel
"#discord": "#discord2"
},
"ircOptions": { // Optional node-irc options
"floodProtection": false, // On by default
"floodProtectionDelay": 1000 // 500 by default
},
"ircNickColor": false, // Gives usernames a color in IRC for better readability (on by default)
// Makes the bot hide the username prefix for messages that start
// with one of these characters (commands):
"commandCharacters": ["!", "."],
"webhookMapping": {
"#discord": "id token" // https://discordapp.com/api/webhooks/{id}/{token}
}
}
]The ircOptions object is passed directly to node-irc (available options).
Run the tests with:
$ npm testdiscord-irc follows the Airbnb Style Guide. ESLint is used to make sure this is followed correctly, which can be run with:
$ npm run lint
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent