Options and Preferences

The Options Menu One of TV Rename’s strongest (and most confusing) features is its configurability. For the newcomer especially, it’s very easy to get “lost” in the plethora of options and preferences, and give up.

Luckily the “out-of-the-box” defaults work well, and, should you wish to change any of the options or preferences at some future time all the stuff you can “fiddle” with is described here.

Offline Operation

If Offline Operation is enabled TV Rename will firstly prompt you to make sure you wish to go offline, and if you click Yes it will run on locally cached data from The TVDB. This will stop TV Rename attempting to update.

Automatic Background Download

If Automatic Background Download is enabled any action that reads data from the cache will also trigger an update fromThe TVDB, additionally updates will be performed at regular intervals.

Preferences

Each of the tabs in “Preferences”, are discussed in detail below.

The General Tab

Preferences - the General tab “X” days count as recent specifies how many recent days are listed for the for “Aired in the last N days” section of the When to watch tab.

Default: 7 days

Download up to “X” shows simultaneously from The TVDB sets the number of concurrent connections to TheTVDB API.

It can be set in the range to 1 to 8.

Default: 4

Refresh entire series if “X” % of episodes are updated sets the point at which TV Rename refreshes the entire series data from The TVDB rather than just the episode data. This speeds up local data updates if major changes are made to a show on The TVDB.

Default: 20%

Look for air date in filenames if ticked, provides a second method of identifying show episodes by looking for a date (in a number of formats) in the shows filename and comparing that against the air-date.

The supported date formats are:

“yyyy-MM-dd”, “dd-MM-yyyy”, “MM-dd-yyyy”, “yy-MM-dd”, “dd-MM-yy” and “MM-dd-yy”

And the “date separators” can be any of: - / . , “ “ (a space)

Default: Un-ticked

The Preferred language: drop-down sets the language for returned data when requesting information from TheTVDB API. TV Rename will request “English” If the selected language is not available.

The Mode: drop-down allows you to preview functionality that is being worked on but not yet ready for the mainstream releases. The options available are “Production” and “Beta”.

In “Production” mode the application looks and behaves as normal.

In “Beta” mode a new menu called Beta appears between Tools and Help which gives you access to preview upcoming additions and enhancements.

If you select “Beta”, TV Rename will offer you “Beta” and “RC” updates as well as the “Production” updates.

Default: Production

The Display Tab

Preferences - The Display tab

Double-click in When to Watch does: Controls the double-click action in the When to watch tab. Options are Search and Scan.

Default: Search

The Startup Tab: selects which tab you wish open when TV Rename loads. My Shows, Search or When to Watch.

Default: My Shows

The Show Notification Area and Show in Taskbar interact, one of them must be ticked. If you try to un-tick both the option you are changing clears, but the other one automatically sets.

If Show in Taskbar is selected TV Rename’s icon appears in the Windows taskbar.
If Show Notification Area is selected TV Rename’s icon appears in the System Tray. Right-clicking it will show an “Upcoming Shows” list, and double clicking restores the main window.
Both boxes can be ticked, in which case you get both functionalities.

Defaults: “Show Notification Area” Un-ticked
  “Show in Taskbar” Ticked

Show episode pictures in episode guides Does what-it-says-on-the-tin, if ticked screen grabs from show episodes are displayed with the episode description in the My Shows tab. If un-ticked only the episode description is displayed.

Default: Ticked

Hide Spoilers in My Shows hides the display of summaries of yet to be broadcast episodes (with a suitable message) in the My Shows tab

Default: Un-ticked

Hide Spoilers in When To Watch hides the display of summaries of yet to be broadcast episodes (with a suitable message) in the When to watch tab

Default: Un-ticked

Automatically select show and season in My Shows If ticked this works for both the When to watch and Scan tabs. If an item is selected in either of these tabs the My Shows tab is automatically updated to highlight the indicated show and season.

Default: Ticked

The last two options are self explanatory, however please note that they only affect the “season” display in the My Shows tab.

The Scan Options Tab

Preferences - the Scan Options tab This tab in conjunction with data from the µTorrent / NZB tab controls the Scan tabs checks and actions.

The settings in here are more or less self explanatory, however remember that the µTorrent / NZB tab must be populated before the µTorrent and SABnzdb options can be used, and, similarly the RSS/JSON Search must be populated before the RSS and JSON options can be used.

