Media stubs - Revision history

Karellen at 00:56, 31 July 2024

2024-07-31T00:56:33Z

← Older revision		Revision as of 00:56, 31 July 2024
Line 28:		Line 28:


	<gallery mode="packed" heights="~~500px~~">		<gallery mode="packed" heights="600px">
	MediaStubs02.jpg		MediaStubs02.jpg
	</gallery>		</gallery>

Karellen: v21 Updates

2024-07-31T00:55:42Z

v21 Updates

← Older revision		Revision as of 00:55, 31 July 2024
Line 13:		Line 13:

	= Creating =		= Creating =
	The Media Stub File is a simple text file with the extension '''''.disc''''' instead of .txt extension. Once the file is saved correctly, {{kodi}} will see this file as an unplayable media file.		The Media Stub File is a simple text file with the extension '''''.disc''''' instead of .txt extension. In {{kodi}} a .disc file is interpreted as another media file type like mkv or mp4. Once the file is saved correctly, {{kodi}} will see this file as an unplayable media file.

	#Create a blank text file and rename the filename in accordance with proper Movie and TV Show '''''[[Naming_video_files\|Naming Conventions]]'''''.		#Create a blank text file and rename the filename in accordance with proper Movie and TV Show '''''[[Naming_video_files\|Naming Conventions]]'''''.
	#Rename the extension to '''''.disc'''''		#Rename the extension to '''''.disc'''''
	#Place the file in the Source as you would any other ~~movie~~ in your Source.		#Place the file in the Source as you would any other video file in your Source.


	*Example 1- ~~Media Stub~~ file in a movie folder ~~with~~ local ~~artwork, actors, Extras, NFO File, theme etc~~.		*Example 1- Movie stub file in a movie folder using local information.
	*Example 2- ~~Media Stub~~ file without local information and ready for scraping.		*Example 2- Movie stub file in a movie folder without local information and ready for scraping.
			*Example 3- Episode stub files for in a season folder using local information.
			*Example 4- Episode stub files without local information and ready for scraping.

			'''Note:''' TV Shows do not use a stub file as it is not a playable media. Only episodes use stub files.


	<gallery mode="packed" heights="500px">		<gallery mode="packed" heights="500px">
Line 77:		Line 82:

	{{top}}		{{top}}
	{{updated\|20}}		{{updated\|21}}

	[[Category:Karellen]]		[[Category:Karellen]]
	[[Category:Video library]]		[[Category:Video library]]

Karellen at 02:29, 11 June 2023

2023-06-11T02:29:32Z

← Older revision		Revision as of 02:29, 11 June 2023
Line 7:		Line 7:
	* If you have a collection of DVD's and Bluray disks but do not want to rip them to a hard drive, then a Media Stub File allows you to add the collection of disks to the {{kodi}} Video Library.		* If you have a collection of DVD's and Bluray disks but do not want to rip them to a hard drive, then a Media Stub File allows you to add the collection of disks to the {{kodi}} Video Library.
	* It is a simple text based file that is added to your Source in exactly the same way as any other Movie or TV Show, which is then scanned or scraped into the library.<section end="intro" />		* It is a simple text based file that is added to your Source in exactly the same way as any other Movie or TV Show, which is then scanned or scraped into the library.<section end="intro" />

			'''Note:''' v18 and earlier required an installed and working optical drive to use this feature. From v19 and later, this requirement has been removed. <ref>https://github.com/xbmc/xbmc/pull/17940</ref>


