rssbot
TypeScript icon, indicating that this package has built-in type declarations

1.1.6 • Public • Published

EasyDiscordRSS

Turn your Discord server into a rss feed

Quick Start

Follow these two instructions to add a bot to your server.

  1. Create bot application
  2. Add bot to server

Rembember to select both bot and applications.commands for the OAuth2 URL generator.

You should note down the token, client id, public key, and the server id as they will be needed own the initial registration of slash commands.

npm i -g rssbot
rssbot register # register slash commands
rssbot run

If everything went well then the bot should be up and running and typing /rss in any channel will show a list of all available commands.

Add RRS Feed To Channel

/rss add name url
  • name: should be unique
  • url: usually just the base url with /rss or /feed

Remove RRS Feed From Channel

/rss rem name

Use In Your Own Project

npm i rssbot
registerInteractions(opts) // register slash commands
const bot = new RSSBot("token") // create and start bot
bot.client // standard Discord client

Turn any site into a rssbot compatable source by extending the Feed class.

class SomeRandomSiteFeed extends Feed {
	async _fetch(): Promise<Post> {
		/*
        get site data and scrape
        */
	}
}

bot.addCustomFeed(new CustomSiteFeed())

The custom feed will then be available with

/feed add name

Dependencies (5)

Dev Dependencies (2)

Package Sidebar

Install

npm i rssbot

Weekly Downloads

1

Version

1.1.6

License

MIT

Unpacked Size

33.4 kB

Total Files

19

Last publish

Collaborators

  • waffelroffel