SmartSkip.conf 1.2

Added default config of SmartSkip 1.2 with explanation regarding each option.

Author: Eisa01

script-opts/SmartSkip.conf

@@ -0,0 +1,220 @@
+######----Settings For SmartSkip 1.2----######
+####------Script Settings-----####
+
+
+####------Silence Skip Settings-------####
+#--(#number). Maximum amount of noise to trigger, in terms of dB. Lower is more sensitive.
+silence_audio_level=-40
+
+#--(#number). Duration of the silence that will be detected to trigger skipping.
+silence_duration=0.65
+
+#--(0/#number). The detcted silences will be ignored for the below defined seconds, and it will continue skipping until a silence is detected that surpasses the ignore duration.
+# (0 for disabled, or specify seconds).
+ignore_silence_duration=5
+
+#--(0/#number). Minimum amount of seconds accepted to skip until the configured silence_duration.
+# (0 for disabled, or specify seconds)
+min_skip_duration=0
+
+#--(0/#number). Maximum amount of seconds accepted to skip until the configured silence_duration.
+# (0 for disabled, or specify seconds)
+max_skip_duration=130
+
+#--(yes/no). Press keybind again while silence-skip is active to cancel
+keybind_twice_cancel_skip=yes
+
+#--(playlist-next/cancel/pause). If skip reaches playback end, and there is no silence detected.
+# (playlist-next: continues towards next playlist item / cancel: cancels seek and resumes from original position / pause: reaches end and pauses).
+silence_skip_to_end=playlist-next
+
+#-- After detecing silence, a chapter will be added.
+# (yes/no). Or specify types ["no-chapters", "internal-chapters", "external-chapters"].
+# e.g.: add_chapter_on_skip=["no-chapters", "external-chapters"]
+add_chapter_on_skip=yes
+
+#--(yes/no). Default is muted, however if audio was enabled due to custom mpv settings, the fast-forwarded audio can sound jarring.
+force_mute_on_skip=no
+
+
+####------Smart Skip Settings-------####
+#--The skip behavior after passing the last chapter
+# (defaults to silence-skip if not defined for a chapter type)
+# Available chapter types (no-chapters, internal-chapters, external-chapters)
+# Available skip types (silence-skip, chapter-next, playlist-next)
+# e.g.: last_chapter_skip_behavior=[ ["no-chapters", "silence-skip"], ["internal-chapters", "playlist-next"], ["external-chapters", "chapter-next"] ].
+last_chapter_skip_behavior=[ ["no-chapters", "silence-skip"], ["internal-chapters", "playlist-next"], ["external-chapters", "silence-skip"] ]
+
+#--(yes/no). During autoskip countdown, pressing smart_next keybind will auto-skip
+smart_next_proceed_countdown=yes
+
+#--(yes/no). During autoskip countdown, pressing smart_prev keybind will cancel the countdown to autoskip
+smart_prev_cancel_countdown=yes
+
+####------Chapters Settings-------####
+#--(yes/no). Automatically loads external chapters when detected.
+# priority: 1. chapters file in the same directory as the playing file, 2. hashed version of the chapters file in the global directory, 3. path based version of the chapters file in the global directory
+external_chapters_autoload=yes
+
+#-- Modifying chapters using SmartSkip will autosave as external-chapters
+# (yes/no). Or specify types ["no-chapters", "internal-chapters", "external-chapters"]
+modified_chapters_autosave=["no-chapters", "external-chapters"]
+
+#--(yes/no). (yes: Saves all chapter files in a single global directory). (no: saves chapter next to the playback file)
+global_chapters=yes
+
+#--(path) Global path for storing external chapters
+#- Predefined directories (/:dir%script%, /:dir%mpvconf%)
+# (/:dir%script%) for placing it in the same directory of script,
+# (/:dir%mpvconf%) for mpv portable_config directory
+#- Or write any variable using "/:var" then the variable
+# (/:var) example: "/:var%APPDATA%", such as: "/:var%APPDATA%\mpv" OR "/:var%HOME%/mpv"
+#- It is also possible to mix and match path with predefined directories / variables
+global_chapters_path=/:dir%mpvconf%/chapters
+
+#--(yes/no). Hashes the chapters saved in the global directory, allowing for multiple files with the same name to have external chapters.
+hash_global_chapters=yes
+
+#--(yes/no). (yes: Adding chapter asks for title) (no: Adds chapter without name)
+add_chapter_ask_title=no
+
+#--(yes/no). Pauses the playback when asking for chapter title
+add_chapter_pause_for_input=no
+
+#--(text). Placeholder when asking for title of a new chapter
+add_chapter_placeholder_title=Chapter 
+
+####------Auto-Skip Settings-------####
+
+#--(yes/no). Allows for chapters to be skipped automatically based on configured categories and skip
+autoskip_chapter=yes
+
+#--(#number). Countdown in seconds before initiating autoskip
+autoskip_countdown=3
+
+#--(yes/no). Bulk consecutive autoskip chapters together in 1 countdown
+autoskip_countdown_bulk=no
+
+#--(yes/no). Sends prompt for autoskip without forcing
+autoskip_countdown_graceful=no
+
+#-- Detected autoskip will be triggered once only for each chapter
+# (yes/no). Or specify types ["internal-chapters", "external-chapters"]
+skip_once=no
+
+#--(string) write the string for any chapter type following the syntax:
+# e.g.: categories=my-new-category>Part [AB]/Ending 1; another-category>Part C/Part D
+#-- Or specify categories string for each chapter type.
+# e.g.: categories=[ ["internal-chapters", "my-new-category>Part [AB]/Ending 1; another-category>Part C/Part D"], ["external-chapters", "idx->0/1/2/3"] ]
+# Syntax: category-name-1>chapter-name-1-slash-separated/chapter-name-2-slash-seperated; lua patterns, each category is separated by semicolons
+# Predefined Category: (idx- followed by the chapter index / slash seperated to autoskip based on index)
+categories=[ ["internal-chapters", "prologue>Prologue/^Intro; opening>^OP/ OP$/^Opening; ending>^ED/ ED$/^Ending; preview>Preview$"], ["external-chapters", "idx->0/2"] ]
+
+#--(string) enables defined categories for autoskip
+# e.g: skip=opening;ending
+# Or write the category names for each chapter type:
+# e.g.: skip=[ ["internal-chapters", "prologue;ending"], ["external-chapters", "idx-"] ] ]]
+# Syntax: To enable category for autoskip, write any defined category name inside the string, followed by a semicolons.
+
+##-- Predefined Categories: (toggle, toggle_idx, idx-)
+# (idx- is for enabling index based autoskip). 
+# (toggle is for chapters toggled during playback).
+# (toggle_idx is for chapter index toggled during playback)
+
+skip=[ ["internal-chapters", "toggle;toggle_idx;opening;ending;preview"], ["external-chapters", "toggle;toggle_idx"] ] 
+
+####------Autoload Settings-------####
+#--(yes/no). Autoload files in the same directory into playlist
+autoload_playlist=yes
+
+#--(#number). Max entries for autoload * 2 when starting a file (before + after). 5000 is the maximum recommended value
+autoload_max_entries=5000
+
+#--(#number). Max directory stack for autoload when starting a file. 20 is the recommended value
+autoload_max_dir_stack=20
+
+#--(yes/no). Hidden files in the directory will be ignored
+ignore_hidden=yes
+
+#--(yes/no). Allow same type of extensions
+same_type=no
+
+#--(auto/recursive/lazy/ignore). Specify the directory mode for autoload
+directory_mode=auto
+
+#--(yes/no). Types that will be autoloaded
+images=yes
+videos=yes
+audio=yes
+
+#--(extension,). Add additional extenions to be autoloaded.
+# e.g.: additional_image_exts=bmp,vob,pxr
+additional_image_exts=
+additional_video_exts=
+additional_audio_exts=
+
+####------OSD Messages Settings-------####
+
+#--(-1/milliseconds). Duration for the osd message in milliseconds, applies to all osd_messages. 
+# -1 reverts to mpv --osd-duration
+osd_duration=2500
+
+#-- (no-osd/osd-bar/osd-msg/osd-msg-bar). OSD message that will be shown when the script triggers an action
+seek_osd=osd-msg-bar
+chapter_osd=osd-msg-bar
+autoskip_osd=osd-msg-bar
+
+#--(yes/no). Shows OSD when playlist entry changes
+playlist_osd=yes
+
+#--(yes/no). All other OSD messages.
+osd_msg=yes
+
+####------Keybind Settings-------####
+#-- Add below (after a comma) any additional keybind you want to bind. Or change the letter inside the quotes to change the keybind
+# e.g.: ["ctrl+x"], e.g.2: ["atl+n", "n", "N"]
+
+#-- Enables or disables autoload during playback for the session
+toggle_autoload_keybind=[""]
+
+#-- Enables or disables Auto-Skip during playback for the session
+toggle_autoskip_keybind=["ctrl+."]
+
+#-- Enables or disables a chapter for Auto-Skip during playback for the session
+toggle_category_autoskip_keybind=["alt+."]
+
+#-- Cancels Auto-Skip when countdown is started
+cancel_autoskip_countdown_keybind=["esc", "n"]
+
+#-- Proceeds Auto-Skip when countdown is started
+proceed_autoskip_countdown_keybind=["enter", "y"]
+
+#-- Add a chapter for the reached position
+add_chapter_keybind=["n"]
+
+#-- Removes the current chapter
+remove_chapter_keybind=["alt+n"]
+
+#-- Renames the current chapter
+edit_chapter_keybind=[""]
+
+#-- Manually save the changes for chapters using an external file
+write_chapters_keybind=["ctrl+n"]
+
+#-- Merge the changes of chapters for the file inside mkv file
+bake_chapters_keybind=[""]
+
+#-- Jumps to next chapter > to next playlist
+chapter_next_keybind=["ctrl+right"]
+
+#-- Jumps to previous chapter > to begining > to previous playlist
+chapter_prev_keybind=["ctrl+left"]
+
+#-- Triggers silence_skip > next chapter > next playlist based on different variables
+smart_next_keybind=[">"]
+
+#-- Jumps to begining  > previous chapter > previous playlist based on different variables
+smart_prev_keybind=["<"]
+
+#-- Triggers silence skip to detect silence as per the configured parameters
+silence_skip_keybind=["?"]