# ==============================================================================
# mpv-skip-segment configuration
# Location: ~~/script-opts/jumpskip.conf
# version 2.0
# ==============================================================================

# Master toggle for the script (yes/no)
enabled=yes

# Directory filter (comma-separated entries) (case-insensitive):
# Controls which videos are processed based on their directory location.
# When empty (default), every video is processed.
#
# Inclusion patterns:
#  1. Bare name: match the immediate parent folder name of the file.
#       filter_directories=Series -> include videos whose immediate parent folder is named 'Series'
#
#  2. Path fragment (leading '\' or '/'): match the fragment anywhere within
#      the file's full normalized path,
#        filter_directories=\Movies -> include any video under a 'Movies' folder at any directory level
#
# Exclusion patterns (using an asterisk '*' as a prefix or suffix)(takes precedence):
#  1. Immediate parent folder exclusion (*Movie or Movie*):
#       filter_directories=*Movie -> exclude videos whose immediate parent folder is named 'Movie'
#
#  2. Path fragment exclusion (\*Movies, \Movies*):
#       filter_directories=\*Movies -> exclude any video under a 'Movies' folder at any directory level
filter_directories=

# Auto-skip behavior:
# Set to 'yes' to automatically skip segments when entering them without clicking.
# Set to 'no' to display the on-screen button and wait for user click or keybind.
auto_skip=no

# Auto-skip countdown (in seconds):
# If auto_skip is enabled and countdown > 0, an on-screen countdown prompt will be
# displayed before skipping, allowing you to cancel by clicking or seeking away.
# If set to 0, auto-skip takes effect immediately upon entering the segment.
auto_skip_countdown=0

# Segment types to auto-skip (comma-separated):
# Accepted values: intro, outro, recap, preview, post_credits (whitespace around entries is ignored).
# - When left EMPTY (default), the global 'auto_skip' option above governs ALL
#   segment types.
# - When set (e.g. 'intro,recap'), ONLY the listed types are skipped automatically;
#   every other detected type shows the manual skip button / keybind prompt instead,
#   regardless of the 'auto_skip' setting.
# Invalid entries are ignored with a warning in the mpv log.
autoskip_types=

# Skip button timeout (in seconds):
# Automatically hides the on-screen skip button if it has not been clicked (or the
# keybind pressed) within this many seconds after it appears.
# The keybind remains active for the rest of the segment even after the button hides.
# 0 = button stays visible for the entire segment (default).
skip_button_timeout=3

# Segment types to detect and allow skipping:
skip_intro=yes
skip_recap=yes
skip_outro=yes
skip_preview=yes
skip_post_credits=yes

# Timestamps Submission (Provider API key required):
# Master toggle
enable_submission=yes
# Keybinding to open/close the submission overlay.
submission_keybind=Ctrl+q
# Per-provider submission toggles
theintrodb_submit_enabled=yes
introdb_submit_enabled=yes
skipdb_submit_enabled=yes

# Per-media-type provider priority (comma-separated):
# they control which providers are queried (and in what order) for TV shows vs movies.
# Supported providers: 'theintrodb', 'introdb', 'skipdb'
# Omit any provider to exclude it entirely for that media type.
provider_priority_tvshow=introdb,theintrodb,skipdb
provider_priority_movie=introdb,theintrodb,skipdb

# Per-provider, per-segment-type toggles:
# Set an entry to 'no' to ignore that segment type from that specific provider,
# while the same type from other providers (and other types from the same
# provider) continue to work normally.
# Example: skipdb_intro_segment=no drops intro segments sourced from SkipDB only.
# Note: these act as an additional filter on top of the global skip_<type>
# options above; a type disabled globally stays disabled for every provider.
#TheIntroDB
theintrodb_intro_segment=yes
theintrodb_recap_segment=yes
theintrodb_outro_segment=yes
theintrodb_preview_segment=yes
#IntroDB
introdb_intro_segment=yes
introdb_recap_segment=yes
introdb_outro_segment=yes
introdb_preview_segment=yes
introdb_post_credits_segment=yes
#SkipDB
skipdb_intro_segment=yes
skipdb_recap_segment=yes
skipdb_outro_segment=yes
skipdb_preview_segment=yes

