kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-12 12:05:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 9b49299 with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-09-12 03:18:18 +00:00
parent 7f155aacba
commit c2abfcd84b
6 changed files with 116 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
objects.inv
BIN
View File
Binary file not shown.
reference/api/config/index.html
+42
View File
@@ -1895,6 +1895,17 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.restore_bool_languages" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;restore_bool_languages
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2115,6 +2126,17 @@
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.config.restore_bool_languages" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-function"></code>&nbsp;restore_bool_languages
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2346,6 +2368,26 @@ between variables. Falls back to dot separator (scene-style) by default.</p>
<div class="doc doc-object doc-function">
<h2 id="unshackle.core.config.restore_bool_languages" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">restore_bool_languages</span>
<a href="#unshackle.core.config.restore_bool_languages" class="headerlink" title="Permanent link">&para;</a></h2>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">restore_bool_languages</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Put back the language tags <code>no</code> and <code>yes</code>, which YAML reads as booleans.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h2 id="unshackle.core.config.resolve_decryption" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">resolve_decryption</span>
reference/configuration/download/index.html
+35 -2
View File
@@ -2320,6 +2320,14 @@ default. In other words, config only fills in options you did not set on the com
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="admonition-title"><code>no</code> and <code>yes</code> are language tags</p>
<p>YAML reads a bare <code>no</code> as <code>false</code> and a bare <code>yes</code> as <code>true</code>. unshackle puts both back to
the tags <code>no</code> (Norwegian) and <code>yes</code> (Nyankpa) in every config key that takes a language: <code>lang</code>,
<code>v_lang</code>, <code>a_lang</code>, <code>s_lang</code>, <code>forced_s_lang</code>, <code>require_audio</code>, <code>require_video</code>,
<code>require_subs</code>, <a href="#subtitle"><code>language_priority</code></a>, <a href="#muxing"><code>muxing.default_language</code></a> and
the <a href="#language_tags"><code>language_tags</code></a> rules. Quotes (<code>lang: "no"</code>) work as well.</p>
</div>
<div class="language-yaml highlight"><span class="filename">Global download defaults</span><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nt">dl</span><span class="p">:</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">lang</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">en</span><span class="p p-Indicator">]</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">quality</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">1080</span><span class="p p-Indicator">]</span>
@@ -2630,7 +2638,7 @@ bitrate alone, with those same Atmos/descriptive rules still applied.</p>
<tbody>
<tr>
<td><code>audio</code></td>
<td>Matches against the audio track languages.</td>
<td>At least one audio language matches.</td>
</tr>
<tr>
<td><code>subs_contain</code></td>
@@ -2638,16 +2646,41 @@ bitrate alone, with those same Atmos/descriptive rules still applied.</p>
</tr>
<tr>
<td><code>subs_contain_all</code></td>
<td>Every listed language must be present (scalar or list).</td>
<td>Every listed language must be present.</td>
</tr>
<tr>
<td><code>dual</code> / <code>multi</code> / <code>dubbed</code></td>
<td><code>true</code> matches when that filename variable is set, <code>false</code> when it is not.</td>
</tr>
</tbody>
</table>
<p>Each language condition takes one language tag or a list of them. A list matches when <strong>any</strong>
entry matches, except <code>subs_contain_all</code>, which needs them all. An entry that is not a valid
language tag (for example <code>japanese</code>) never matches. <code>dual</code>, <code>multi</code> and <code>dubbed</code> take a bare
<code>true</code> or <code>false</code>, not a quoted string. unshackle skips a rule with a condition name it does
not know, or with any other value in a boolean condition. It logs a warning in each of these
cases and tries the next rule.</p>
<p><code>dual</code>, <code>multi</code> and <code>dubbed</code> carry the same meaning as the
<a href="#dual_multi_mode">filename variables of those names</a>. Pair one with a language to name a
release yourself, in place of the fixed <code>DUAL</code>, <code>MULTi</code> and <code>DUBBED</code> text. A rule that names
<code>dubbed: true</code> and a language tags a localized dub without tagging a native release the same way.</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nt">language_tags</span><span class="p">:</span>
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="w"> </span><span class="nt">rules</span><span class="p">:</span>
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">audio</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">ja</span><span class="p p-Indicator">]</span>
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span><span class="nt">subs_contain</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">en</span><span class="p p-Indicator">]</span>
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="s">"SUBBED"</span>
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">audio</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">th</span>
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="w"> </span><span class="nt">dubbed</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="s">"THAIDUB"</span>
</span><span id="__span-9-9"><a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">audio</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">th</span>
</span><span id="__span-9-10"><a id="__codelineno-9-10" name="__codelineno-9-10" href="#__codelineno-9-10"></a><span class="w"> </span><span class="nt">dual</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</span><span id="__span-9-11"><a id="__codelineno-9-11" name="__codelineno-9-11" href="#__codelineno-9-11"></a><span class="w"> </span><span class="nt">tag</span><span class="p">:</span><span class="w"> </span><span class="s">"THAIDUAL"</span>
</span></code></pre></div>
<div class="admonition note">
<p class="admonition-title">Put <code>{lang_tag}</code> where you want the name</p>
<p>These rules fill <code>{lang_tag}</code>. To use your own name in place of the fixed text, keep
<code>{lang_tag?}</code> in the template and leave out <code>{dual?}</code>, <code>{multi?}</code> and <code>{dubbed?}</code>.</p>
</div>
<h2 id="dual_multi_mode"><code>dual_multi_mode</code><a class="headerlink" href="#dual_multi_mode" title="Permanent link">&para;</a></h2>
<ul>
<li><strong>Type:</strong> <code>str</code> &nbsp;·&nbsp; <strong>Default:</strong> <code>strict</code></li>
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+38 -38
View File
@@ -2,154 +2,154 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.unshackle.dev/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/dashboard/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/post-scripts/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-09-10</lastmod>
<lastmod>2026-09-12</lastmod>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.