Difference between revisions of "Sapphire"

From AwkwardTV
Jump to: navigation, search
(Fetch Tool)
Line 89: Line 89:
=== Fetch Tool ===
=== Fetch Tool ===
Sapphire will also attempt to download cover art (for files only) automatically from TVRage.com.  Any cover art that the fetch tool finds will be placed in a directory @ the same level of the file.
Sapphire will also attempt to download cover art (for files only) automatically from [http://www.tvrage.com TVRage.com].  Any cover art that the fetch tool finds will be placed in a directory @ the same level of the file.

Revision as of 11:50, 4 July 2007

Version Information

Sapphire Beta 3 (1.0b3.1)

  • Fixed an issue that was causing the UI to crash when attempting to "Mark All to Refresh TV Date".

Sapphire Beta 3 (1.0b3)

  • File Importer is more clear about what it is doing and what files it's working on.
  • Fixed an issue that was causing the browser to crash.
  • Fixed an bug causing file / directory divider to display more than once on the screen.
  • Updated the meta data pruning functions to be more efficient.
  • Fixed an issue that was causing Sapphire to crash when running in Finder 1.1.
  • Added TV Show data fetching from tvrage.com.
  • Added cover art support with the naming conventions of ATVFiles.
  • Episodes will now look for folder cover art (cover.ext) up to two parent directories. This allows for a single cover.ext to be displayed by shows nested using the directory convention of: /<Show>/<Season>/episode.ext.
  • TV Show fetching tool will now attempt to download cover art for individual episodes and place them in a sub-directory (./Cover Art/<filename>.ext).
  • TV Show fetching tool will ask the user to select the appropriate TV Show title if it doesn't know it.
  • TV Show fetching tool isn't as picky when it comes to CAsE senSiTiVe fIlE NAmes.
  • Added episode level ATVFiles cover art support.
  • Show browsers will now display the episode title and episode number instead of the file name and file size respectively if the information is available.
  • Added a smaller sized default preview icon for aesthetically pleasing reflections.
  • Show browser will sort shows by episode number first (when known) and then by filename.
  • File Import tool will now automatically look for correctly formatted ATVFiles XML files to import file information.
  • TV Show fecthing tool will now collect air dates for matched episodes.

Sapphire Beta 2

  • Fixed some texture loading issues
  • Added Fast Directory Switching - This will keep the browser from trying to find updated files when enabled.
  • Added "Scan for new files" to the Favorites/Unwatched browsers. Selecting this will force the browser to refresh the file listing. This option is only visible when Fast Directory Switching is enabled in the settings menu.

Sapphire Beta 1

  • We are happy to announce the first beta release of Sapphire.

Comments and any bug reports would be greatly appreciated. Submit a Report



Sapphire is an Apple TV Plug-in primarily designed for managing medium to large size television show collections. The Sapphire Browser has the ability to filter out watched media files from several different directory trees and intuitively display them. Additionally Sapphire allows for marking favorite files that can also be viewed in a filtered menu. Media playback has also been improved allowing the user to fast-forward through shows at a constant (aggregated) rate independent of the file duration. Finally, Sapphire allows the user to import file information using an import tool (through the settings menu) to dramatically speed up the data gathering required for maintaining large media collections.



Beta 3


Beta 2

More screenshots of the UI can be found Here.

Gem Colors

Sapphire uses some gem icons to identify files. Here is a short description on what each color signifies:

File Gems

  • Blue Gems - Mark Unwatched files.
  • Yellow Gems - Mark Favorite files that have already been watched.
  • Red Gems - Mark files that have already been watched and are not favorites.

Directory Gems

  • Blue Gems - Mark directories containing any unwatched files.
  • Yellow Gems - Mark directories with favorite files and no unwatched files.
  • Red Gems - Mark directories that contain files that have been watched and are not favorites.

Cover Art


Sapphire now supports ATVFiles's cover art naming convention.

  • Directories will use an image with the name cover.ext
  • Files will use an image with the name <FileName>.ext

Fetch Tool

Sapphire will also attempt to download cover art (for files only) automatically from TVRage.com. Any cover art that the fetch tool finds will be placed in a directory @ the same level of the file.


If we have the following files:

  • /TV Shows/Rome/Season 1/Rome.S01E01.avi
  • /TV Shows/Rome/Season 1/Rome.S01E02.avi
  • /TV Shows/Rome/Season 1/Rome.S01E03.avi
  • /TV Shows/Rome/Season 1/Rome.S01E04.avi
  • /TV Shows/Rome/Season 1/Rome.S01E05.avi

The Fetch tool will find and make a cover art directory with the following:

  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E01.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E02.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E03.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E04.ext
  • /TV Shows/Rome/Season 1/Cover Art/Rome.S01E05.ext

Folder Cover Art

Folder cover art for the most part works exactly as it does in ATVFiles. The only difference is that files inside a respective folder will default to the folder's cover art if it doesn't have its own specific (<filename>.ext) to display. This mechanism allows episodes to inherit cover art from two directories above itself.


If we have the following directories:

  • /TV Shows/Heroes/Season 1/cover.ext
  • /TV Shows/Heroes/Season 1/
  • /TV Shows/Lost/cover.ext
  • /TV Shows/Lost/Season 2/

Sapphire will display the respective covers if the directories don't have their own cover art. If a cover.ext doesn't exist the browser will default to the Sapphire icon.


Sapphire Fetch Tool File Formats

To get better results fetching show information from TVRage.com we have chosen to specifically support. These file formats are very forgiving and conform to typical naming schemes.

  • show.name.S##E##...ext
    • (REGEX IS [\. -]?S[0-9]+E[S0-9]+ )
    • The.Sopranos.S03E12.avi
  • show.name.#x##...ext
    • (REGEX IS [\. -]?[0-9]+x[S0-9]+ )
    • Heroes.1x22.avi
  • show.name.###...ext
    • (REGEX IS ( [\. -][0-9]{1,3}[S0-9]{2}[\. -] )
    • Dead.Like.Me.203.avi

... -> can be any substring . -> any seperator (dot,space,dash)

Settings Menu

  • Populate Show Data - This tool is used to preform a search of your /Movies/ directory to gather meta data info.
  • Fetch TV Data - This tool is used to get episode information and episode cover art from TVRage.com.
  • Hide "Favorite Shows" - Removes the Favorite Shows browser from the main menu.
  • Hide "Unwatched Shows" - Removes the Unwatched Shows browser from the main menu.
  • Hide "Hide UI Quit" - Removes the UI reset option from the main menu.
  • Disable Anonymous Reporting - Turns off the anonymous filename reporting (used for debugging and developing future Sapphire features)


  • 1. Download the Sapphire Plug-in Here.
  • 2. Unzip and place the Sapphire.frappliance folder inside the directory /System/Library/CoreServices/Finder.app/Contents/PlugIns/ located on your Apple TV's OSBoot partition.
  • 3. Access the Sapphire main menu using your Apple TV.
  • 4. Go to the "Settings" Menu and select "Populate Show Data". This import tool will go through your /frontrow/Movies/ directory collecting file information that is used to when browsing through Sapphire.
  • 5. Be patient. The import tool can take a considerable amount of time depending on how many mounts you are using. During testing, a fresh import on ~1 Tera byte worth of TV Shows took about 5 minutes. The import might be slower if you are using the airport.
  • 6. Once the import has finished, you might want to tag the files you have already watched, or tag your favorite files. The best way to do this is to select "Browse Shows" from the main menu. Once you have found a directory or file you wish to "Mark as Favorite" or "Mark as Watched", use the right arrow to toggle to the "Mark" mode. Select the file/directory and mark appropriately. To toggle back into "Select" mode hit the left arrow.
  • 7. If you would like to fetch TV Episode information for your media collection, this would be a good time to run it. As Sapphire fetches episode information from http://www.tvrage.com it might ask you to select from a list of TV show titles to match the current file being processed.
  • 8. Enjoy your fully personalized "Unwatched" and "Favorite Shows" menus packed full of Episode information!