How to use Movie sheets v2

From WikiDLXTV
Jump to: navigation, search

Introduction

Moviesheets are fullscreen, prerendered images which are displayed as background when you select a folder or media file.
These images have to be created with an external application. Some of them are listed in the Links section at the end of this document.

I'm going to explain the setup for both versions based on the telnet commands, on recent WDLXTV versions you can also configure most of these options in WEC (WebEnd Configuration) or by putting the commands used here in your S00custom-options file.

Moviesheet Modes

There are three different moviesheet modes:

  • SHEET [MSHEETMODE=sheet]
    In sheet mode you will see 7 thumbs or 7 list items (depending on thumb/list mode) at the bottom of the screen and the sheet displayed as background.
    Sheet Mode


  • WALL [MSHEETMODE=wall]
    In wall mode you will see 4x3 thumbs or 10 list items on the left of the screen and the sheet displayed as background.
    Wall Mode


  • STD (standard) [MSHEETMODE=std]
    In std mode you will see the normal thumb/list view if no sheet is found and a full screen sheet in foreground (overlaying the thumbs/list) if a sheet is found.
    Std Mode


Moviesheet Methods

There are two different ways to get Moviesheets displaying on WDLXTV:

  • LINKSHEETS (WDLXTV G2/LIVE/PLUS)
    Linksheets works on G2, LIVE and PLUS in any newer WDLXTV version!
    This is the "old" method of displaying moviesheets. It's a shell script which searches for sheets on your drives and link them into the OSD. If you have a lot of media files this takes quite some time and this scan is repeated on each reboot.
    • PRO:
      • Very fast display of the sheets while browsing media files. There's almost no delay when the sheets are displayed.
    • CONTRA:
      • Media/Sheet filenames MUST be unique!
      • Scanning on boot takes a long time (depending on how many files to scan)


  • WDTVExt ExtSheet plugin (1.02.21-WDLXTV_LIVE only!)
    ExtSheet plugin will ONLY work on 1.02.21 based firmwares!!
    This is a WDTVExt plugin which will search for sheet files dynamically while you are browsing your media files. It also offers some trick not possible with linksheets: a combined wall/std or sheet/std mode.
    Note: The plugin was renamed from MovieSheet to ExtSheet to avoid a bit of confusion.
    • PRO:
      • No time consuming drive scan on boot
      • Ability to hide the movie name when a sheet is present
      • Ability to show full screen std mode sheet in wall and sheet mode
    • CONTRA:
      • Currently only works with WDLXTV_LIVE versions based on 1.02.21 firmware!
      • Sheets are displayed slower. The delay before they show up depends on the location (network/usb) and the sheet's filename.


Moviesheet Files

The sheet images MUST match the following rules or it will NOT work!

You also have to understand that there are two different types of sheet files:

  • file sheets
    These are sheets for media files, they are shown if you have a media file selected.
  • folder sheets (normally not used in std mode)
    These are sheets for folder (or directories), they are shown if you have a folder selected.


If you want to have your sheets hidden when browsing Network Shares, you can name them starting with a . (dot). This trick will de-clutter your screen. If you are browsing through Local Media, it shouldn't matter, since images are automatically hidden when browsing movies.

There is a thread on the forum explaining the search algorithm used to search for sheets.
WDLXTV-G2/Live/Plus-0.4.2.1+ MovieSheets Naming conventions
You should really read and understand it!
These file naming conventions are valid for both versions!


Setup Linksheets

Required Settings

You need to set some config setting to get LINKSHEETS to work. You have to enable LINKSHEETS and disable the display of the file size or LINKSHEETS will NOT work!

config_tool -c LINKSHEETS=ON
config_tool -c SHOW_FILESIZE_SETTING=0

LINKSHEETS will NOT work if SHOW_FILESIZE is enabled!


User Settings

  • MSHEETMODE=[sheet|wall|std|] (case sensitive! - empty string means off)

This config setting configures the sheet mode.You can choose between sheet, wall and std (all lower case!).

config_tool -c MSHEETMODE=sheet


The following config settings define on which browse mode sheets should be used (Listview or Thumbview).

  • VIDMSHEET=[ON|OFF]

Use sheets for the video thumbs browse mode.

config_tool -c VIDMSHEET=ON
  • LISTMSHEET=[ON|OFF]

Use sheets for the video list browse mode.

config_tool -c LISTMSHEET=ON
  • GENMSHEET=[ON|OFF]

Use sheets for audio/photo thumb browse mode.

config_tool -c GENMSHEET=ON


