Advanced skip options

2026-03-13T17:33:26Z

Robb: /* More examples */ Add example of conditionally auto-skipping to highlights

'''Advanced skip options''' can be used to change the skip options depending on certain criteria of the submission itself.

Example:<syntaxhighlight lang="python">
// Skip sponsors at the start of the video
if time.start < 1 and time.end < 10 and category == "sponsor"
Auto skip
</syntaxhighlight>

== Description ==
Each rule consists of the word <code>if</code>, a condition, and an action.

Conditions can be checks of the form <code><attribute> <operator> <value></code> (for example, <code>time.start < 1</code>), or nested expressions using the <code>and</code>, <code>or</code>, and <code>not</code> operators.

=== Attributes ===
The following attributes are supported:

* <code>time.start</code> (when the segment starts in the video in seconds)
* <code>time.end</code> (when the segment ends in the video in seconds)
* <code>time.duration</code> (how long the segment is in seconds)
* <code>time.startPercent</code> (when the segment starts in the video as a percentage)
* <code>time.endPercent</code> (when the segment ends in the video as a percentage)
* <code>time.durationPercent</code> (how long the segment is as a percentage of the total video length)
* <code>category</code>
* <code>actionType</code>
* <code>chapter.name</code> (the title for chapters)
* <code>chapter.source</code> (to separate SponsorBlock chapters from YouTube chapters)
* <code>channel.id</code> (ID starting with <code>UC</code>)
* <code>channel.name</code> (plain text name with spaces)
* <code>video.duration</code> (the length of the video in seconds)
* <code>video.title</code>

=== Operators ===
The following operators are supported:

* <code><</code>
* <code><=</code>
* <code>></code>
* <code>>=</code>
* <code>==</code>
* <code>!=</code> (not equal)
* <code>*=</code> (contains text ignore case)
* <code>!*=</code> (not contains ignore case)
* <code>~=</code> (matches regex)
* <code>~i=</code> (matches regex ignore case)
* <code>!~=</code> (doesn't match regex)
* <code>!~i=</code> (doesn't match regex ignore case)

=== Actions ===
The following actions are supported:

* <code>Disabled</code>
* <code>Show overlay</code>
* <code>Manual skip</code>
* <code>Auto skip</code>

Unlike other words in the format, actions are case-insensitive.

=== Categories ===
The following categories are supported:

* {{Category|sponsor|text=<code>sponsor</code>|nolink=1}} ([[{{Category page|sponsor}}]])
* {{Category|selfpromo|text=<code>selfpromo</code>|nolink=1}} ([[{{Category page|selfpromo}}]])
* {{Category|exclusive_access|text=<code>exclusive_access</code>|nolink=1}} ([[{{Category page|exclusive access}}]])
* {{Category|interaction|text=<code>interaction</code>|nolink=1}} ([[{{Category page|interaction reminder}}]])
* {{Category|poi_highlight|text=<code>poi_highlight</code>|nolink=1}} ([[{{Category page|highlight}}]])
* {{Category|intro|text=<code>intro</code>|nolink=1}} ([[{{Category page|intro}}]])
* {{Category|outro|text=<code>outro</code>|nolink=1}} ([[{{Category page|endcards}}]])
* {{Category|preview|text=<code>preview</code>|nolink=1}} ([[{{Category page|preview}}]])
* {{Category|hook|text=<code>hook</code>|nolink=1}} ([[{{Category page|hook}}]])
* {{Category|filler|text=<code>filler</code>|nolink=1}} ([[{{Category page|tangents}}]])
* {{Category|chapter|text=<code>chapter</code>|nolink=1}} ([[{{Category page|chapter}}]])
* {{Category|music_offtopic|text=<code>music_offtopic</code>|nolink=1}} ([[{{Category page|nonmusic}}]])

=== Chapter sources ===
The following <code>chapter.source</code> values are supported:

* <code>server</code>
* <code>youtube</code>
* <code>autogenerated</code>
* <code>local</code>

== More examples ==
<syntaxhighlight lang="python">
// Auto skip chapters that contain the word bloopers (case insensitive)
if category == "chapter" and chapter.name *= "bloopers"
Auto skip

// Auto skip chapters that start with the word Intro or intro
if category == "chapter" and chapter.name ~= "^[Ii]ntro"
Auto skip

// Auto skip chapters that start with the word Intro or intro but only if they are made by the YouTuber
if category == "chapter" and chapter.name ~= "^[Ii]ntro" and chapter.source == "youtube"
Auto skip

// Auto skip chapters that start with the word Intro or intro but only if they are submitted by a SponsorBlock user
if category == "chapter" and chapter.name ~= "^[Ii]ntro" and chapter.source == "server"
Auto skip

// Auto skip preview/recap on this specific channel
if category == "preview" and channel.id == "UCX8wm5-NEzN-eL-DNcsRRJA"
Auto skip

// Auto skip intros on channels with names containing trains
if category == "intro" and channel.name *= "trains"
Auto skip

// Auto skip tangent/jokes or hooks at least 5 seconds long
if (category == "filler" or category == "hook") and time.duration >= 5
Auto skip

// Auto skip directly to highlights on channels with names containing trains
if category == "poi_highlight" and channel.name *= "trains"
Auto skip

</syntaxhighlight>

== Syntax ==
<syntaxhighlight lang="ebnf">
rule set = { rule };
rule = { comment }, "if", predicate, skip option;

comment = "//", ? rest of line ?;

predicate = or;
or = and, { "or", and };
and = unary, { "and", unary };
unary = "not", unary | primary;
primary = "(", predicate, ")" | check;
check = attribute, operator, value;

attribute = "time.startPercent" | "time.start" | "time.endPercent" | "time.end" | "time.durationPercent" | "time.duration" | "category" | "actionType" | "chapter.name" | "chapter.source" | "channel.id" | "channel.name" | "video.duration" | "video.title";
operator = "<=" | "<" | ">=" | ">" | "!=" | "==" | "!*=" | "*=" | "!~=" | "~=" | "!~i=" | "~i=";
value = ? JSON string ? | ? JSON number ?;

(* skip options are case-insensitive *)
skip option = "disabled" | "show overlay" | "manual skip" | "auto skip";
</syntaxhighlight>

SponsorBlock - User contributions [en-ca]

Advanced skip options