|
|
For questions, comments, concerns and updates, visit Reddit's /r/torrents subreddit.
QUICK CONFIGURATION:
This is a quick configuration guide to setting up RSSToolBot from the ground up.
- Install RSSToolBot.
- Run RSSToolBot and go to Tools > Preferences and click on the "Torrent Settings" area.
- Under Torrent Settings - set up all of the defaults you need and save them. The most important setting is either using Torrents or Magnets. Magnets are far more popular, but if your site only uses .Torrents then you'll want to set up the save directory.
- Make sure you set up your Torrent application you are using and any parameters you need.
- Click on the "Feeds" button and create a new feed. Give it a name, a category, how long to wait before attempting to pull the site in minutes and how long to keep .Torrents around - and then give it an RSS FEED URL. The RSS FEED URL is the HTTP or HTTPS URL to your favorite Torrent Website Feed. Save the Feed.
- Click on the "Torrents" button and click the "Run All" button. This will go through your Feeds and attempt to pull each one in. If all worked well (No HTTP(s) errors - check the Logging screen for errors) you should have a list of .Torrents in the Torrents area. If nothing appeared, click on the "Logging" button and go see what it says. Bad URL? Website can't be found? Website down? Bad feed?
- If all worked well - Click on ANY .Torrent in the Torrents area, right click and select "Create Filter based on Feed". This will take you directly to the Filters page.
- You should then be in the Filters Page. Give it a site name. Be sure to select the "Series Filter Expression Type" to match if it is a TV show or TV TALK SHOW. You do NOT have to set the Starting Series. On the "Filter Match Usage" below, make sure that you have a + (meaning must match) on the front of the show name. Strip out the season, episode stuff or you won't get a match. Example: "+Dang Big Theory". Click Save. Note: Read the RSSToolBotdocumentation.rtf file for more information on "Filter Match Usage" as this seems to be where end users have the most trouble.
- Now, go back to the Torrents screen and once again click the "Run All" button.
- Once it is finished processing, go to the Queue screen and look to make sure it is there. If it isn't, then something is wrong with your filter match, go see step 7.
PREFERENCES
RSSToolBot Preferences are broken into two areas, General Setting and Torrent Settings.
GENERAL SETTINGS:
"Show Load/Save Buttons on Edit Forms"
- This will show and hide save and load buttons on any editable form. Allows you to save or load the text.
"Check for Updates on Startup"
- This will check to see if there are any new updates to RSSToolBot.
"GRIDS - Color every other line in all display Database Grids"
- This will cause any displayable database grid to have distinguishing lines between them.
"Prompt first before Downloading Torrent"
- If you click the download button in either the Queue or the Feeds List - you will be asked if that is what you wanted to do.
"Show DB Navigator on Torrent Feeds"
- This displays a "First, Next, Last, Prev" database navigator on the Feeds List.
"Log RSSToolBot Events"
- This will create an RSSToolBot log and continually append to it. These files can get big so it's not advised to do so. You can use the logging button on the Main Form.
"Allow Duplicate Torrent Titles"
- RSSToolBot will break the torrents down by title and by feed. If you pull the same titles from multiple feeds - this will keep RSSToolBot from creating duplicates. By selecting active, you can have the same title but it will show from multiple site feeds.
"Start RSSToolBot Taskbar Minimized"
- This is so you can put RSSToolBot in your Startup - and it will start and automatically minimize to taskbar.
"On RSS HTTP Request Errors - STOP Any Further HTTP Requests on Site"
- If checked, RSSToolBot will attempt to pull each line of each RSS Feed. If any errors occur (meaning ALL errors, including a document not found, 404, 503, etc) - RSSToolBot will completely STOP attempting to pull that feed and move onto the next feed.
TORRENT SETTINGS:
"Default Number of days to keep .Torrent Feed List Items"
- When you create a new Feed this is the default number of days new RSS .Torrents will be kept around. This is overridden in the Filters section.
"Default Filter Creation Text (i.e. +720)"
- This is if you want to add an extra parameter to your Filter sets upon creation. Any text you add will automatically be added to any new filter you create.
"Re-Process RSS Torrents even if they exist in the Torrent Feeds"
- When RSSToolBot pulls an RSS .Torrent down it searches the Torrent Feeds DB (local) for an identical match. If found and this is set FALSE, RSSToolBot will skip trying to match the .Torrent again against filters. If this is checked TRUE, it will try to filter match every time you pull RSS feeds. Only drawback to this is that it can slow the system down a bit if you have a lot of RSS feeds coming in.
"What to do with .Torrent Files"
Save the .Torrent to a local Directory (set directory below) - OR - Send Link to .Torrent to a Torrent Application (using .Torrent App Params below)".
- If set to SAVE, RSSToolBot will download the .Torrent file and save it to the directory specified.
- If set to SEND, RSSToolBot will simply send the RSS .Torrent Enclosure to a specified Torrent Application you provide.
"Name and location of Torrent App"
- This is the full path and name of the .EXE of your Torrent Application. Use quote marks if windows is giving you errors.
".Torrent App Parameters:"
- %T = Torrent Enclosure
- %SD = Save Directory (See Filter Save Directory)
These are the parameters to send to your Torrent Application. It is required that you have at least %T which is the .Torrent Enclosure pulled from the RSS feed. The %SD is for the Save Directory - and comes from the filter.
Example: (Note: use "quote marks" to help Windows not be stupid in using directories)
%T /d=%SD
%T /DL="%SD"
NOTES on how Downloading actually works with the %SD and Filters:
- Manual Downloads Don't Use the %SD: If you use the Manual - there is no %SD parameter that can be passed because I haven't built in a "default save directory". It has not match on a filter in this case so it has no idea where to save it. It just passes it either as a .Torrent to a directory OR passes it with %T to your torrent app.
- Filtered Downloads USE the %SD: If you use the Filters - and it does a match and downloads (either automatically or send to queue), then it uses the "Torrent App "%SD" Save Directory To" field on the FILTER record (see the Filters screen). It does this because you've specified the directory where to save it.
Make sure you're not thinking the "Location of Local Files" is the Save Directory as it isn't, it's a misnomer I should remove. That piece is only for pulling LOCAL files in and saving them to history (to make sure you don't download the same episode twice).
"Directory to store .Torrent Files:"
- This is the directory where .Torrent files will automatically be saved to, if the option to not add to queue is set.
"Filter Match should automatically - Download .Torrent automatically - OR - Place .Torrent in the Queue to Download Later"
This will cause the .Torrent or Magnet file to:
- If set to download, it will automatically send it to your torrent application.
- If set to queue, it will add the file to the queue for you to inspect later.
RSS SITE FEEDS:
RSS Site Feeds allow you to add multiple site feeds with multiple line items for each feed. Each line item links to a location of an .RSS file.
MENU BAR:
- New: Create a new RSS Site Feed.
- Edit: Edit existing Feed.
- Save: Save Feed.
- Cancel: Cancel any changes made to Feed.
- Delete: Delete the feed: Warning: This will also delete ALL torrents associated with this feed.
ADDING/EDITING A FEED:
- Site Feed Is Active: If not ticked, this feed will never be run.
- Site RSS Feed Name: Give any name you want.
- Category: You can modify the category this is filed under Files > Torrent Categories.
- Delay in Minutes: This is how often this feed will pull the RSS file.
- Days to Keep Torrents: This is how long the torrents pulled from this feed will remain in the Torrent List.
- RSS Feed URL(s): This is the HTTP, or HTTPS location of your feed file.
Examples:
LOCAL FILE: c:\files\mylocaltorrentfile.rss
URL: https://www.bigtorrentsite.com/sometorrentfile.rss
Note: You can have as many feed URLS lines as you want.
TIMERS:
The Timers or Status Site RSS Feed Timers are a list of all your active Feeds. Here you can pause your site Feeds from running.
MENU BAR:
- Start: Starts the timers running again if they are off.
- Stop: Stops all the timers from running. You can still override the timers in the Torrents section by clicking Run All, but any stopped timers will remain stopped.
FILTERS:
The Filters allow you to filter out RSS .Torrent Feeds and automatically download or send to Queue any matching .Torrents. By using power regular expressions you can match down to precisely what you want to download. By using the Queue you review your matches before downloading.
MENU BAR:
- New: Creates a new Filter.
- Edit: Edits an existing Filter. You can either click the Edit button and begin editing, or, you can enter any field and start typing.
- Save: Saves any changes to a Filter.
- Cancel: Cancels all changes.
- Add History: Once a filter is set up you can then add all of your local media to the History DB. This is to make sure that RSSToolBot knows what files you already have if they find a filter match.
NOTE: The FIRST LINE of the Filter Match is used to find History items, all other lines will be ignored. The first line should contain the name of the matching media, like "+The Dang Big Theory".
How this works:
- Create the Filter and make sure the Filter contains correct Expression Type and a Filter Match.
- Click the Add Hist Button.
- Select the directory where your media files are.
- RSSToolBot will then search the directory selected and all sub directories. It will compare each file it finds against your filter Expression Type and Filter Match. If it finds a correct match, it will add it to your history DB.
- Delete: Deletes a Filter.
Toolbox:
- Enable All Filters: This will make all Filters that are inactive - Active.
- Disable All Filters: This will deactivate all Filters.
- Set All Filters Download Immediately: This will set all Filters ôSend Matching Filters Toö to be ôDownload Torrent Immediatelyö.
- Set All Filters: Send to Queue: This will set all Filters ôSend Matching Filters Toö to be ôAdd Torrent To Queueö.
- All Filters - Use Filter History: This will set all Filters to be set to ôUse Filter Historyö.
- All Filters - Disable Filter History: This will set all filters to disable ôUse Filter Historyö.
FILTER EDITING:
- Feed Is Active: This allows you to toggle the Feed active or inactive. If the Feed is Inactive it will not run in the Timers section.
- Use Filter History: If this is checked, then the Filter Matching will check the History DB. If this is unchecked (FALSE) then RSSToolBot could potentially download the same .Torrent files over and over.
- SITE FEED FILTER NAME: A required field, just the name of your Filter.
- SITE FEED: This is a matching Site Feed. Can be ALL or set to an existing Feed.
- Starting Series: This is the Year, Series (Season) and Episode. Any .Torrent Enclosures must match or be greater than the series. NOTE: Leave at Year 0, Series 0 and Episode 0 - to never check for Series.
- SERIES FILTER EXPRESSION TYPE: This is the matching Regular Expressions (See TOOLS > Expression Filter Sets) filter set to use:
- NONE - This will not evaluate an expression. Not recommended.
- TV SHOW - This will search for a SERIES and EPISODE (ie S01E01). Use this for regular TV shows that have a series and an episode.
- TV TALK SHOW - this will search for a YEAR, SERIES and EPISODE (ie 2015 10 10). Use this for talk shows that use a year, series and episode type.
- SEND MATCHING FILTERS TO:
- Download Torrent Immediately - This will download the .Torrent on match to either a Directory or send the Enclosure to a Torrent Application. Both of these are specified in Preferences.
Add Torrent To Queue - This will send the .Torrent to the Queue where you can download it at a later time.
- TORRENT APP SAVE DIRECTORY TO: This is the directory you want to pass to your Torrent Application if a match is found. This is set in Preferences as the command line parameter for your Torrent Application.
- Filter Match Usage: This is the .Torrent ôTITLEö matching and can be as complex as you desire. You can have as many lines as you want in your Filter matching. Each line is an individual operation and should only contain ONE + or ONE filter system.
Filter Match Rules:
- Each line must start with a + (plus symbol) or a - (minus symbol) with a SPACE and then TEXT.
- All items are NOT case sensitive, you can put whatever you want.
- The FIRST line should be the TITLE match of the media you are looking for.
- + Symbol means MUST CONTAIN. Example: "Dang Big Theory" means it must contain the words "Dang Big Theory".
- - Symbol means MUST NOT CONTAIN. Example: "-Spanish" means that if the title contains the word "Spanish" it will be rejected.
Examples:
+Dang Big Theory
+Eztv
Meaning: Must contain "Dang Big Theory" and "Eztv".
+ Dang Big Theory
+720p
-LOL
+RarTV
Meaning: Must contain "Dang Big Theory", "720p" and "RarTV" but will be rejected if contains "LOL".
TORRENT FEEDS:
The Torrent Feeds are where all downloaded RSS feeds are stored either with an "M" showing it is a Magnet, or "T" showing it is a .Torrent.
Each RSS feed is broken down into TYPE, TITLE, LINK and ENCLOSURE as those are the only important factors. While there is an RSS standard for RSS feeds, not a single Torrent website out there follows the standard. The RSS feed TITLE is stripped of bad characters to make it more readable. Duplicates are weeded out and Feeds are assigned a Type, Site, Category and RSS pull date.
Tips:
- Click the FIRST, PREV, NEXT, LAST buttons to move around manually.
- Click the grid and right-click the grid to bring up a sub menu of similar options.
- Use the arrow keys to move up, down, home, end, page up, page down.
- Press and hold CTRL while clicking to select multiple individual .Torrents.
- Press and hold SHIFT while moving the ARROW keys to move-multi-select .Torrents.
MENU BAR:
- Run All: This is a manual run of all Feeds. This will override all Timers and run a GET against all Feeds. It will process any Filters and reset all Timers. Any downloaded RSS .Torrents that match filters will be processed according to your Preferences.
- DL Now: This will immediately download the selected .Torrent(s) to a directory or to the Queue. If the Torrent type is a Magnet, it cannot be saved to a directory - it can only either be sent to a Torrent application or added to the Queue. Any .Torrent sitting in the Torrents table do not contain a "Save Directory", they are just stored there as either a Magnet or a .Torrent link. Matches on automatic timer running will copy the Filter "Save Directory" and use it correctly. In addition to this, if a .Torrent HTTP/HTTPS Get Request fails on Download, the .Torrent will be marked as "DL ERROR", placed into the Queue - allowing you to download it again.
- DL Queue: This will place the selected Magnet or .Torrent(s) into the Queue for later processing.
- Manual RSS: This allows you to specify a manual .RSS feed that is not stored in the Feeds list. It must be processed against a local active Feed (See Feeds). You can either specify a URL or you can load a local .RSS file. All items brought in will be processed against that site and corresponding filters. This is a good way to bring in feeds that arenÆt associated with an actual scheduled Feed.
- Add Filter: This will copy the Title of the .Torrent selected and create a new Filter based against it. You will then need to fill out the details and save the new Filter.
- View: This will view the contents of the RSS .Torrent. This includes TITLE, LINK and ENCLOSURE and gives you the option to download now or send to the Queue. NOTE: Magnet files can be viewed, but may not look right since they are a different format that a .Torrent.
- Open Web: Using the RSS .Torrent "Link" (if it exists and was imported), you will be directly taken to the site contained in the "Link". This allows you to view the link before deciding to download the .Torrent.
Toolbox:
- Mark All Torrents Inactive: Marking .Torrent feeds inactive just hides them until you select the "Show Inactive" checkbox. .Torrent feeds are still deleted by the Feeds settings.
- Mark All Torrents Active: Marking .Torrent feeds active means they will show.
- Delete ALL Torrents: This will delete all of the stores RSS .Torrent feeds out of the Torrent Feeds table. This does not affect downloaded or history items.
SEARCH, SORT, CATEGORY:
- Search Box: The search box allows matching of singular text. So you can search for ôDang Bigö, but the words must be conjoined. Search will only search within the category and feed selected.
- Search Button: Searches for whatever you put in the search box. Pressing ENTER in the search box does the same thing.
- Clear Button: Clears the search text.
- Clear All Button: Clears the search text, sets the Category to ôAllö and sets the RSS Feed to "All".
- Category Drop Down: Changes the DB grid results depending on the category you select. Categories can be set from Tools > Categories.
- RSS Feed Selector: This selects an RSS Feed depending on the feeds you have set up. Set this to ôAllö to filter on All Feeds.
- Show Inactive Checkbox: Determines if RSS .Torrents you have hidden will be shown.
TORRENT QUEUE:
The Torrent Queue is where all queued RSS feeds are stored ready to be processed.
Tips:
- Click the FIRST, PREV, NEXT, LAST buttons to move around manually.
- Click the grid and right-click the grid to bring up a sub menu of similar options.
- Use the arrow keys to move up, down, home, end, page up, page down.
- Press and hold CTRL while clicking to select multiple individual .Torrents.
- Press and hold SHIFT while moving the ARROW keys to move-multi-select .Torrents.
MENU BAR:
- DL Now: This will immediately download the selected .Torrent(s) to a directory or to a Torrent Application. If the .Torrent in the Queue came from a filter and the Save Directory has been set, then the %SD parameter will be passed as a command line parameter if set in Preferences and you are using a Torrent application rather than "Save to directory" options. See Preferences, Torrent Settings. In addition to this, if a .Torrent HTTP/HTTPS Get Request fails on Download, the .Torrent will be marked as "DL ERROR", placed into the Queue - allowing you to download it again.
- DL All: See DL Now, but goes in bulk.
- Delete: Deletes the RSS .Torrent from the Queue. This does not delete the history item from History.
- Open Web: Using the RSS .Torrent "Link" (if it exists and was imported), you will be directly taken to the site contained in the ôLinkö. This allows you to view the link before deciding to download the .Torrent.
SEARCH, SORT, CATEGORY:
- Search Box: The search box allows matching of singular text. So you can search for "Dang Big", but the words must be conjoined. Search will only search within the category and feed selected.
- Search Button: Searches for whatever you put in the search box. Pressing ENTER in the search box does the same thing.
- Clear Button: Clears the search text.
HISTORY:
The History DB is where all downloaded RSS .Torrents are stored. This is to ensure that the same .Torrent will not be downloaded twice. The table is stored by filter match, season, episode, to-episode and year. Only torrents that are matched by automatic filtration are stored here. Any torrents manually downloaded will not be added to the history.
Tips:
- Click the FIRST, PREV, NEXT, LAST buttons to move around manually.
- Click the grid and right-click the grid to bring up a sub menu of similar options.
- Use the arrow keys to move up, down, home, end, page up, page down.
- Press and hold CTRL while clicking to select multiple individual .Torrents.
- Press and hold SHIFT while moving the ARROW keys to move-multi-select .Torrents.
MENU BAR:
- DL Now: This will immediately download the selected .Torrent(s) to a directory or to a Torrent Application. If the .Torrent in the Queue came from a filter and the Save Directory has been set, then the %SD parameter WILL NOT be passed as it is not stored here. If the .Torrent fails on DL, it will not be placed into the Queue as a "DL ERROR".
- Delete: This deletes the .Torrent from history. This means that the .Torrent could be downloaded again if there is a Filter match.
- View: This will view the contents of the RSS .Torrent. This includes TITLE, LINK and ENCLOSURE and gives you the option to download now or send to the Queue.
- Open Web: Using the RSS .Torrent "Link" (if it exists and was imported), you will be directly taken to the site contained in the "Link". This allows you to view the link before deciding to download the .Torrent.
ToolBox:
- Delete ALL History Items: This will clear out the History table. WARNING: If you clear out the history table then any matching .Torrent Filter matches will be downloaded again. Only do this if you absolutely must.
- Backup History File: Backup your history file.
- Restore History File: Restore your history file.
SEARCH, SORT, CATEGORY:
- Search Box: The search box allows matching of singular text. So you can search for "Dang Big", but the words must be conjoined. Search will only search within the category and feed selected.
- Search Button: Searches for whatever you put in the search box. Pressing ENTER in the search box does the same thing.
- Clear Button: Clears the search text.
CATEGORIES.
Categories allow you to assign torrents/magnets to a category in addition to assigning them to a site. This way you can filter down even further in your Feeds List.
MENU BAR:
- New: Creates a new Category.
- Edit: Edits an existing Category
- Save: Saves any changes to a Category.
- Cancel: Cancels all changes.
- Delete: Deletes the Category. Warning: Any Feeds or Filters using this Category will be set to ôALLö and cannot be set back.
EXPRESSIONS:
Expressions allow you to create customizable expression sets for filtering very specific RSS filenames, seasons, years, and to-episodes.
MENU BAR
- New: Creates a new Expression.
- Edit: Edits an existing Expression. You can either click the Edit button and begin editing, or, you can enter any field and start typing.
- Save: Saves any changes to a Expression.
- Cancel: Cancels all changes.
- Delete: Deletes an Expression.
- Toolbox: Allows you to re-create expressions from scratch should you make enough mistakes nothing is matching at all.
RSSToolBot Regular Expression File. Match key:
- S = Season
- E = Episode
- T = To-Episode
- Y = Year
Example: S12E14
Expression: S([0-9]{1,2})E([0-9]{1,2})
Match Key: SE
Type: TV Show
Example: 12X14
Expression: ([0-9]{1,2})X([0-9]{1,2})
Match Key: SE
Type: TV Show
Example: S12E14-15
Expression: S([0-9]{1,2})E([0-9]{1,2})[-]([0-9]{1,2})
Match Key: SET
Type: TV Show
Example: S30E04E05
Expression: S([0-9]{1,2})E([0-9]{1,2})E([0-9]{1,2})
Match Key: SET
Type: TV Show
Example: S12E14+15
Expression: S([0-9]{1,2})E([0-9]{1,2})[+]([0-9]{1,2})
Match Key: SET
Type: TV Show
Example: 7X12-14
Expression: ([0-9]{1,2})X([0-9]{1,2})[-]([0-9]{1,2})
Match Key: SET
Type: TV Show
Example: 7X12+14
Expression: ([0-9]{1,2})X([0-9]{1,2})[+]([0-9]{1,2})
Match Key: SET
Type: TV Show
Example: 2014 12 01
Expression: ([0-9]{4})\s([0-9]{1,2})\s([0-9]{1,2})
Match Key: YSE
Type: TV Talk Show
Example: 20141201
Expression: ([0-9]{4})([0-9]{1,2})([0-9]{1,2})
Match Key: YSE
Type: TV Talk Show
Example: 2014X12
Expression: ([0-9]{4})X([0-9]{1,3})
Match Key: YE
Type: TV Talk Show
|
|