You can place the sheet images in a different folder (on a different drive) instead of having them in the same folder as media files.

  • MSHEETDIR

Advanced configuration of a central sheet repository. See http://wiki.wdlxtv.com/MSHEETDIR_migration_guide for instructions.


  • DEFAULTSHEET (requires version 0.4.8.0 or higher!)

This option allows you to have a default sheet displayed when no other sheet can be found.
Eg. this will display your background image when no sheet is found:

config_tool -c DEFAULTSHEET='image/villa_bg.jpg'

Webend Configration

WEC - OSD

Tips

  • If you are running 1.03.49_WDLXTV_LIVE-0.4.5.3 you may have to disable WDTVExt (it isn't supported/included in this firmware anyways...)
config_tool -c WDTVEXT=OFF


  • Wait until the linksheets scan process is finished (all LED's stopped blinking) before you browse your files.


  • To rescan a directory for sheets manually you can execute this command in telnet/ssh (example will rescan all usb drives and xmounts)
linksheets /tmp/media/usb


Setup ExtSheet plugin (1.02.21 based WDLXTV_LIVE only)

This plugin was recently renamed from MovieSheet to ExtSheet plugin!
The ExtSheet plugin offers some extra options that are not available/possible with LINKSHEETS.

Required Settings

Yuo need to have WDTVExt enabled and the ExtSheet plugin (included in WDLXTV) loaded.

config_tool -c WDTVEXT=ON


User Settings

  • MSHEETMODE=[sheet|wall|std|] (empty string means off)

This config setting configures the sheet mode.You can choose between sheet, wall and std (all lower case!).

config_tool -c MSHEETMODE=sheet


The following config settings define on which browse mode sheets should be used (Listview or Thumbview).

  • VIDMSHEET=[ON|OFF]

Use sheets for the video thumbs browse mode.

config_tool -c VIDMSHEET=ON
  • LISTMSHEET=[ON|OFF]

Use sheets for the video list browse mode.

config_tool -c LISTMSHEET=ON
  • GENMSHEET=[ON|OFF]

Use sheets for audio/photo thumb browse mode.

config_tool -c GENMSHEET=ON


  • DEFAULTSHEET

This option allows you to have a default sheet displayed when no other sheet can be found.
Eg. this will display your background image when no sheet is found:

config_tool -c DEFAULTSHEET='image/villa_bg.jpg'

Advanced Options

The following options are Expert Options!
Keep your hands off these settings until you have your Moviesheets up and running and know what you are doing.
If you don't understand something in the explanation of these setting, they are not for you!
I'm serious, I won't help anyone who uses these setting but hasn't gotten basic Moviesheets to work!

These options are refering to WDLXTV 0.5.0.0. Previous versions of this plugin used config settings starting with MOVIESHEET_ instead of EXTSHEET_ !
So if you are using a WDLXTV version lower than 0.5.0.0 you need to replace EXTSHEET_ with MOVIESHEET_ or just use the webend.


  • EXTSHEET_HIDE_TITLE=[ON|OFF] (requires WDLXTV 0.4.3.1 or higher)

If this option is set to yes the filename display below the thumbs will be hidden if a sheet is displayed.

config_tool -c EXTSHEET_HIDE_TITLE=ON


  • EXTSHEET_FORCE_STD=[ON|OFF] (requires WDLXTV 0.4.5.3 or higher)

This will enable a special mode which makes sense if you have a folder structure where each movie is in it's own folder!

Remember there are two different sheet types (file/folder)?
If you have set your sheet mode to sheet or wall mode and enable this option, the plugin will search for std mode file sheets although we are in sheet or wall mode.So you must have a sheet file that complies with the std sheet naming convention for this to work.
The effect is the following: While browsing the folders of your movies you get the typical wall or sheet display, but when you enter a folder and select a file it will display the fullscreen std mode sheet in foreground instead of the wall or sheet mode file.

config_tool -c EXTSHEET_FORCE_STD=ON


  • .force_std_mode (requires WDLXTV 0.4.5.3 or higher)

If you create a file called .force_std_mode inside a folder,it triggers the same mode as MOVIESHEET_FORCE_STD, but for a single folder.

touch /tmp/media/usb/movies/NiceMovie/.force_std_mode


  • EXTSHEET_USE_FORCED_STD=[ON|OFF] (requires WDLXTV 0.4.7.0 or higher)

This is a combination of the both options above and works in wall and sheet mode. If you enable this and have a file

<MOVIE>.<EXT>_forced.std.jpg

in the movie folder this sheet will be displayed as std mode sheet for the file.


  • EXTSHEET_DEBUG=[0-5]

This enables the debug log. If you have problems and want to find out what is going on and why your sheets don't display, set this and have a look at /tmp/dmaosd.log.

config_tool -c EXTSHEET_DEBUG=5


Webend Configuration

WEC - WDTVExt Features


Tips

  • The filename of your sheets will have impact on the search and display speed. If your shee file matches a name on top of the list of #Moviesheet Naming Conventions it will be found quicker and displayed faster.
  • The size of the sheet image also has some influence on the display speed since they are displayed (and loaded) dynamically.


Examples

Example LINKSHEETS Setup

config_tool -c WDTVEXT=OFF
config_tool -c SHOW_FILESIZE_SETTING=0
config_tool -c LINKSHEETS=ON
config_tool -c MSHEETMODE=sheet
config_tool -c VIDMSHEET=ON
config_tool -c LISTMSHEET=ON
config_tool -c GENMSHEET=ON


Example ExtSheet Setup

config_tool -c WDTVEXT=ON
config_tool -c MSHEETMODE=sheet
config_tool -c VIDMSHEET=ON
config_tool -c LISTMSHEET=ON
config_tool -c GENMSHEET=ON


Example File Structures

Here are some example file structures for different modes:


Sheet Mode

  • Every movie in it's own folder
File Description TG Variable Notation TG file extension
Movies folder
Movies/Blade.Runner-1982 folder
Movies/Blade.Runner-1982/Blade.Runner.avi media file
Movies/Blade.Runner-1982/Blade.Runner.avi_sheet.jpg generic file sheet $M\$N$E_sheet .jpg
Movies/Blade.Runner-1982/Blade.Runner.jpg file thumb $M\$N .jpg
Movies/Blade.Runner-1982/Blade.Runner-1982_sheet.jpg generic folder sheet $M\$F_sheet .jpg
Movies/Blade.Runner-1982/folder.jpg folder thumb $M\folder .jpg


  • All movies in one folder
File Description TG Variable Notation TG file extension
Movies folder
Movies/Blade.Runner.avi media file
Movies/Blade.Runner.avi_sheet.jpg generic file sheet $M\$N$E_sheet .jpg
Movies/Blade.Runner.jpg file thumb $M\$N .jpg


Std Mode

File Description TG Variable Notation TG file extension
Movies folder
Movies/Blade.Runner-1982 folder
Movies/Blade.Runner-1982/Blade.Runner.avi media file
Movies/Blade.Runner-1982/Blade.Runner.avi_sheet.std.jpg std file sheet $M\$N$E_sheet.std .jpg
Movies/Blade.Runner-1982/Blade.Runner.jpg file thumb $M\$N .jpg
Movies/Blade.Runner-1982/folder.jpg folder thumb $M\folder .jpg


Sheet/Wall/Std Mode Combined Setup

This setup let's you switch between modes...

File Description TG Variable Notation TG file extension
Movies folder
Movies/Blade.Runner-1982 folder
Movies/Blade.Runner-1982/Blade.Runner.avi media file
Movies/Blade.Runner-1982/Blade.Runner.avi_sheet.sheet.jpg sheet mode file sheet $M\$N$E_sheet.sheet .jpg
Movies/Blade.Runner-1982/Blade.Runner.avi_sheet.std.jpg std mode file sheet $M\$N$E_sheet.std .jpg
Movies/Blade.Runner-1982/Blade.Runner.avi_sheet.wall.jpg wall mode file sheet $M\$N$E_sheet.wall .jpg
Movies/Blade.Runner-1982/Blade.Runner.jpg file thumb $M\$N .jpg
Movies/Blade.Runner-1982/Blade.Runner-1982_sheet.sheet.jpg sheet mode folder sheet $M\$F_sheet.sheet .jpg
Movies/Blade.Runner-1982/Blade.Runner-1982_sheet.wall.jpg wall mode folder sheet $M\$F_sheet.wall .jpg
Movies/Blade.Runner-1982/folder.jpg folder thumb $M\folder .jpg


Sheet Mode with Std Mode File Sheets

This does NOT work with LINKSHEETS!

File Description TG Variable Notation TG file extension
Movies folder
Movies/Blade.Runner-1982 folder
Movies/Blade.Runner-1982/.force_std_mode options file
Movies/Blade.Runner-1982/Blade.Runner.avi media file
Movies/Blade.Runner-1982/Blade.Runner.avi_sheet.std.jpg std mode file sheet $M\$N$E_sheet.std .jpg
Movies/Blade.Runner-1982/Blade.Runner.jpg file thumb $M\$N .jpg
Movies/Blade.Runner-1982/Blade.Runner-1982_sheet.sheet.jpg sheet mode folder sheet $M\$F_sheet.sheet .jpg
Movies/Blade.Runner-1982/folder.jpg folder thumb $M\folder .jpg


Sheet Mode with Sheet Repository

(MSHEETDIR='/tmp/media/usb/sheets')

File Description TG Variable Notation TG file extension
sheets folder
sheets/Blade.Runner.avi_sheet.sheet.jpg sheet mode file sheet X:\Path to sheet repo\$N$E_sheet.sheet .jpg
sheets/Blade.Runner-1982_sheet.sheet.jpg sheet mode folder sheet X:\Path to sheet repo\$F_sheet.sheet .jpg
Movies folder
Movies/Blade.Runner-1982 folder
Movies/Blade.Runner-1982/Blade.Runner.avi media file
Movies/Blade.Runner-1982/Blade.Runner.jpg file thumb $M\$N .jpg
Movies/Blade.Runner-1982/folder.jpg folder thumb $M\folder .jpg



Moviesheet Naming Conventions

These naming conventions are valid for LINKSHEETS and ExtSheet.

Notes:

  • Sheet Repository will only be searched if MSHEETDIR is set in config.
  • Default sheet will only be used is DEFAULTSHEET is set in config.

Variables:

<MODE> = MovieSheet mode (std, sheet or wall)
<REPO> = Sheet Repository (what you set with config_tool -c MSHEETDIR)
<FOLDER> = current selected folder while browsing
<FILE> = current selected file while browsing
<DEFAULTSHEET> = default MovieSheet (what you set with config_tool -c DEFAULTSHEET)

Folder Sheets

Wall / Sheet Mode

<REPO>/<FOLDER>_sheet.<MODE>.jpg
<REPO>/<FOLDER>_sheet.jpg
<FOLDER>_sheet.<MODE>.jpg
<FOLDER>/<FOLDER>_sheet.<MODE>.jpg
<FOLDER>/.<FOLDER>_sheet.<MODE>.jpg
<FOLDER>_sheet.jpg
<FOLDER>/<FOLDER>_sheet.jpg
<FOLDER>/.<FOLDER>_sheet.jpg
<FOLDER>/wd_tv.jpg
<FOLDER>/.wd_tv.jpg
<FOLDER>/folder.jpg_sheet.<MODE>.jpg
<FOLDER>/.folder.jpg_sheet.<MODE>.jpg
<FOLDER>/folder.jpg_sheet.jpg
<FOLDER>/.folder.jpg_sheet.jpg
<FOLDER>/*_sheet.<MODE>.jpg
<FOLDER>/*_sheet.jpg
<DEFAULTSHEET>

Std Mode

<REPO>/<FOLDER>_sheet.<MODE>.jpg
<REPO>/<FOLDER>_sheet.jpg
<FOLDER>_sheet.<MODE>.jpg
<FOLDER>/<FOLDER>_sheet.<MODE>.jpg
<FOLDER>/.<FOLDER>_sheet.<MODE>.jpg
<FOLDER>_sheet.jpg
<FOLDER>/<FOLDER>_sheet.jpg
<FOLDER>/.<FOLDER>_sheet.jpg


File Sheets

Wall / Sheet Mode

<REPO>/<FILE>_sheet.<MODE>.jpg
<REPO>/<FILE>_sheet.jpg
<FILE>_sheet.<MODE>.jpg
.<FILE>_sheet.<MODE>.jpg
<FILE>_sheet.jpg
.<FILE>_sheet.jpg
wd_tv.jpg
.wd_tv.jpg
<DEFAULTSHEET>

Std Mode

<REPO>/<FILE>_sheet.<MODE>.jpg
<REPO>/<FILE>_sheet.jpg
<FILE>_sheet.<MODE>.jpg
.<FILE>_sheet.<MODE>.jpg
<FILE>_sheet.jpg
.<FILE>_sheet.jpg
wd_tv.jpg
.wd_tv.jpg


Generating Sheets

Now you need to generate the actual data for your movie collection. The easiest available way to do this is via the "ThumbGen" utility (you can get it here or here).

To use ThumbGen for movie sheets (and not just thumbnails) you must have some kind of template, and you can find some of these on the wdtvforums here (thanks to QuickSurfer for the great post).

Links

Sheet Generators

Windows

Linux

Additional Information