NOTE: If you use a NAS device as your media library and it is Linux based it has an epoch date of 01/01/1970 00:00. Files cannot have a date/time-stamp earlier than this. If you have any TV Show episodes whose original release date was earlier than this and you have the “Update files and folders with air date” box ticked they will be set to 01/01/1970 00:00 to prevent repeated detection and attempts to change during scans.

Defaults    
Scan checks Rename Check Ticked
and actions Prevent move of flies Un-ticked
  Missing Check Ticked
  Look in “Search Folders” for missing files Ticked
  Copy files, don’t move Un-ticked
  Check µTorrent queue Un-ticked
  Check SABnzdb queue Un-ticked
  Check qBittorrent queue Un-ticked
  Search RSS for missing files Un-ticked
  Search JSON for missing files Un-ticked
Folder Creation Automatically create missing folders Un-ticked
Additional Actions Update files and folders with air date Un-ticked
  Automatically create merge rules for merged downloaded episodes Un-ticked
  Automatically create merge rules for merged library episodes Un-ticked
  Update episodes when higher quality ones found Ticked

The Search Folders Tab

Preferences - the Search Folders tab The Search Folders tab is used to tell TV Rename where to look for TV show episode files BEFORE they are processed. Logical entries in here would be your downloads folder (if you download TV show episodes from the internet) or maybe your desktop (if you rip TV show episodes from DVD or Blu-ray). Or both!

Three buttons are available at the bottom of the tab. Add opens an explorer style window so you can browse to the folder location you wish to add and click OK, Remove removes a highlighted row from the panel and Open opens an explorer window targeting the row highlighted in the panel.

At the top of the tab the “Scan Type” radio buttons tell TV Rename the type of scan to perform when searching for new shows.

Full A full scan of all shows and seasons.
Recent A Scan of all the shows that have aired recently. !
Quick Scan the shows that have aired recently and have a missing episode in the library. Also check the locations specified in Options>Preferences - Search Folders for any matching media files.

Ticking “Scan on Startup” tells TV Rename to perform the selected scan when the program starts, ticking “Scheduled scan…” will force a repeat scan every “X” hours and finally, ticking “Monitor folders for changes” will tell TV Rename to “listen” for Windows “dropping” new files in the identified locations.

Defaults: “Scan Type” Full
  “Scan on Startup” Un-ticked
  “Scheduled scan every” Un-ticked - 1 hour
  “Monitor folders for changes” Un-ticked

The RSS / JSON Search Tab

Preferences - The RSS/JSON Search Tab

RSS Search

The “Preferred Terms:” text box acts as a filter on the RSS search and contains a semicolon delimited list. There must be a match in the RSS feed to return a search result. The default entry will only find RSS feed results that contain 720p or 1080p in the video names.

Default: 720p;1080p

“The Torrent RSS URLs:” can be any suitable RSS-feeds provided by indexers or public RSS websites and are used to search for missing files.

Add and Remove allow you to add and remove feeds, and Open presents the highlighted feed in a web browser.

JSON Search

The JSON Search is broadly similar.

It downloads information from the web and searches for useful content.

NOTE: Please be aware that JSON Search is currently tightly tied to the EZTV API, and may not work in some countries due to ISP filtering.

Basically the JSON Search:

  1. Takes the URL from the settings.
  2. Appends the IMDB id.
  3. Downloads the data.
  4. Goes to the node indicated by the “root Note”.
  5. Iterates across items in that node looking for tags with “Filename Token” and “URL token”.
  6. If the filename token looks like it is something useful it downloads the URL token.

If things go wrong…

Ticking the “Detailed logging” box will greatly increase the log detail around either the RSS or JSON searches providing lots of detail - useful ifyou are having trouble setting up either of the searches.

It is recommended that you only use this option if you need to. When ticked the size of the log file will grow very quickly.

The Files and Folders Tab

Preferences - The Files and Folders tab The “Filename Replacements” grid controls the replacement of illegal characters in filenames.

If the filename contains a character that isn’t supported in a windows filename the grid is checked row by row to discover what to use instead of the problem character.

“Video Extensions:” tells TV Rename the extensions to match when looking for video files. The entries should be semicolon delimited, not contain spaces and include the “.” preceding the extension.

