Wiki - Mariusz89B/script.mtvguide GitHub Wiki

Information about all settings in m-TVGuide. The code in brackets is either the internal setting name or the action that is performed. The instruction inside parentheses explain the preformed action of the setting.

Getting started

Configuration tutorial [tutorial]

(Enabled, Disabled)

Enabling this setting will activate a tutorial at startup that will simplify the setup process.

Help [help]

Frequently asked questions and help section.

Readme [readme]

Information about all add-on settings.

Credits [credits]

Disclaimer and regulations statements.

TV services

TV service provider [tvservice_enabled]

(Enabled, Disabled)

Television provider service capable of playing video content.

Playlists M3U

Playlist M3U [playlist_enabled]

(Enabled, Disabled)

M3U resource capable of playing video content.

Playback settings

Display name [playlist_display_name]

Enter a display name for M3U resource.

Cache playlist to local drive [playlist_refr]

(Enabled, Disabled)

Cache playlist to local drive for faster loading time.

Playlist cache update (days) [playlist_refr_days]

Adjust interval time for playlist cache update.

Source [playlist_source]

Select where to find the M3U resource. The options are: [File path] - A path to an M3U file whether it be on the device or the local network, [Url path] - A URL specifying the location of the M3U file.

Url [playlist_url]

If location is [Url path] this setting must contain a valid URL for the add-on to function.

File [playlist_file]

If location is [File path] this setting must contain a valid path for the add-on to function.

Replace country code [pattern]

Select to replace country code pattern to match M3U playlist channels with EPG channel id or display-names.

Append fixed country code [append_country_code]

Append a country code for all channels, this will add a fixed string to the end of the channel name.

Add User-Agent [user_agent]

Add a User-Agent request header to change the default network peer identifier to eg. redirect a stream.

https://en.m.wikipedia.org/wiki/User_agent

Stop playback while switching stream [playlist_stop_when_starting]

(Enabled, Disabled)

Stop playback while switching stream.

Prefer HD stream [playlist_high_prio_hd]

(Enabled, Disabled)

Prefer the highest playback quality.

Priority [playlist_priority]

Select priority of playback service with 0 being the lowest and 11 the highest (0-11).

EPG

Source [source]

(Url, File)

Select where to find the XMLTV resource. The options are: [File path] - A path to an XMLTV file whether it be on the device or the local network, [Url path] - A URL specifying the location of the XMLTV file.

Select EPG[countryChannels]

(Select)

Provide XMLTV EPG [File path] or [Url path] and select a region. If selected region a basemap will be loaded with regex mapping for the predefined group, and a fixed category will be shown in EPG. Else predefined group categories are disabled and all channels will be loaded.

Program guide settings

Automatically assign streams [AutoUpdateCid]

(Enabled, Disabled)

Add actual streams automatically to each program.

Show only programs with streams assigned [OnlyChannelsWithStream]

(Enabled, Disabled)

Show only assigned streams in the EPG list.

Auto detect EPG change [UpdateEPGOnModifiedDate]

(Enabled, Disabled)

If there are any changes to EPG on the server it will automatically be loaded into the add-on, else EPG will be renewed when generated days have been terminated.

EPG update interval [epg_interval]

How often the add-on will try to update the XMLTV EPG file.

EPG list sorting [channel_filter_sort]

Set order for channel sorting. The options are: [Default] - Sort channel list by the order in XMLTV file, [Sort list alphabetically] - Sort channel list from A-Z, [Sort group by category] - Sort channel list in favorite groups by the order in categories.ini file.

Enable detection of alternative channel names [epg_display_name]

(Enabled, Disabled)

If enabled channels from basemap are matched with both 'channel id' and 'display name' tag in EPG, as default only 'channel id' tag is used. Needs reloading of EPG to add 'display names' to database, might vastly increase startup loading time.

Enable only channels in pre-defined groups [show_group_channels]

(Enabled, Disabled)

If enabled only channels in pre-defined groups are displayed in the EPG list, might reduce loading time.

Enable tvg-id matching [tvg_id]

(Enabled, Disabled)

Add-on matches tvg-id channel names.

Use fast EPG parser [useCustomParser]

(Enabled, Disabled)

More extended information is being ruled out for faster loading times.

Refresh EPG table periodically [refresh_streams]

(Enabled, Disabled)

Refresh the time table periodically with new streams.

Show channel logos [show_logo]

(Enabled, Disabled)

If enabled program logos will be displayed instead of channel names.

Show program thumbnail [show_program_logo]

(Enabled, Disabled)

