Skip to content

Settings

primaeval edited this page Jul 20, 2017 · 15 revisions

Settings.xml

I'll try to add a bit more info about the settings here. The code in brackets is either the internal setting name or the action that is performed.

Help

Command Keys [RunScript($CWD/help.py,commands)]

Pop up the file commands.txt that shows the default keyboard button shortcuts.

You can get a good overview of the features of TVGF here.

AutoPlayWith [RunScript($CWD/help.py,autoplaywith)]

A Readme file with help on setting up External Players or launching Python Scripts in response to an AutoPlayWith timer.

Enable help/question mark for invisible buttons [help.invisiblebuttons]

Currently only working in the White Snow addon. It shows an overlay of the invisible buttons in the epg and osd for navigation.

Source

This is the most important page in the Settings.

XMLTV Source [xmltv.type]

XMLTV file source. File is for local content on your device or home network. Url is an internet server.

XMLTV File [xmltv.file]

XMLTV file location.

XMLTV Url [xmltv.url]

XMLTV file url.

Look for .gz Files (Urls only) [gz]

Save yourself a ton of time and bandwidth. This will look for the compressed xmltv file in the same location with a .gz suffix. If your server does automatic compression you probably can turn this off.

md5 Check (Urls only) [md5]

Another great time and bandwidth saver. If you have control of your xmltv server make an .md5 file of the source xmltv file on every update. The new xmltv file will only be downloaded when it changes.

Reset on Start [xmltv.refresh]

Turn this off after one restart or your channel mappings will keep getting reset!

This will clean out most of the xmltv related tables in the source.db internal file on the next start. It is useful when you change xmltv files and have some left-over channels with no program data. There are more reset functions in the Reset Database tab. If you really get stuck delete everything manually in the addon_data\script.tvguide.fullscreen folder.

File Download Interval [xmltv.interval]

How often the guide will try to download a new xmltv file on start. "Every start" can be useful for trouble shooting. Turn it on once to force an xmltv reload. The preferred and least intrusive way to update the xmltv data is in "Startup \ Background Update Service".

Treat 4 Digit Program Date as Movie [xmltv.date]

The only way to identify some Movies is if they have a 4 digit year in the date field. Use this if that is how your xmltv data is formatted. Others have the year in the title eg "Star Wars (1977)".

Optional

More server data but optional.

Authentication [authentication]

Try to use the user and password below to grab the xmltv file and other ini files in this page.

User [user]

User name for authentication.

Password [password]

Password for authentication.

Import addons.ini will overwrite added addon folders! [``]

If you set up all your channel to stream mappings on one device and want to sync the rest of your devices with that device this could be useful.

Import addons.ini [addons.ini.enabled]

addons.ini is the main magic file that let's you map an xmltv channel to an addon stream. This setting will import addons.ini from an external location. You can merge it or let it overwrite your local addons.ini file.

addons.ini Source [addons.ini.type]

addons.ini source location: local or internet server.

addons.ini File [addons.ini.file]

addons.ini local file location. On your device or local network.

addons.ini Url [addons.ini.url]

addons.ini server url.

Overwrite or Merge Local addons.ini [addons.ini.overwrite]

Overwrite your addons.ini file or just merge the new file from the server.

Enable addons.ini m3u Playlist Subscriptions [addons.ini.subscriptions]

This will let you add several m3u playlists to the addons.ini file.

Manage addons.ini m3u Playlist Subscriptions [RunScript($CWD/subscriptions.py)]

Add and remove m3u playlists from the subscription list.

Refresh may take some time! [``]

Refresh Addon Folders [RunScript($CWD/ReloadAddonFolders.py)]

Force refreshing all the Folders that you have added to addons.ini in "TVGF \ Menu \ Stream Setup \ Browse \ \ \ Add Folder"

Categories can be created via context menu [``]

Categories in this section are Channel Categories that can filter your channels by a user defined category. eg Sports or Kids.

Import categories.ini [categories.ini.enabled]

Load Channel Categories from an external file.

categories.ini Source [categories.ini.type]

categories.ini source type: local network or internet.

categories.ini File [categories.ini.file]

Local device or network categories.ini file.

categories.ini Url [categories.ini.url]

Internet url for categories.ini file.

Remember Last Category [categories.remember]

Restart TVGF with the last Channel Category still selected.

Channel Mappings [``]

Channel Mappings map the xmltv channel name to an addon stream or url. You can force the mappings in this section.

Import mapping.ini [mapping.ini.enabled]

Import a channel to stream mapping.ini file on start.

mapping.ini Source [mapping.ini.type]

mappings.ini local or internet location.

mapping.ini File [mapping.ini.file]

mappings.ini local network file.

mapping.ini Url [mapping.ini.url]

