-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.tvrenamer
60 lines (44 loc) · 2.26 KB
/
README.tvrenamer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
Ruby TV File Renamer
Written by Brian Stolz - [email protected]
Originally written by Sam Saffron - [email protected]
This script was originally written by Sam to download meta data for your TV shows. It has been
rewritten it to only be a fast file renamer. It keeps a cache of all of your filenames checking
them every 10 days to see if the filename has changed. You can force a recheck of all filenames
as well.
WHAT YOU NEED TO KNOW
---------------------
This script assumes you have your TV episodes in a directory structure such as:
"\Show Name\Season Number\Episode"
You must have your files already in a directory structure like this. The Show Name must match
the show name from TheTVDB. For example do not use "Battlestar Galactica" for the new BSG series
use "Battlestar Galactica (2003)" instead. So this would look like:
"\Battlestar Galactica (2003)\Season 1\battlestar.galactica.s01e01.avi"
USAGE
-----
Usage: ruby tvrenamer.rb directory [--refresh|-r] [--format=<format>|-f <format>]
--nocache Do not cache old renames at all
--refresh Refresh cache of downloaded XML
--format=<format> Format to output the filenames
CONFIG
------
The script does not need any configuration as long as you want to use the default formatting which
will make filenames such as:
Battlestar Galactica (2009) s03e10 - The Passage.avi
It will also use a multi-format for 2 episode files:
Battlestar Galactica (2009) s03e11e12 - The Eye of Jupiter (Part 1) - Rapture (Part 2)
The name format is configurable either on the command line, or using a settings file.
Settings can be saved in a "tvrenamer.yml" file inside a .ruby-tvscripts directory in your home
directory (linux) or user profile directory (windows) which is a YML file with default config values.
See the tvrenamer.yml-example file.
Example Windows XP Directory: C:\Document and Settings\USERNAME\Application Data\.ruby-tvscripts\
Example Windows Vista Directory: C:\Users\USERNAME\AppData\Roaming\.ruby-tvscripts\
Example Linux Directory: /home/USERNAME/.ruby-tvscripts/
Formatting variables:
%S = Series Name
%E = Episode Name
%s = Season Number
%e = Episode Number
%p = Part Number (optional)
%E2 = Episode 2 Name (optional)
%e2 = Episode 2 Number (optional)
%p2 = Part 2 Number (optional)