If enabled it will display program thumbnails instead of add-on logo.

Search for channel logos in [xmltv_logo_folder]

Select a valid folder path with channel logos, if EPG logos are missing logos from the selected folder will be shown.

Logo filename must match the channel title and be formatted with low dash spaces and lowercase characters. Supported filetypes are .png only.

eg.

Channel name
TVP 1 PL

Logo filename
tvp_1_pl.png

File

XMLTV file [xmltv_file]

If location is [File Path] this setting should contain a valid path.

Url

Main [m-TVGuide]

If location is [Url Path] this setting should contain a valid URL.

Additional [m-TVGuide2]

If location is [Url Path] this setting should contain a valid URL.

Additional [m-TVGuide3]

If location is [Url Path] this setting should contain a valid URL.

Adult channels [showAdultChannels]

(Enabled, Disabled, password)

Show adult content.

Vod channels [showVodChannels]

(Enabled, Disabled)

Show video on demand content.

Timezone [time_zone]

Select timezone type. The options are: [Auto timezone] - Automatically adjusts timezone to value provided in EPG file, [Adjust local time] - Adjust parsed EPG date to local timezone, [Manually adjust timezone] - Manually set timezone value.

Definition of timezone settings

Settings

Enable add-on autostart [autostart_mtvguide]

(Enabled, Disabled)

If enabled add-on will automatically start when Kodi is loaded.

Enable background services [background_services]

(Enabled, Disabled)

If enabled add-on will continue to run play and record services upon exit.

Enable automatic channel playback [autostart_channel]

(Enabled, Disabled)

If enabled channel will automatically start playing on startup.

Automatic channel playback

Last seen channel [autostart_channel_last]

Start playing last seen channel.

By channel number [autostart_channel_number]

Start playing selected channel by number.

Adjust timebar [timebar_adjust]

(min)

Adjust timebar offset (minutes).

Show service notification [service_notifications_enabled]

(Enabled, Disabled)

Recieve important system notifications.

Show programme notification [program_notifications_enabled]

(Enabled, Disabled)

Recieve notifications regarding scheduled programs.

Sleep timer

Enable sleep timer [sleep__enabled]

(Enabled, Disabled) This setting makes add-on stop any playback if it exceeds a given playback time. If you have that awful habit of leaving the add-on playing live content after you fell asleep this might be for you. It gives extended control over the playback time.

Timeout value [sleep_timer]

(min)

Put add-on to sleep after selected time (minutes).

Timeout action [sleep__action]

(Stop playback, Exit Kodi, Hibernate, Shutdown)

Decide what action the add-on should preform when timeout is set.

Enable navigation panel for mouse or touch [touch_panel]

(Enabled, Disabled)

If enabled virtual buttons will be shown for mouse or touchpad support.

Remember list of favorites [categories_remember]

(Enabled, Disabled)

Remember the last used favorite list.

Set keys [RunScript($CWD/setkey.py)]

Set key shortcuts for different actions.

Enable channel order by number [channel_shortcut]

(Enabled, Disabled)

If enabled you will be able to select a channel by number and display digits in the EPG.

Play on select [channel_shortcut_behaviour]