mappings.ini internet url.

Import m3u [mapping.m3u.enabled]

Use an .m3u file for the channel mapping file mapping.m3u

m3u Source [mapping.m3u.type]

Internet or local network mapping.m3u location.

m3u File [mapping.m3u.file]

Local network mapping.m3u file location.

m3u Url [mapping.m3u.url]

Internet mapping.m3u url.

Logos

If you are lucky your xmltv file will contain urls for channel logos. If not you will have to make or find a folder with logos that correspond to the channel names in the xmltv file.

[``]

Enable Channel Logos [logos.enabled]

Show the channel logos if they can be found. If not just show a text string with the channel name in the main epg.

External Logo Source [logos.source]

Use a local network or internet path for the logo folder.

Logos Folder [logos.folder]

Local logo folder.

Logos Url [logos.url]

Internet logo folder url.

Keep Last Channel Logo Mapping [logos.keep]

If you have used the "TVGF \ Channels \ Logo" functions to map up logos to channel names turn this on to prevent losing the customization on the next xmltv update.

[``]

Use xmltv Logos [xmltv.logos]

Use the channel logos from the xmltv file if they exist.

Use Addon Folder Logos [addon.logos]

Use logos from addons streams if they exist.

[``]

Use TheLogoDB.com Logos [thelogodb]

Look up channel logos from the TheLogoDB.com always, if missing or never. Channel name matching is hit and miss.

Delete TheLogoDB.com Cache [RunScript($CWD/ResetDatabase.py, 4)]

Delete TheLogoDB.com logo cache in "userdata\addon_data\script.tvguide.fullscreen\logos".

[``]

Crop and Resize Logo Folder [RunScript($CWD/ResizeLogos.py)]

Crop and Resize the logos in the logo folder to fit the current epg channels per page size. This works fine in Jarvis but was having some problems resizing images with the PIL python library in Krypton. If the logos don't resize properly use Jarvis.

Playback

Use highest bandwidth stream from m3u url (Krypton+ fix) [m3u.read]

The code to play HLS streams in Krypton was taken out for some annoying reason. That is why I still use Jarvis for channel surfing. HLS streams can take 10 seconds to start in Krypton whereas they start instantly in Jarvis. This setting may speed up pure HLS urls to only a couple of seconds. See this thread for more info https://trac.kodi.tv/ticket/17422

[``]

Catchup Addon (plugin.video.?) [catchup.text]

Addon to use for catchup handling. It needs to be a derivative of Meta4Kodi for the url to work such as metalliq. If you have set the players correctly you should be able to play any tv show episode or movie in an addon that can find the program based on its title, year, season and episode number.

This is one of three methods to launch a catchup service. The others are iSearch for Super Favourites type searches and Catchup Addon in Lab1 which can use freeform urls.

Show Catchup Channel [catchup.channel]

This is an experimental feature that doesn't work too well due to limitations in the receiving addons. If you have "catchup" as the url for a channel stream this will play the channel via Meta4Kodi or derivative from the start of the current program. A pseudo channel called Meta should appear as channel 1 in the epg.

The logic is not strong enough to deal with gaps between programs due to adverts or taking too long to automatically find a program and play it via Meta.

Channel Shortcuts (xmltv Ids must be Numeric) [``]

Use a numeric code to go straight to a channel. In the Default skin the channel number is shown in the top left as you type it.

Channel Shortcut Type [channel.shortcut]

The channel number can be the index of the channel in the xmltv file found in "TVGF \ Menu \ Channels" or use the channel id in the xmltv file. If you want to match a set-top boxes numbering scheme use xmltv id. You'll have to edit the Webgrab config file to set the xmltv id properly.

Start When Any Number Key Pressed (or map Shift Key to start) [channel.shortcut.direct]

If you want the number keys to go directly to the channel use this. Normally the number keys are used for channel listings, program searches and timer lists.

If you turn this off you can map up a key to "Shift" to start the numeric input process.

Auto-Play Channel On Numeric Input [channel.shortcut.behaviour]

Choose whether to scroll to the selected channel or play it.

Channel Shortcut Digits [channel.index.digits]

Fixed number of digits to look for before playing the channel.

Shortcut Editor (run the guide once to create the file) [RunScript($CWD/ShortcutEditor.py)]

If you don't generate your own xmltv file you can use this to set the numeric xmltv ids. The file ends up in "userdata\addon_data\script.tvguide.fullscreen\channel_id_shortcut.ini"

[``]

Always Open Menu on Play (Good for Touch Devices) [play.menu]

If you have a dearth of buttons on your remote or a touch device this is a good option to choose to get to the Menu.

[``]

Always Choose Channel if Alternative Streams Exist [play.alt.choose]