“Other Extensions:” follows the same rules as “Video Extensions” but the file extensions specified are typically for video related files rather than video. The extensions listed by default are :-

.srt Subtitles in text format.
.nfo An XML style file that contains information about the video, such as a title, summary, list of actors, year of production etc. This information is often used by media players to provide a more immersive viewing experience.
.txt Text files can be any text but quite often, if the base name of the text file is the same as that of the video file, they contain subtitles in text format.
.tbn A KODI/XBMC specific jpeg.

It is common for files to have the same base name for example: BigBuckBunny.avi, BigBuckBunny.sub and BigBuckBunny.nfo. This helps keep them organised.

TV Rename knows this, hence the “Copy/Move file with same base name as video” tick-box. Which gives you the ability to turn this functionality on or off.

Default: Ticked

The “Do” drop-down and text box underneath provide a degree of granularity to this function.

The next two preferences allow you to set the text for the Specials and Season folders - useful if you speak “English as a second language”.

The “Specials folder name:” text box allows you to modify the name used when creating a “Specials” folder for a show.

It is common practice for specials to be labeled as part of “Season 0” so for example: special 3 of “Battlestar Galactica” would be labeled “Battlestar Galactica - S00E03 - The Story So Far” and stored (by default) in the “Specials” folder.

Default: Specials

Similarly, the “Season folder format:” text box allows you to customise the name used when creating a “Season” in your media library.

Default Season {Season}

The Ignore “sample” videos and Make all filenames lower case tick boxes need no further explanation.

The final two options help TV Rename when replacing videos that already exist in the library.

The “Priority override terms:” text box defines the “hints” used to determine if a video has been improved at source.

Default: PROPER;REPACK;RERIP (Note the semicolon delimiter).

“Consider a file better if it is X% higher resolution/longer tells TV Rename to replace an existing library file if the newly found version is higher resolution and/or longer.

Default: 10%

The Folder Deleting Tab

Preferences - the Folder Delete tab This tab is all about TV Rename tidying up after itself.

When downloading video from the internet its quite common to get .nfo files, screen grabs, sample video, text-art files and the like bundled with the download.

TV Rename automatically takes care of the video file and any others you media play may require, renaming them and copying or moving them to your media library.

The settings in this tab take care of the rest.

The flow through this tab is pretty self explanatory, start by ticking the “Delete empty folders…” box to enable the action. The other settings are fairly obvious, tick the boxes and modify the text as required. It should be noted that “Ignore any files with these words…” also includes folders.

If you use the copy option to update your library then ticking the “Clean up already copied…” box will delete the source files after the copy is complete.

Default: All functionality disabled

The Media Center Tab

Preferences - the Media Centre tab Here you can tell TV Rename about your media player (and hence, any additional files you may need to download).

The tick box options in each group should already be familiar to you if you use that particular media player.

The Presets button (bottom right) allows you to quickly apply all the relevant presets for the chosen media player.

Note: The functionality of this tab is currently under review due to the growth in the media player market - so expect some changes in Version 3!

The Torrents / NZB Tab

Preferences - the Torrents / NZB tab Some of the contents of this tab are used in conjunction with the Scan Options tab.

TV Rename can check SABnzbd µTorrent and qBittorent queues and uses the information on this tab to know where to look for more information.

Both the “Host Port” and “API Key” are required to use this functionality in SABnzbd.

If you use µTorrent, TV Rename needs to know the “Application” and “resume.dat” paths, (they can be found with the Browse buttons) so it can detect if files are queued or in the process of being downloaded.

TV Rename uses the qBittorrent web interface to interrogate its status so you must turn on the Web UI in qBittorrent and tell it to “Bypass authentication for clients on localhost” if you wish to use this client. In addition TV Rename needs to know the host name and port for the interface so it can communicate with the client (defaults shown).

The Bulk / Auto Add Tab

Preferences - the Bulk/Auto Add Tab The Bulk/Auto Add tab provides access to settings for both Tools>Bulk Add Shows and the Preferences>Scan Options - Additional Actions: Notify when new shows are found preference.

Looking at the Bulk Add: section, two options are available and they both work as “junk filters”.

Firstly, Only Include Folders containing Video Files if ticked restricts the “Bulk Add” scan to only include folders with video files.

Default: Un-ticked