(Don't play, Play)

Decide what action to take when entering a number in the EPG.

Exit [exit]

(Click twice to exit, Ask on exit)

Select exit type for the add-on.

Video

Max service startup time [max_connection_time]

(sec)

Selected maximum time to startup service before disconnecting (seconds).

Reconnect broken stream [reconnect_stream]

(Enabled, Disabled)

If enabled this setting will try to reconnect a broken stream.

Max numbers of reattempts [max_reconnect_attempts]

Select the number of tries to reconnect broken stream.

Reattempt delay [reconnect_delay]

(ms)

Waiting time for stream to reconnect if first stream is broken (milliseconds).

Max stream startup time [max_wait_for_playback]

(sec)

Maximum waiting time for stream to connect (seconds).

Stop playback using navi back button [navi_back_stop_play]

(Enabled, Disabled)

If enabled when a back button is pressed this will stop the playback and return to main screen, else it will work as a picture in picture function.

Fullscreen window size animation

Enable fullscreen window size animation [start_video_minimalized]

(Enabled, Disabled)

Toggles fullscreen playback for video content. May improve performance on low-end systems.

OSD

Enable OSD [info_osd]

(Enabled, Disabled)

If enabled this setting will display an on screen display when a playback is started.

OSD display time (sec) [osd_time]

(Enabled, Disabled)

Time how long the on screen display should be shown (seconds).

OSD buttons

OSD on select [VidOSD_on_select]

(Enabled, Disabled)

If enabled this setting will display a OSD when pressing select button, else a information dialog will show up.

Shows extra buttons on OSD [show_osd_buttons]

(Enabled, Disabled)

If enabled virtual buttons will be shown in the on screen display for easier navigation.

Navigating in OSD previous, next program [key_right_left_show_next]

(Enabled, Disabled)

Ability to navigate channels through out the on screen display.

Auto OSD

Display auto OSD on play [show_osd_on_play]

(Enabled, Disabled)

If enabled on screen display will be shown automatically when playback is started.

Auto OSD display time [osd_on_play_time]

(sec)

Time how long the automatic on screen display should be shown in seconds.

Show OSD on stream change [osd_on_stream_change]

(Enabled, Disabled)

If enabled the on screen display will be shown on stream change.

Show service name in OSD [show_service_name]

(Enabled, Disabled) If enabled a notification about the selected service provider will be displayed on playback startup.

Current time during playback

Display current time during playback [show_time]

(Enabled, Disabled)

Display current time during playback even while OSD is not focused.

Position [show_time_pos]

(Top left, Top right, Bottom left, Bottom right) Select position on screen where current time should be displayed.

Size [show_time_size]

Select size of displayed current time.

Database

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

Clears all program reminders.

Clear all planed recordings... [RunScript($CWD/cleardb.py, clearRecordings)]

Clears all program recordings.

Backup

Export setings [RunScript($CWD/settingsImportExport.py, Export)]

Export and create backup for add-on settings.

Import setings [RunScript($CWD/settingsImportExport.py, Import)]

Import backuped add-on settings.

System management

Increase database write performance [pragma_mode]

If enabled database Write-Ahead Logging (WAL) will be used to increase write performance. Be aware that it reduces the data consistency guarantees in case of hardware failure.

Reset custom streams [RunScript($CWD/cleardb.py, clearCustom)]

Delete all streams that have been manually assigned.

Reset database [RunScript($CWD/cleardb.py, clearAll)]

Resetting the database will cause losing all saved content such as channel order, custom channels and planned reminders or recordings. This option might be helpful in case of data have become corrupted.

Delete database file [RunScript($CWD/cleardb.py, deleteDbFile)]

Delete the database file incase you would like to create a new one, might be helpful in case of data have become corrupted.

Delete all settings [RunScript($CWD/cleardb.py, deleteAll)]

Permanently delete all add-on settings.

Recording

Install recording applications [download_record_app]

Install necessary applications in order to record playback and/or download catchup programmes.

Record destination [record_folder]

This setting should contain a valid path to your recordings location.

Use FFMPEG to record RTMP instead of RTMPDUMP [use_only_ffmpeg]

(Enabled, Disabled)

If enabled FFMPEG software will be used to record Real-Time Messaging Protocol, else RTMPDUMP will apply.

Import RTMPDUMP [rtmpdumpExe]

(Select)

This setting should contain a valid path to RTMPDUMP software.

Import FFMPEG [ffmpegExe]

(Select)

This setting should contain a valid path to FFMPEG software.

Stop player when recording is started [record_stop_playback]

(Enabled, Disabled)

If enabled playback will be stopped if a recording is started.

Maximum number of attempts to resume recording [max_reattempts]

Maximum number of attempts to resume recording.

Delete watched recordings [ask_to_delete_watched]

(Ask, Auto delete, Do nothing)

If enabled a dialog popup will be prompted asking to delete watched recordings.

Catchup

Enable Catchup [archive_support]

(Enabled, Disabled)

Should be enabled if there are channels supporting catchup in your M3U list.

Catchup type

Catchup type [archive_type]

(Default, Shift, Xtream Codes, Append, Disabled)

If enabled it is assumed that all channels support catchup using the selected mode if they do not have catchup tags. In this case the 'Query format string' and 'Catchup window' number of days will come from the add-on settings if needed. If this option is disabled then an M3U entry must have at least a 'catchup=' tag to enable catchup. The options for how to build the catch URL are: [Default] - Use catchup source as the full catchup URL, if there is no catchup source use Append mode; [Shift (SIPTV)] - Append the standard SIPTV catchup string to the channel URL; [Xtream codes] - Build an Xtream codes URL from the channel URL.; [Append] - Append the catchup source to the channel URL, if there is no catchup source using the 'Query format string'.

Catchup stream examples

Example stream and catchup URLs

If the M3U entry contains a 'catchup-source' tag, then 'default' type should be selected as the catchup will process using a standard format.

Default

stream: http://ch01.spr24.net/151/mpegts?token=my_token

catchup: http://ch01.spr24.net/151/timeshift_abs-{utc}.ts?token=my_token

stream: http://list.tv:8888/325/index.m3u8?token=secret

catchup: http://list.tv:8888/325/timeshift_rel-{offset:1}.m3u8?token=secret

stream: http://list.tv:8888/325/mono.m3u8?token=secret

catchup: http://list.tv:8888/325/mono-timeshift_rel-{offset:1}.m3u8?token=secret

Shift (SIPTV)

Same as append but will automatically try to find the correct string. Supports only utc time.

stream: http://list.tv:8888/325/mono.m3u8?token=secret

catchup: http://list.tv:8888/325/mono.m3u8?token=secret&utc={utc}&lutc={lutc}

stream: http://list.tv:8888/325/mono.m3u8?token=secret

catchup: http://list.tv:8888/325/mono.m3u8?token=secret?utc={utc}&lutc={lutc}

Xtream Codes

stream: http://list.tv:8080/[email protected]/my_password/1477

catchup: http://list.tv:8080/timeshift/[email protected]/my_password/{duration}/{Y}-{m}-{d}:{H}-{M}/1477.ts

stream: http://list.tv:8080/live/[email protected]/my_password/1477.m3u8

catchup: http://list.tv:8080/timeshift/[email protected]/my_password/{duration}/{Y}-{m}-{d}:{H}-{M}/1477.m3u8

Append

Appends catchup at end of stream string, duration is set automatically by the add-on.

stream: http://list.tv:8888/325/mono.m3u8?token=secret

catchup: http://list.tv:8888/325/mono.m3u8?token=secret&utc={utc}&lutc={lutc}

stream: http://list.tv:8888/325/mono.m3u8?token=secret

catchup: http://list.tv:8888/325/mono.m3u8?token=secret&cutv={Y}-{m}-{d}T{H}:{M}:{S}


Query format string [archive_format]

A query format string (provider dependent) allowing timestamp information to be appended to a URL to denote when to catchup from. E.g. &cutv={Y}-{m}-{d}T{H}:{M}:{S}, which allows year, month, day, hour minute and second to be inserted to give: &cutv=2019-11-26T22:00:32. If the M3U entry using has a catchup mode of 'default' or 'append' and a 'catchup-source' tag is provided in the M3U entry this setting will be ignored.

Catchup window [archive_reverse_auto]

A number of days into the past in which it is possible to catchup on a programme. Auto mode will read the 'catchup=' tag in M3U list.

Adjust starttime [archive_timezone_adjust]

(hours)

Offset setting adjusts start time for catchup, in hours. This option can be helpful if the viewers timezone is different from the programs original broadcast timezone.

Catchup window manual mode

Catchup window days [archive_manual_days]

Overrides auto mode setting and sets the catchup days manually (maximum 30 days).

Catchup only finished programmes [archive_finished_program]

(Enabled, Disabled)

When selected from the EPG the current live programme cannot be watched as catchup until finished.

Lists

List previous days [listing_pre_days]

Select how many previous days to show in listing views.

List future days [listing_days]

Select how many future days to show in listing views.

Sort list by time [listing_sort_time]

(Enabled, Disabled)

Default listing views are sorted by time then channel.

Include synopsis in title search [program_search_plot]

When searching for titles, description will also be included. This is what you would expect from most online searches.

Appearance

Skin [RunScript($CWD/skins.py, SelectSkin)]

Select desire add-on skin to change the appearance.

Install font pack [skin_fontpack]

Install font pack for selected add-on skin.

Restore fonts [RunScript($CWD/skins.py, RestoreFont)]

Restore current Kodi skin Font.xml file to it's original state and deletes all add-on skin fonts modifications. To manually restore fonts navigate to your Kodi skin resolution folder and rename the Font_backup.xml file.

Delete all skins [RunScript($CWD/skins.py, DeleteSkins)]

Delete all installed add-on skins.

Colours

Category colours [color]

Select a colour for different category.

Default colours [color]

Select a colour for default, focus, schedule and recording highlight.

Debugging

Upload kodi log [RunScript($CWD/logUploader.py, primary)]

Uploads your kodi.log file and returns an url you can post to seek help with an add-on issue. Be aware that this log file may contain sensitive information about your system.

Enable debugging mode [debug]

If enabled debugging mode will be turned on and a Debug menu will be visible in add-on context options.

Update

Update now [UpdateAddonRepos]

Install latest available add-on update from the mods-kodi repository.

⚠️ **GitHub.com Fallback** ⚠️