I think this option will pop up the Choose Stream dialog if you press enter on an already playing channel. (CHECK)

Try Other Alternative Streams if Play Fails [play.alt.continue]

Try to play the Alternative Streams if the first one fails after a timeout.

Use Alternative Streams as a Fallback Only [play.alt.fallback]

If you have a Primary and Alterative Streams set for a channel you usually get a dialog to choose which one to play. This will just play the Primary but try the Alternative Streams if it fails to play.

[``]

Disabling the OSD menu may fix video stuttering [``]

Also try turning off Surface Codec in "Kodi \ System \ Player \ Videos \ Processing".

Enable OSD menu [enable.osd]

If you turn this off the streams will play with the normal Kodi video osd menus with Play controls and all the other Video and Audio menus. If you use the TVGF Osd you can get to the Kodi Osd with the Fullscreen button which is TAB on desktop devices.

Use alternative streaming method (required for some addons). [alternative.playback]

This will try to play streams using xbmc.executebuiltin('XBMC.RunPlugin(%s)' % url). Some addons need this method. You can also set individual addon Folders or Urls to use this method in "TVGF \ Browse \\ Add Folder"

Playback OSD and Timeout are Cumulative [``]

Timeouts for the "Try Other Alternative Streams if Play Fails" options above.

Playback OSD (seconds) [playback.osd.timeout]

How long to always show the OSD after you start playing a channel.

Playback Timeout (seconds) [playback.timeout]

How long to give an addon to play a channel before going on to the next one or giving up.

[``]

Stop Playing on Exit [stop.on.exit]

Keep playing a stream when you exit out TVGF. Good if you want to look for something else to watch while the current channel keeps playing.

Start Playback in Background/Window [play.minimized]

Usually playback will start in a Fullscreen window with Osd. Use this for testing channels by having them start in the epg window, either in the background or the small PIP window.

Exit from EPG on Back Button [exit.on.back]

When a channel is playing the Back button will flip between the epg and the fullscreen osd video. Use this for Back to exit TVGF from the epg when playing a channel.

Appearance

Skin Type [skin.source]

Skin [skin]

Skin Folder (above resources/skins) [skin.folder]

User Skin Name [skin.user]

Small EPG Video Preview Window [epg.video.pip]

[``]

Scale Program Image [program.image.scale]

[``]

List View for Choose Stream [stream.addon.list]

[``]

Up to Categories Bar [up.cat.mode]

Show Action Bar [action.bar]

Down to Action Bar [down.action]

Reset Action Bar [RunScript($CWD/actions.py)]

[``]

Program Search in Synopsis/Title [program.search.plot]

Listings Views [``]

Listing View Future Days [listing.days]

Listing View Previous Hours [listing.hours]

Sort Listings Views by Time [listing.sort.time]

[``]

Show Up Next [enable.nextup]

- Time before end in seconds to show [nextup.time]

- Set display time [enable.nextup.showTime]

- Time in seconds to show [nextup.showTime]

[``]

iSearch or MySearch [search.type]

Favourite Favourites [favourites]

[``]

Show Long Date in EPG [date.long]

Show Touch Control Buttons [mouse.controls]

Show Channel Logo in EPG above Program Image [channel.logo]

Show Addon Logo in EPG above Program Image [addon.logo]

[``]

Channels per Page [channels.per.page]

[``]

Sort Order for Channels in Categories [channel.filter.sort]

[``]

Channel Matching [addon.match]

[``]

No Programs Message [no.programs.message]

[``]

Show Addon in Context Menu [menu.addon]

Epg Program Title Box Spacing [epg.box.spacing]

[``]

Last Channel Popup in OSD or ContextMenu [last.channel.popup]

[``]

RedrawEPG closing windows in VideoMode [redraw.epg]

[``]

Show dummy channels on final page [dummy.channels]

Background

Enable Background Program Image [program.background.enabled]

Background Image Source [program.background.image.source]

Background Image File [program.background.image]

Background Image Url [program.background.image.url]

Pick Image [RunScript($CWD/PickImage.py,remote,program.background.image.url)]

Background EPG Colour [program.background.color]

Flat Background Image [program.background.flat]

Background Image Texture [program.background.texture.url]

Pick Texture [RunScript($CWD/PickImage.py,both,program.background.texture.url)]

EPG Timebar Colour [timebar.color]

EPG Text Colour [epg.nofocus.color]

EPG Text Colour Highlight [epg.focus.color]

Categories Background Colour [categories.background.color]

30114

30900 [autostart]

[``]

30400 [background.service]

Update on Login [background.startup]

Service Schedule Type [service.type]

30401 [service.interval]

Service Time [service.time]

Update Addon Folders Too [service.addon.folders]

Notify when Finished [background.notify]

Update Notification Progress [update.progress]