# Timing offsets (in seconds):
# Adjust segment start and end times to match your media cut.
# - start_offset: negative value (e.g. -0.5) triggers the prompt/button slightly earlier;
#   positive value triggers it later.
# - end_offset: seconds added or subtracted to the jump target timestamp.
start_offset=0.0
end_offset=0.0

# Merge providers (yes/no):
# When enabled, if the primary provider only has an intro but no outro/recap,
# the script queries the secondary provider to retrieve the missing segment types.
merge_providers=yes

# Optional API Keys:
# TheIntroDB API key (Authorization: Bearer <key>)
# Increases daily rate/usage limits and weights your submissions higher.
theintrodb_api_key=

# IntroDB API key (X-API-Key: idb_...)
# Optional for reading segments.
introdb_api_key=

# SkipDB API key (Authorization: Bearer skdb_... or X-API-Key: skdb_...)
# Reading is open (120 req/min); a key is only needed for submitting segments.
skipdb_api_key=

# Optional TMDb API key:
# Used to resolve media titles to TMDb IDs if the media file lacks an IMDb/TMDb ID.
# If left blank, Cinemeta's free public catalog lookup is used automatically.
tmdb_api_key=

# HTTP network request timeout (in seconds) for curl subprocess:
request_timeout=20

# Keybinding to trigger skip when within an active segment:
# e.g. 'Tab', 'Return', 'ctrl+s', 's'
keybind=Tab

# Minimum segment duration (in seconds) to consider valid:
min_segment_duration=3.0

# On-Screen Display (OSD) Button Position:
# Options: 'bottom-right', 'bottom-left', 'top-right', 'top-left'
button_position=bottom-right

# Button Margins (scaled to 1080p base):
button_margin_x=60
button_margin_y=120

# Button Dimensions & Font:
button_width=220
button_height=56
button_font_size=24
button_font=mpv-osd

# Button Visual Colors (Hex BGR format for ASS styling):
# Default accent: Vibrant Sky Blue (#F0A35B -> ASS BGR '5ba3f0')
accent_color=5ba3f0
bg_color=0A0A0A
text_color=FFFFFF
hint_color=AAAAAA

# Show brief OSD message upon skipping (yes/no):
show_osd_message=yes
osd_message_duration=2.0

# Show_colored_segments: master toggle for coloured seekbar segment markers (yes/no).
# When 'no', no segments are published to the OSC and nothing is drawn on the
# seekbar. Auto-skip, the manual skip button, and chapter markers are NOT affected.
# Change colours using jumpskip_intro_color / jumpskip_outro_color / ... in modernz.conf.
show_colored_segments=yes

# Per-type marker toggles (only consulted while show_colored_segments=yes):
show_colored_intro_segments=yes
show_colored_recap_segments=yes
show_colored_outro_segments=yes
show_colored_preview_segments=yes
show_colored_post_credits_segments=yes

# Mark_chapters additionally inserts '<type>' chapter
# entries at segment boundaries. Note: chapter navigation
# (PgUp/PgDn) will also stop at these boundaries.
mark_chapters=yes

# When mark_chapters=yes and a video has no pre-existing chapters
# a new chapter is created to fill the rest of the video.
# Default_chapter_title: generic name for chapter created.
default_chapter_title=Chapter

# Chapter-based skipping: (fallback when providers return no data)
# Master toggle 
chapter_skip_enabled=yes

# Per-category toggles for chapter-based detection
chapter_skip_intro=yes
chapter_skip_outro=yes
chapter_skip_recap=yes
chapter_skip_preview=yes

# Keyword lists for each category (comma-separated, case-insensitive)
# Short keywords (<=3 chars) use whole-word matching to avoid false positives
chapter_skip_keywords_intro=intro,introduction,opening,op,theme,title sequence
chapter_skip_keywords_outro=ed,ending,outro,credits,end credits,closing
chapter_skip_keywords_recap=recap,previously
chapter_skip_keywords_preview=preview,next episode

# Sanity bounds for chapter duration (seconds)
# Chapters shorter than min or longer than max are ignored
chapter_skip_min_duration=10.0
chapter_skip_max_duration=600.0

# Overlap threshold (0.0-1.0): if a chapter-derived segment overlaps
# an existing provider segment by this fraction or more, it is discarded
chapter_skip_overlap_threshold=0.5

# Enable debug logging in mpv terminal (yes/no):
debug_mode=no