Driven by the lack of comprehensive RSS bots available, I have decided to try my hand at creating one of my own. Designed with as much customization as possible for both users and bot hosters, while also (or should be) easy to understand.
All documentation can be found at https://github.com/synzen/Discord.RSS/wiki.
Looking for a non-Discord version of this bot? See https://github.com/synzen/feedtracker
See https://github.com/synzen/Discord.RSS/wiki/Setup
The fastest way to using Discord.RSS with an existing discord.js client with npm:
npm install discord.rss
const Discord = require('discord.js')
const DiscordRSS = require('discord.rss')
const client = new Discord.Client()
const drss = new DiscordRSS.Client({ database: { uri: './sources' } }) // File-based sources instead of Mongo
client.login('token')
drss.login(client) // Can be done before or after the client is 'ready'
or create a new client:
const DiscordRSS = require('discord.rss')
const drss = new DiscordRSS.Client({ database: { uri: './sources' } }) // Optional config overrides
drss.login('token')
There are multiple ways of integrating Discord.RSS programmatically - see here for more information. For full features, use a mongodb database.uri instead of a directory.
- html-to-text - Convert HTML content
- moment-timezone - Customizable timezones
You can deploy the bot in a simple way to Heroku using the button below. Click here for detailed instructions.
If you want to deploy manually you can follow this guide.
Read the contribution guidelines. All the latest updates are commited to the dev branch.
To add or contribute to menu translations (locales):
- If the locale JSON doesn't exist in src/locales, create one by running
node scripts/locales/create.js
- Open the relevant locale file in src/locales
- Add your translations (use the en-US.json locale as reference)
- Verify your file(s) by running
node scripts/locales/verify.js
and make appropriate fixes - Make a pull request for your changes!