Program Scheduler

Reminders (5 Minutes Before) [``]

Reminders [notifications.enabled]

Clear Reminders... [RunScript($CWD/notification.py)]

Autoplay: OSD will not be available [``]

Autoplays [autoplays.enabled]

Stop After Play [autoplays.stop]

Minutes before [autoplays.before]

Minutes after [autoplays.after]

Clear Autoplays... [RunScript($CWD/autoplay.py)]

AutoPlayWith (External Player) [``]

AutoPlayWiths [autoplaywiths.enabled]

PlayerCoreFactory.xml Player [autoplaywiths.player]

Stop After Play [autoplaywiths.stop]

ffmpeg Program [autoplaywiths.ffmpeg]

ffmpeg Output Folder [autoplaywiths.folder]

Minutes before [autoplaywiths.before]

Minutes after [autoplaywiths.after]

Clear Autoplaywiths... [RunScript($CWD/autoplaywith.py)]

30140

30137 [``]

30138 [``]

Reset EPG Data [RunScript($CWD/ResetDatabase.py, 1)]

Reset Everything [RunScript($CWD/ResetDatabase.py, 2)]

VPN

VPN Manager Connection Switching [``]

Install VPN Manager to switch VPN with channels [``]

VPN switching can delay changing channels [``]

Use VPN Mgr filtering for channel add-ons [vpnmgr.connect]

Always revert to previous VPN state [vpnmgr.default]

Lab1

Custom Category Order (use | to seperate) [cat.order]

Find Program Images from OMDb/TVDb/IMDb [find.program.images]

OMDb Image and Plot Search [omdb]

TVDb/IMDb Image Search [tvdb.imdb]

TVDb Matching [tvdb.match]

IMDb Matching [imdb.match]

Use Better Resolution IMDb Image (takes longer) [imdb.big]

Clear OMDb/TVDb/IMDb Image Match Cache [RunScript($CWD/ResetDatabase.py, 3)]

[``]

Use Program Image from Source [program.image]

[``]

Fall back to Channel Logo for Program Image [program.channel.logo]

[``]

Append (Folder) to Name on Add Folder [append.folder]

EPG Font [epg.font]

[``]

Action Editor [RunScript($CWD/ActionEditor.py)]

Custom Command for MINE [mine1]

Format: %Y year %m month %d day %H hour %M minute %D duration(minutes) [``]

%I channel id %T program title %S season %E episode [``]

Mangage Catchup Urls [RunScript($CWD/catchup.py)]

Ask to Catchup [catchup.dialog]

Lab2

Experimental Alternative Data Sources [``]

(OK this dialog and return after changing source) [``]

Data Source [source.source]

Sports Fixtures [``]

Include Sports Fixtures in xmltv Source [fixtures]

Sports Fixtures Country Code [fixtures.country]

Sports Fixtures Time Zone [fixtures.timezone]

tvguide.co.uk [``]

tvguide.co.uk Days [tvguide.co.uk.days]

tvguide.co.uk Provider [tvguide.co.uk.systemid]

tvguide.co.uk email (overrides Provider) [tvguide.co.uk.email]

yo.tv [``]

yo.tv Countries (OK Dialog After Selecting yo.tv Source) [RunScript($CWD/yo.py, 1)]

yo.tv Providers (OK Dialog After Selecting Countries) [RunScript($CWD/yo.py, 2)]

SchedulesDirect [``]

SD-Username [sd.username]

SD-Password [sd.password]

SD-Changed [sd.changed]

Change SchedulesDirect-Login [RunScript($CWD/editor.py, 1)]

Add lineup [RunScript($CWD/editor.py, 2)]

Edit channels [RunScript($CWD/editor.py, 3)]

Delete lineup [RunScript($CWD/editor.py, 4)]

Days of guide data to load [sd.range]

30128 [sd.interval]

Lab3

Secondary XMLTV File [``]

XMLTV Secondary Source [xmltv2.enabled]

XMLTV Secondary Source Type [xmltv2.type]

XMLTV Secondary File [xmltv2.file]

XMLTV Secondary Url [xmltv2.url]

Backup

Clear Channel Mappings [RunScript($CWD/backup.py,5)]

Export Channel Mappings [RunScript($CWD/backup.py,1)]

Import Channel Mappings [RunScript($CWD/backup.py,2)]

[``]

Clear Alternative Channel Mappings [RunScript($CWD/backup.py,6)]

Export Alternative Channel Mappings [RunScript($CWD/backup.py,3)]

Import Alternative Channel Mappings [RunScript($CWD/backup.py,4)]

[``]

Download All Addon Folder Logos [RunScript($CWD/logos.py)]

Download All Channel Logos [RunScript($CWD/channel_logos.py)]

Clone this wiki locally