The Technical Guide

Configuration Files

By default, all the configuration information and locally cached data from TheTVDB is stored in a series of XML files under the users Application folder (unless overridden using the command line option /userfilepath). They are stored at: -

\Users\<user-name>\AppData\Roaming\TVRename\TVRename\2.1

If you wish to make a backup of your TV Rename setup a copy of this folder is all you need!

It contains:

TVRenameSettings.xml Everything else not mentioned is stored in here. All your shows, media library paths, folder structures and settings. This is only overwritten when you choose File>Save.
TheTVDB.xml The locally cached tvdb.com show season and episode information for everything listed in the My Shows tab.
Layout.xml TV Rename’s window position and size as well as column widths.
Statistics.xml TV Rename’s historical statistics.

And stores the following backups (10 of each):

TVRenameSettings.xml.0-9 Backup copies of TV Rename settings.xml (FIFO).
TheTVDB.xml.0-9 A maximum of ten backup copies of TheTVDB.xml file. A new file gets created here every time the system gets updates from theTVDB on a first-in-first-out (FIFO) basis.

Log Files

The main log file (TVRename.log) can be found in: -

\Users\<username>\AppData\Roaming\TV Rename\log\

Log files are rotated into an “archive” folder (in the same location as TVRename.log) every time TV Rename is run or every 24 hours, whichever is sooner.

As with tvdb.json and settings.json a maximum of ten backup copies of the log file are kept (TVRename00.log - TVRename09.log) on a first-in-first-out (FIFO) basis.

Logging uses NLog. The configuration file (NLog.config) is stored in the TV Rename program folder.

You can read the NLog Wiki for guidance on how to adjust the configuration file to collect more information.

When raising a bug please include a log file that illustrates the issue if you can, it will help us find a solution quickly.

The Registry

The only information TV Rename stores in the registry is installation information which is used by Windows “Apps and Features” to un-install the program. But hey, why would you want to do that?

Source Code

You can find TV Rename’s source code (along with executables and this website) in The TV Rename GitHub Repository.

  • You can find the Developers Wiki here
  • For the longer term you can visit the “Roadmap” which lists the proposed Milestones (a high level view of whats planned for when).
  • In addition there is a Developers Forum in Google Groups which you can request access to.
  • The legacy forum can be accessed in read-only mode for background and history about the project

Framework

TV Rename uses the Microsoft .NET Framework. The installer will check for its presence and let you know if any action is needed. It’s a free download from Microsoft.

Credits

TV Rename pulls data from TheTVDB.com using their API. Please visit their site, register, and help out by contributing information and artwork for TV Series and Episodes.

It also uses: -

And thanks to:
Vecteezy! Vector Art for our cool Retro Television Logo - Vectors by www.vecteezy.com.