And Secondly, Ignore Recycle Bin tells the “Bulk Add” scan to exclude the (Windows) Recycle Bin even if it contains video files.

Default: Un-ticked

And Finally, Force to Use Season Words from Settings only tells the “Bulk Add” scan to just use the words entered in the preferences when it is scanning to decide whether the series has a flat structure or a ‘folder by season’ structure.

Default: Un-ticked

The Auto Add: section comes in to play when the Preferences>Scan Options - Additional Actions: Notify when new shows are found option is ticked.

The “Movie Terms:” box helps TV Rename identify “types” of video file.

Default: dvdrip;camrip;screener;dvdscr;r5;bluray

And the “Ignore Suffixes:” box tells TV Rename to ignore the specified suffixes.

Default 1080p;720p

The Subtitles Tab

Preferences - the Subtitles tab The Subtitles tab is used to tell TV Rename how to handle subtitle files in your collection.

The Retain Language Specific Subtitles tick box (when ticked) tells TV Rename to retain subtitle files containing two or three letter language codes. For example: -

Video S01E01.en.srt

Subtitles must be of the form *.language.extension, where language is 2 or 3 characters.

Default: ticked

Subtitle files come in a number of guises of which one of the most common is a .sub file. These are text files structured in a way that media players can establish the start time, finish time and content of a subtitle and display it. Quite often sources for these files give them a .txt extension, for example: BigBuckBunny.txt. Ticking the “Rename .txt to .sub” option will tell TV Rename to rename these files when copied or moved.

Default: Un-ticked

The Automatic Export Tab

Preferences - the Automatic Export tab Ticking the “RSS” box in the “When to watch” section of the panel will save a RSS-reader compatible XML file to the location you specify (by typing or browsing). This file can then be read by something like XBOX Media Center, or a Windows RSS App.

Ticking the “XML” box in the “When to watch” section of the panel will save a standard XML file to the location you specify (by typing or browsing).

Ticking the “iCal” box in the “When to watch” section of the panel will save an open format Internet Calendar ICS file (not to be confused with Apple Calendar) to the location of you specify (by typing or browsing).

You can limit how many days or shows are written to the file. The files are updated whenever the “When to watch” tab is manually or automatically refreshed.

Ticking the “XML” box in the “Missing” section of the panel will save a standard XML file containing the missing episodes detected during a scan to the location you specify (by typing or browsing).

Similarly, ticking the “CSV” box in the “Missing” section of the panel will save a standard CSV file containing the missing episodes detected during a scan to the location you specify (by typing or browsing).

Ticking the “TXT” box in the “All Shows” section of the panel will save a TXT file whenever a show is added, edited or deleted from TV Rename. It also gets updated when Auto ID All in the Scan Results tab of Tools>Folder Monitor is clicked.

Similarly, ticking the “HTML” box in the “All Shows” section of the panel will save a web browser viewable HTML file containing the show summary for each show in your library (complete with images and other details) whenever a show is added, edited or deleted from TV Rename. It also gets updated when Auto ID All in the Scan Results tab of Tools>Folder Monitor is clicked.

Ticking the “XML” box in the “Renaming” section of the panel will create an XML file in the path specified containing the rename data.

Ticking the “XML” box in the “Finding and Organising” section of the panel will create an XML file in the path specified containing the found file data.

The “Recent Playlist” section of the tab tells TV Rename to export a playlist of all the episodes found in the “Aired in last X days” section on the When to watch tab in the specified format to the specified file and location.

Default: All un-ticked

The Tree Coloring Tab

Preferences - the Tree Coloring tab If you have a large catalogue of old TV Shows that you want to keep on the system, the My Shows tab can be somewhat cluttered, but you don’t want to remove anything from TV Rename. Tree Coloring to the rescue…

Tree coloring allows you to change the color of the text on the left hand pane of the My Shows tab depending on the status of the show or the show season.

To create a record:-

  • Expand the “Status:” drop-down and select the status you wish to match from the list.
  • Select a color to associate with the status by either entering a web-safe color name or code in the “Text Color:” box or clicking Select Colour and choosing from the pallet.
  • Click the Add button and your new entry will appear the box above.

For example: to make finished shows less obtrusive in My Shows expand the “Status:” drop-down and select “Show Status: Ended”, in the “Text Color:” box type “#808080” and click Add. Back in the My Shows tab; text for shows that have finished will be light grey and less obtrusive.

