From a46046393bd9e764f09c6174799987ad47b25fa3 Mon Sep 17 00:00:00 2001 From: benji7425 Date: Wed, 20 Sep 2017 00:07:23 +0100 Subject: [PATCH] Fix readme and changelog being gone --- CHANGELOG.md | 128 ++++++++++++++++++++++++++++++++++++++++++++++++++- README.md | 55 +++++++++++++++------- 2 files changed, 165 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8deb76e..4b67469 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,129 @@ # Changelog -## Unreleased \ No newline at end of file +## v3.0.0-b2 + +### Fixed + +- Full and short youtube urls not being properly converted + +## v3.0.0-b1 + +### Added +- Fancy new @bot help command + +### Updated +- Significant back-end updates +- Commands now invoked with an @mention to the bot + +## v2.0.0-b1 + +### Added +- Multi-guild support +- In-chat commands for setup and configuration + - Add a new feed + - View a list of feeds + - Remove an existing feed + +### Updated + +- Make save file configurable to allow use as a module with other bots +- Update config file structure +- Now uses discord.js instead of discord.io +- YouTube links automatically handled; no more separate "YouTube mode" config item + +### Fixed + +- Crash if trying to view feeds list before any feeds have been set up + +## v1.4.0 + +### Added + +- Support for posting links from multiple feeds +- Tagging of separate roles for each feed being checked + +### Updated + +- Updated bot connection code to use my discord-bot-wrapper + +### Removed + +- !logsplease command removed as the OTT logging was just being annoying + +## v1.3.2 + +### Fixed + +- Fixed list posting channel messages being ignored + +## v1.3.1 + +### Fixed + +- Developer commands can now be used from any channel or PM + +## v1.3.0 + +### Added + +- Deletion of "You have successfully subscribed" messages after a short delay (configurable) +- 'Developer' commands that can only be accessed by specified users +- !cacheList developer command to view the cached URLs + +### Updated +- !logsplease is now a developer command +- Subscriptions are now done using a role + - !subscribe and !unsibscribe add and remove the user from the role + - !sublist command is now removed + - The role is mentioned when the link is posted, rather than a long chain of user IDs + +## v1.2.1 + +### Fixed + +- Fixed multiple users being unsubscribed when one user unsubscribes + +## v1.2.0 + +### Added + +- Chat message/command to request a list of subscribed users +- The ability for users to 'subscribe' so they are tagged whenever a new link is posted +- Logging to a file +- Ability for user to request an upload of the logs file + +### Updated + +- Added basic spam reduction when logging so the same message won't get logged multiple times in a row +- Refactored a bunch of code to improve efficiency +- Updated timer logic to only ever use a single timer, and share it between posting and reconnecting + +## v1.1.2 + +### Updated +- Updated reconnect logic to hopefully be more stable + +## v1.1.1 + +### Added +- Reconnect timer to repeatedly try reconnect at intervals + +### Updated + +- Updated support for https conversion to http to hopefully be more consistent + +## v1.1.0 + +### Added + +- Added togglable YouTube mode + - Converts full URLs to YouTube share URLs + - Checks against both YouTube full and share URLs to ensure same video not posted twice +- New logging class to handle logging + +### Updated +- Major refactor of a significant portion of the bot's code - should be easier to maintain now, but may have introduced some new bugs +- Changed expected name for bot config file to bot-config.json rather than botConfig.json + +### Fixed +- New timer being created every time the bot reconnected diff --git a/README.md b/README.md index a705629..4a2bc49 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,63 @@ -# Template README +# Discord rss bot -Summary goes here +Posts the latest URLs from an RSS feed, optionally @mention-ing a role when posted ## Features -- Feature 1 -- Feature 2 -- Feature 3 +- Multiple feeds per server +- Configurable channel per feed +- Optional, configurable role per feed, mentioned when a URL is posted +- In-chat setup commands +- Detects if a user "beats me to it" and posts the URL before the feed updates (useful for slow feeds) +- Detects users posting both full and short YouTube urls if using a YouTube RSS feed ## Invite By inviting this bot to your server you agree to the [terms and conditions](#privacy-statement) laid out in the privacy section of this document. -If you agree, invite to your server with [this link](https://link-goes-here.com/). +If you agree, invite to your server with [this link](https://discordapp.com/oauth2/authorize?client_id=343909688045469698&scope=bot&permissions=0x00010c00). ## Setup -You can ask the bot for help with commands by typing `@bot help` +You can ask the bot for help with commands by typing `@RSS_Bot help` -### Use case 1 +### Add a new feed -`@bot command ` -Explanation +`@RSS_Bot add-feed <#channel> [@role]` +- *url* must be an RSS feed URL +- *#channel* must be a channel mention +- *@role* must be a role mention (make sure "Anyone can mention this role" is turned on during setup) Example: -`@bot command example-param` +`@RSS_Bot add-feed http://lorem-rss.herokuapp.com/feed?unit=second&interval=30 #rss-posts @subscribers` + +### View feeds configured for this server + +`@RSS_Bot view-feeds` +This will display a list of RSS feeds configured for this server, along with a unique ID for each + +### Remove a configured feed + +`@RSS_Bot remove-feed ` + +To remove a feed you will need it's unique ID, which you can find by running the above *view-feeds* command + +Example: +`@RSS_Bot remove-feed ABc-123dEF` ## Permissions The bot requires certain permissions, which you are prompted for on the invite screen. Each permission has a reason for being required, explained below. -| Permission | Reason | -|---------------|-------------------------------| -| Read messages | Detect when you use commands | -| Send messages | Respond when you use commands | +| Permission | Reason | +|----------------------|-------------------------------------------------------------| +| Read messages | Detect when you use commands | +| Send messages | Respond when you use commands; post new RSS links | +| Read message history | Check if any new RSS links have been posted during downtime | ## Privacy statement @@ -50,7 +70,8 @@ In accordance with the [Discord developer Terms of Service](https://discordapp.c This bot will only collect data which is necessary to function. No data collected will be shared with any third parties. -Should you wish for the data stored about your server to be removed, please contact me via [my support Discord server](https://discordapp.com/invite/SSkbwSJ) and I will oblige as soon as I am able. Please note that this will require you to remove the bot from your server. +Should you wish for the data stored about your server to be removed, please contact me via [my support Discord](https://discordapp.com/invite/SSkbwSJ) and I will oblige as soon as I am able. Please note that this will require you to remove the bot from your server. + ## Want to host your own instance? @@ -62,4 +83,4 @@ Should you wish for the data stored about your server to be removed, please cont ## Need help? -I am available for contact via my [support Discord server](https://discordapp.com/invite/SSkbwSJ). I will always do my best to respond, however I am often busy so can't always be available right away, and as this is a free service I may not always be able to resolve your query. \ No newline at end of file +I am available for contact via my [support Discord server](https://discordapp.com/invite/SSkbwSJ). I will always do my best to respond, however I am often busy so can't always be available right away, and as this is a free service I may not always be able to resolve your query.