Line 64:		Line 66:
	This modification requires inserting the following code into the '''''[[Advancedsettings.xml]]''''' file.		This modification requires inserting the following code into the '''''[[Advancedsettings.xml]]''''' file.
	{{#lst:Advancedsettings.xml\|discstubextensions}}		{{#lst:Advancedsettings.xml\|discstubextensions}}



			= References =
			<references />

Karellen: Updated for v20

2023-01-29T09:07:54Z

Updated for v20

← Older revision		Revision as of 09:07, 29 January 2023
Line 70:		Line 70:

	{{top}}		{{top}}
	{{updated\|19}}		{{updated\|20}}

	[[Category:Karellen]]		[[Category:Karellen]]
	[[Category:Video library]]		[[Category:Video library]]

LGoosens: Structured markup + changed wording for clarity

2022-12-14T20:10:59Z

Structured markup + changed wording for clarity

← Older revision		Revision as of 20:10, 14 December 2022
Line 4:		Line 4:

	= Introduction =		= Introduction =
	<section begin="intro" />If you have a collection of DVD's and Bluray disks but do not want to rip them to a hard drive, then a Media Stub File allows you to add the collection of disks to the {{kodi}} Video Library. It is a simple text based file that is added to your Source in exactly the same way as any other Movie or TV Show, which is then scanned or scraped into the library.<section end="intro" />		<section begin="intro" />
			* If you have a collection of DVD's and Bluray disks but do not want to rip them to a hard drive, then a Media Stub File allows you to add the collection of disks to the {{kodi}} Video Library.
			* It is a simple text based file that is added to your Source in exactly the same way as any other Movie or TV Show, which is then scanned or scraped into the library.<section end="intro" />


Line 29:		Line 31:
	#Select Play		#Select Play
	#A box will display requesting you to insert the disk (as shown in the below image)		#A box will display requesting you to insert the disk (as shown in the below image)
	#Once the disk is inserted, ~~the '''Play''' button will become active.~~		#Once the disk is inserted, press '''Play''' to commence playback.
	~~#Press~~ '''Play''' to commence playback.


Line 41:		Line 42:
	The basic Stub File will display the default message '''Please insert the following disc: <movie name>'''		The basic Stub File will display the default message '''Please insert the following disc: <movie name>'''

	It is possible to add messages to the pop up box as shown in the above image. The above image uses the following code placed inside the stub file. Longer messages will automatically scroll.		It is possible to add messages to the pop up box as shown in the above image. The above image uses the following code placed inside the stub file.

			{{note\|Longer messages will automatically scroll.}}

	<syntaxhighlight lang=xml enclose="div">		<syntaxhighlight lang=xml enclose="div">
Line 58:		Line 61:


	= ~~Modifying~~ Extensions =		= Adding/Removing File Extensions =
	This modification requires inserting the following code into the '''''[[Advancedsettings.xml]]''''' file.		This modification requires inserting the following code into the '''''[[Advancedsettings.xml]]''''' file.
	{{#lst:Advancedsettings.xml\|discstubextensions}}		{{#lst:Advancedsettings.xml\|discstubextensions}}

Karellen: Updated for v19

2021-06-25T20:26:34Z

Updated for v19

← Older revision		Revision as of 20:26, 25 June 2021
Line 67:		Line 67:

	{{top}}		{{top}}
			{{updated\|19}}

	~~{{updated\|18}}~~
	~~[[Category:FAQ]]~~
	~~[[Category:Index]]~~
	~~[[Category:How-to]]~~
	~~[[Category:Guides]]~~
	~~[[Category:Manual]]~~
	[[Category:Karellen]]		[[Category:Karellen]]
	[[Category:Video library]]		[[Category:Video library]]
	~~[[Category:General topics]]~~
	~~[[Category:First time user]]~~
	~~[[Category:Quick Start Guide]]~~

Karellen: Page Overhaul

2018-07-14T02:02:49Z

Page Overhaul

← Older revision	Revision as of 02:02, 14 July 2018
Line 1:	Line 1:
		{{Mininav\|[[Video library]]\|[[Video management\|Management]] }}



		= Introduction =
		<section begin="intro" />If you have a collection of DVD's and Bluray disks but do not want to rip them to a hard drive, then a Media Stub File allows you to add the collection of disks to the {{kodi}} Video Library. It is a simple text based file that is added to your Source in exactly the same way as any other Movie or TV Show, which is then scanned or scraped into the library.<section end="intro" />



		= Creating =
		The Media Stub File is a simple text file with the extension '''''.disc''''' instead of .txt extension. Once the file is saved correctly, {{kodi}} will see this file as an unplayable media file.

		#Create a blank text file and rename the filename in accordance with proper Movie and TV Show '''''[[Naming_video_files\|Naming Conventions]]'''''.
		#Rename the extension to '''''.disc'''''
		#Place the file in the Source as you would any other movie in your Source.


		*Example 1- Media Stub file in a movie folder with local artwork, actors, Extras, NFO File, theme etc.
		*Example 2- Media Stub file without local information and ready for scraping.

		<gallery mode="packed" heights="500px">
		MediaStubs02.jpg
		</gallery>



		= Usage =
		Once the title is scanned into the library, it will be visible in the same way as any other title in the library. To view the title for playback...
		#Select Play
		#A box will display requesting you to insert the disk (as shown in the below image)
		#Once the disk is inserted, the '''Play''' button will become active.
		#Press '''Play''' to commence playback.


		<gallery mode="packed-overlay" heights="283px">
		MediaStubs01.jpg\|Messages will differ based upon the contents of the Stub File
		</gallery>


		== Messages ==
		The basic Stub File will display the default message '''Please insert the following disc: <movie name>'''

		It is possible to add messages to the pop up box as shown in the above image. The above image uses the following code placed inside the stub file. Longer messages will automatically scroll.

		<syntaxhighlight lang=xml enclose="div">
		<discstub>
		<title>Rogue Assassin aka WAR</title>
		<message>Released as Rogue Assassin in Australia, but as WAR globally
		Bluray located in Storage 3, Drawer 2
		Add what you like to the message.</message>
		</discstub>
		</syntaxhighlight>

		*The ''<discstub></discstub>'' tag is required if using either of the next two tags
		*The ''<title></title>'' tag is optional and can be used to display an alternate name
		*The ''<message></message>'' tag is optional. Use only one set of <message> tags as multiples are ignored.



		= Modifying Extensions =
		This modification requires inserting the following code into the '''''[[Advancedsettings.xml]]''''' file.
		{{#lst:Advancedsettings.xml\|discstubextensions}}





		{{top}}

		{{updated\|18}}
		[[Category:FAQ]]
		[[Category:Index]]
		[[Category:How-to]]
		[[Category:Guides]]
		[[Category:Manual]]
		[[Category:Karellen]]
		[[Category:Video library]]
		[[Category:General topics]]
		[[Category:First time user]]
		[[Category:Quick Start Guide]]

Karellen: Page cleared for overhaul

2018-07-14T02:00:41Z

Page cleared for overhaul

← Older revision		Revision as of 02:00, 14 July 2018
Line 1:		Line 1:
	~~{{Mininav\|[[Video library]]\|[[Video management\|Management]] }}~~
	<section begin="intro" />As of v11 (Eden), Kodi has support for offline media stub files. These are files that represent a media outside of the digital infrastructure (eg, DVD's, Bluray, UHD Bluray, etc) and allow Kodi's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback. They will look like any other entry in the library, but a notice box will pop requesting insertion of the disk. Messages can be displayed in the notice box, such as "DVD on second shelf in cellar".<section end="intro" />



	~~== Creating stubs ==~~
	The intended way for this to work is '''e.g.''' Two DVD's you want to add to your Kodi library, Finding Nemo, and Bug's Life. You would create two empty text files where ever you store the rest of your digital media files called:
	* Finding Nemo (2003).disc
	* Bug's Life (1998).disc



	~~== Messages ==~~
	~~{{note\|Due to a bug in v12 to v14, stubs won't display their custom message if {{kodi}} does not detect an optical drive connected to your HTPC.}}~~

	When you try to play a media stub file, Kodi will present a dialog box with the static message, "Please insert the following disc:", on the first line and the item's library title on the second line. An Eject/Load button is available to open the optical drive tray or, for a slot-loading drive, eject any currently inserted media. When a disc is inserted in the drive, the Play button is enabled and selecting it will begin playback of the disc.

	You can also replace the title and/or add a custom message to be displayed when attempting to play a media stub file. This is accomplished by adding the following to the blank text file that is used for the stub:

	~~<syntaxhighlight lang="xml" enclose="div">~~
	~~<discstub>~~
	~~<title>Alternative Title</title>~~
	~~<message>Message to be displayed</message>~~
	~~</discstub>~~
	~~</syntaxhighlight>~~

	This message will be displayed on the third line of the dialog box. You may use this message to provide additional information, such as the disc number/side to be inserted or, if you use a special numbering scheme for organizing your DVD/Bluray collection, the location number of the expected disc.



	~~== Media flags ==~~
	You can optionally add media source flags to the filename before ".stub", if the skin you are using supports them. This can be used to indicate the type of media ('''DVD''', '''BLURAY''', '''VHS''', etc) that the movie resides on, which will be labeled within the {{kodi}} interface.

	~~{{#lst:Add-on:Confluence\|flags}}~~

	For more info on this, see [[Media flags#Media source\|Media flags/Media source]]. In cooperation with Confluence Skin's (and possibly others) feature to search for words like DVD, Bluray, and HDDVD in the file name it is possible to create a disc stub file that will show correct media flags in the skin.

	~~For example, if you have Finding Nemo on DVD, you could create an empty file called:~~

	~~<code>Finding Nemo (2003).dvd.disc</code>~~

	~~and add it to your library. In the library this file will show up with the DVD media flag in the Confluence Skin and when selected you will be prompted to insert the Finding Nemo DVD.~~



	~~== Modifying the file extension used for stubs ==~~
	By default these files have a .disc extension. You can modify the file extensions that are recognized as media stub files via the<code>''' <discstubextensions>'''</code> tag in [[Advancedsettings.xml#.3Cdiscstubextensions.3E\|advancedsettings.xml]].


	~~{{Helix updated}}~~

	~~[[Category:Manual]]~~
	~~[[Category:Video library]]~~

Karellen: Adjust intro

2018-01-14T03:37:05Z

Adjust intro

← Older revision		Revision as of 03:37, 14 January 2018
Line 1:		Line 1:
	{{Mininav\|[[Video library]]\|[[Video management\|Management]] }}		{{Mininav\|[[Video library]]\|[[Video management\|Management]] }}
	<section begin="intro" />As of v11 (Eden), Kodi has support for offline media stub files. These are files that represent a media outside of the ~~online~~ digital infrastructure and allow Kodi's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback.<section end="intro" />		<section begin="intro" />As of v11 (Eden), Kodi has support for offline media stub files. These are files that represent a media outside of the digital infrastructure (eg, DVD's, Bluray, UHD Bluray, etc) and allow Kodi's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback. They will look like any other entry in the library, but a notice box will pop requesting insertion of the disk. Messages can be displayed in the notice box, such as "DVD on second shelf in cellar".<section end="intro" />



	== Creating stubs ==		== Creating stubs ==
Line 6:		Line 8:
	* Finding Nemo (2003).disc		* Finding Nemo (2003).disc
	* Bug's Life (1998).disc		* Bug's Life (1998).disc



	== Messages ==		== Messages ==
Line 22:		Line 26:

	This message will be displayed on the third line of the dialog box. You may use this message to provide additional information, such as the disc number/side to be inserted or, if you use a special numbering scheme for organizing your DVD/Bluray collection, the location number of the expected disc.		This message will be displayed on the third line of the dialog box. You may use this message to provide additional information, such as the disc number/side to be inserted or, if you use a special numbering scheme for organizing your DVD/Bluray collection, the location number of the expected disc.



	== Media flags ==		== Media flags ==
Line 35:		Line 41:

	and add it to your library. In the library this file will show up with the DVD media flag in the Confluence Skin and when selected you will be prompted to insert the Finding Nemo DVD.		and add it to your library. In the library this file will show up with the DVD media flag in the Confluence Skin and when selected you will be prompted to insert the Finding Nemo DVD.



	== Modifying the file extension used for stubs ==		== Modifying the file extension used for stubs ==

Ned Scott at 23:26, 5 May 2015

2015-05-05T23:26:04Z

← Older revision		Revision as of 23:26, 5 May 2015
Line 1:		Line 1:
	{{Mininav\|[[Video library]]\|[[Video management\|Management]] }}		{{Mininav\|[[Video library]]\|[[Video management\|Management]] }}
	<section begin="intro" />As of v11 (Eden), Kodi has support for offline media stub files. These are files that represent a media outside of the online digital infrastructure and allow ~~XBMC~~'s library to catalogue your "offline" media collection, as well as ask for the media when selected for playback.<section end="intro" />		<section begin="intro" />As of v11 (Eden), Kodi has support for offline media stub files. These are files that represent a media outside of the online digital infrastructure and allow Kodi's library to catalogue your "offline" media collection, as well as ask for the media when selected for playback.<section end="intro" />

	== Creating stubs ==		== Creating stubs ==
Line 39:		Line 39:
	By default these files have a .disc extension. You can modify the file extensions that are recognized as media stub files via the<code>''' <discstubextensions>'''</code> tag in [[Advancedsettings.xml#.3Cdiscstubextensions.3E\|advancedsettings.xml]].		By default these files have a .disc extension. You can modify the file extensions that are recognized as media stub files via the<code>''' <discstubextensions>'''</code> tag in [[Advancedsettings.xml#.3Cdiscstubextensions.3E\|advancedsettings.xml]].

	~~== Notes ==~~
	~~For more technical information on this new feature see [http://trac.xbmc.org/ticket/10384 here], [https://github.com/xbmc/xbmc/pull/76 here], and [https://github.com/xbmc/xbmc/pull/89 here].~~

	{{~~Gotham~~ updated}}		{{Helix updated}}

	[[Category:Manual]]		[[Category:Manual]]
	[[Category:Video library]]		[[Category:Video library]]