If you wish to remove a rule from the list just select it and click Remove.

Ignore List

The Edit Ignore List window When a Scan is run any “missing” episodes for shows in your media library are listed.

These may be genuine missing episodes or they may be “Specials”, that don’t fit the season/episode pattern but are still part of the show, for example: -

My Favourite Show - S00E03 - Recap of Last Season

This may be something you want or it may just be adding to the “noise” in the Scan tab.

If it is “noise” you can highlight the row (or multiple rows if that fits better) and right click. A cut-down menu appears, if you select “Ignore Selected” the item is removed from the Scan results and appears in the “Ignore List”.

If, at a later date, you decide you wish to add the item, you can remove it from the Ignore list using the Edit Ignore List window, selecting the item in question and clicking Remove.

Filename Template Editor

The Filename Template Editor tab This is where the format of the filenames that TV Rename will rename to are defined.

To help illustrate the results the “Sample and Test:” panel contains the processed entries from the show and season selected in the My Shows tab.

The “Naming template:” text box displays a tokenised version of the filename which can be edited directly or populated using the “Tags:” drop-down, or overwritten with a record selected from the “Presets:” drop-down. Any changes in the “Naming Template:” are automatically reflected in the “Sample and Test:” panel.

The available tags with their definitions are listed below: -

{ShowName} Name of the Show
{Season} Number of the season
{Season:2} Number of the season forced to 2 characters with a leading zero
{Episode} Number of the episode (within a season), eg S01E03
{Episode2} Number of the second episode of a pair (within a season), eg S01E04-E05
  created by the default S{Season:2}E{Episode}[-E{Episode2}])
{EpisodeName} Name of the Episode
{Number} Overall number of the episode
{Number:2} Overall number of the episode forced to 2 characters with a leading zero
{Number:3} Overall number of the episode forced to 3 characters with leading zero(s)
{SeasonNumber} Some season numbers do not start at 1, eg they may go 2012,2013,2014. {SeasonNumber} is the nth season, so would be 1,2,3 in this example
{SeasonNumber:2} As above, but forced to 2 characters with a leading zero
{ShortDate} Air date in short format, eg 25/12/2017
{LongDate} Air date in lomg format, eg 25 December 2017
{YMDDate} Air date in YMD format, eg 2017/12/25
{AllEpisodes} All episodes - E01E02 etc
Default: {ShowName} - S{Season:2}E{Episode}[-E{Episode2}] - {EpisodeName}
  (the second preset).

Search Engines

The Modify Search Engines window The Modify Search Engines window controls TV Rename’s outgoing interface with the world (other than TheTVDB). Here, you can configure how and where TV Rename points a web browser searching for files.

Using the Add and Delete buttons you can create or remove records at will, and the Tags... pop up a list of supported tags to remind you whats available. (The tags supported are the same as those listed in the Filename Template Editor.)

As an example, here is a URL entry for Google.

https://www.google.co.uk/search?q={ShowName}+S{Season:2}E{Episode}

The list of URL’s can be used when the When to watch tab is open, the last used entry becomes the default, and appears in a text box to the right of the Refresh button. It can be changed by clicking the button and selecting another entry.

With a little ingenuity you can get really creative with these entries and pass your search to its specific target through a web proxy.

Filename Processors

he Filename Processors window In much the same way that the Filename Template Editor is used to process the names of files being moved to the media library so Filename Processors is used to inform TV Rename what filenames to look out for when searching for a missing files

To really understand the contents of the Regex column above, you need a working knowledge of Regular Expressions.

Once you have figured out whats going on you can see that all the regular expressions capture the season and episode number of a show from the filename. Each one can work on just the filename: -

ShowName S01E07.avi

or on the whole path: -

C:/files/ShowName/S01E07.avi

The expressions are evaluated in order (top down).

Each expression can be toggled on and off, as can the ability to process a full path.

Each expression has a Notes field which can be used to remind the user why the expression was added.

Additionally, a folder can be specified to test the results of the Regular Expression.

If a match is found during the test the matching expression is indicated.

In all likelihood you will find it unnecessary to make changes here, only if a new, totally unrecognisable file name structure appeared would it be necessary, and then there would probably be discussion about it in the forum.