Custom Formatter

The Custom Formatter gives you full control over how each stream's name and description are displayed in Stremio (and other clients). You can live-preview your format on the configuration page using the Preview button.

Access a variable using:

{variableName.propertyName}

Modifiers are chained with :::

{variableName.propertyName::modifier}

Variables

Config

Stream

Source

File

Video

Audio

Languages

Subtitles

Release

Season / Episode

P2P / Tracker

Anime

Scoring

Service

Addon

Metadata

Debug

Modifiers

Modifiers are applied left to right, and each one acts on the result of the last:

{stream.filename::lower::truncate(20)}

Field and modifier names are case-insensitive, so {stream.filename} and {Stream.FileName} are the same. Whitespace inside the braces is ignored.

Applying a modifier to a field that has no value renders nothing, so {stream.size::bytes} is empty rather than an error when the size is unknown. Applying one to the wrong type is an error and is shown inline, e.g. {stream.filename::bytes} renders {unknown_string_modifier(bytes)}.

Any Type

{stream.quality::default('Unknown')}   ->  BluRay, or Unknown when absent
{stream.library::string}               ->  true

A quoted value can be used wherever a field is expected, which is useful for piping fixed text through modifiers:

{'n/a'::upper}          ->  N/A
{'ready'::smallcaps}    ->  ʀᴇᴀᴅʏ

String Modifiers

::smallcaps only affects letters, so it combines with the digit modifiers:

{stream.resolution::smallcaps}              ->  2160ᴘ
{stream.resolution::subscript::smallcaps}   ->  ₂₁₆₀ᴘ

::translate maps each character of from to the character at the same position in to. Characters without a counterpart are left unchanged, so a shorter to never drops text:

{stream.quality::translate('Bl','Яⅼ')}   ->  ЯⅼuRay

Number Modifiers

Date & Duration Patterns

::date('…') and ::time('…') take a pattern string, so you can build any style you like instead of picking from a fixed list.

Both share the same rules:

• %X is a token, replaced with a value. Everything else is literal text.
• %-X is the unpadded form of %X (7 instead of 07).
• [...] marks an optional group: it disappears when every token inside it is zero. Use it to hide empty units.
• %%, %[ and %] emit a literal %, [ and ].
• An unrecognised token is left as-is, so typos show up in the output.

Duration patterns

Used by ::time('…') on {stream.duration}.

The largest unit in the pattern carries the overflow, so a pattern with no %H reads minutes as the total:

Date patterns

Used by ::date('…') on {stream.date}. Dates are read in UTC; anything that isn't a valid YYYY-MM-DD is passed through untouched.

Patterns chain with the other modifiers as usual:

{stream.date::date('%B %o, %Y')::upper}   ->  JULY 4TH, 2023

Array Modifiers

Conditional Modifiers

Conditionals evaluate to true or false and control what text is shown:

{variable.property::conditionalModifier["trueString"||"falseString"]}

Example: Show seeders only if greater than 1:

{stream.seeders::>1["Seeders: {stream.seeders}"||""]}

in saves repeating a field across several = comparisons, and matches if any element of an array is listed:

{service.id::in('torbox','realdebrid')["🟩"||"⬜"]}
{stream.languages::in('english')["🇬🇧"||""]}

A boolean field needs no modifier at all, and accepts an optional third branch for when the value is missing rather than false:

{service.cached["Cached"||"Uncached"||"Unknown"]}

  cached      ->  Cached
  not cached  ->  Uncached
  unknown     ->  Unknown

Without a third branch, a missing value renders nothing. istrue and isfalse both evaluate to false for a missing value, so use the third branch when the three states need distinguishing.

Nesting

A conditional can contain another conditional inside either branch. Quotes belonging to the inner one must be escaped with \":

{stream.resolution::exists["{stream.quality::exists[\"{stream.resolution} {stream.quality}\"||\"{stream.resolution}\"]}"||"Unknown"]}

  2160p + BluRay  ->  2160p BluRay
  2160p only      ->  2160p
  neither         ->  Unknown

Nesting is limited to five levels deep. Beyond that the branch is emitted as plain text.

Optional Groups

{? ... ?} renders only when every field inside it has a value. If any is missing, the whole group disappears, including its literal text.

{?📅 {stream.age} ?}

  age known    ->  📅 30d
  age unknown  ->  (nothing, not even the icon)

Groups nest, so a separator can depend on its own field:

{?[{stream.resolution}{? · {stream.quality}?}]?}

  2160p + BluRay  ->  [2160p · BluRay]
  2160p only      ->  [2160p]
  neither         ->  (nothing)

Conditionals

Chain multiple conditions together using and, or, or xor:

{var1::cond1::or::var2::cond2["trueString"||"falseString"]}

Conditions are evaluated left to right: (x and y or z) → ((x and y) or z).

Example: Show seeders only when the stream is either uncached or a P2P torrent:

{service.cached::isfalse::or::stream.type::=p2p::and::stream.seeders::>0["Seeders: {stream.seeders}"||""]}

Tools

Use formatting tools with {tools.toolName}:

Chillio

For Chillio, the name template maps to the ChillLink title field. The description template is split line-by-line into metadata strings — each line becomes a separate metadata entry.

Examples

Community-created formats are shared on the Discord Server.

You can also view the built-in formatter definitions at: packages/core/src/formatters/predefined.ts