Floatplane channel plugin for Jellyfin 10.10.x: browse, HLS proxy, cookie session, CI release
Some checks failed
release / build-release (push) Has been cancelled

- IChannel: creators -> sub-channels -> video posts (public listing API, search mapped)
- IRequiresMediaInfoCallback -> signed proxy URLs; stream controller rewrites HLS so the
  AES-128 key is fetched server-side with the session cookie, segments stay on the CDN
- delivery/info cached per token lifetime and throttled (~2/min)
- config page: paste sails.sid + validate, extra creators, quality, search test
- scripts/package.sh -> plugin folder + zip + md5 + manifest.json; Gitea release workflow
- research docs, HAR analysis (HAR itself gitignored), install-pi5.sh

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
2026-10-25 09:42:27 +01:00
commit 9e33a343ab
162 changed files with 52004 additions and 0 deletions

View File

@@ -0,0 +1,246 @@
<!DOCTYPE html>
<html>
<head>
<title>Floatplane</title>
</head>
<body>
<div id="FloatplaneConfigPage" data-role="page" class="page type-interior pluginConfigurationPage"
data-require="emby-input,emby-button,emby-select,emby-checkbox">
<div data-role="content">
<div class="content-primary">
<form id="FloatplaneConfigForm">
<div class="verticalSection">
<h2 class="sectionTitle">Floatplane</h2>
<div id="fpStatus" class="fieldDescription" style="margin-bottom:1em">Loading status…</div>
</div>
<div class="verticalSection">
<h3 class="sectionTitle">Session</h3>
<div class="inputContainer">
<label class="inputLabel" for="SessionCookie">sails.sid cookie</label>
<input is="emby-input" type="password" id="SessionCookie" autocomplete="off" />
<div class="fieldDescription">
Floatplane's password login needs a browser captcha, so paste the session instead:
log in at floatplane.com, open DevTools → Application (Chrome) / Storage (Firefox) → Cookies →
<code>https://www.floatplane.com</code> → copy the <b>Value</b> of <code>sails.sid</code>.
Browsing works without it; playback and subscriptions need it.
</div>
</div>
<div>
<button is="emby-button" type="button" id="btnValidate" class="raised"><span>Validate cookie</span></button>
<span id="validateResult" class="fieldDescription" style="margin-left:1em"></span>
</div>
</div>
<div class="verticalSection">
<h3 class="sectionTitle">Catalogue</h3>
<div class="inputContainer">
<label class="inputLabel" for="ExtraCreators">Extra creators (url-names, comma separated)</label>
<input is="emby-input" type="text" id="ExtraCreators" placeholder="linustechtips, bitwit" />
<div class="fieldDescription">Shown in addition to your subscriptions — or instead of them when no cookie is set (public listings only, no playback).</div>
</div>
<div class="inputContainer">
<label class="inputLabel" for="MaxPostsPerChannel">Videos listed per channel</label>
<input is="emby-input" type="number" id="MaxPostsPerChannel" min="20" max="2000" step="20" />
<div class="fieldDescription">Newest first. Floatplane pages 20 at a time, so 100 = 5 requests per channel.</div>
</div>
<div class="checkboxContainer checkboxContainer-withDescription">
<label class="emby-checkbox-label">
<input is="emby-checkbox" type="checkbox" id="ShowLockedPosts" />
<span>Show posts above my tier (locked)</span>
</label>
</div>
<div class="inputContainer">
<label class="inputLabel" for="CatalogCacheMinutes">Listing cache (minutes)</label>
<input is="emby-input" type="number" id="CatalogCacheMinutes" min="1" max="1440" />
</div>
<div class="inputContainer">
<label class="inputLabel" for="SyncIntervalHours">Automatic refresh (hours)</label>
<input is="emby-input" type="number" id="SyncIntervalHours" min="1" max="168" />
<div class="fieldDescription">Also available as the scheduled task "Refresh Floatplane catalogue".</div>
</div>
<div>
<button is="emby-button" type="button" id="btnRefresh" class="raised"><span>Refresh now</span></button>
</div>
</div>
<div class="verticalSection">
<h3 class="sectionTitle">Playback</h3>
<div class="selectContainer">
<label class="selectLabel" for="PreferredQuality">Preferred quality</label>
<select is="emby-select" id="PreferredQuality" class="emby-select-withcolor">
<option value="360">360p</option>
<option value="480">480p</option>
<option value="720">720p</option>
<option value="1080">1080p</option>
<option value="2160">4K (needs the 4K tier)</option>
</select>
<div class="fieldDescription">Listed first as the default version; other qualities appear as extra versions in the player.</div>
</div>
<div class="inputContainer">
<label class="inputLabel" for="MaxHeight">Highest quality offered (pixels)</label>
<input is="emby-input" type="number" id="MaxHeight" min="360" max="2160" step="1" />
</div>
<div class="inputContainer">
<label class="inputLabel" for="DeliveryCallsPerMinute">Delivery lookups per minute</label>
<input is="emby-input" type="number" id="DeliveryCallsPerMinute" min="1" max="10" />
<div class="fieldDescription">Floatplane rate-limits the stream-URL endpoint to about 2 per minute. Results are cached for the token's lifetime (6 h).</div>
</div>
<div class="inputContainer">
<label class="inputLabel" for="ProxyBaseUrl">Proxy base URL (optional)</label>
<input is="emby-input" type="text" id="ProxyBaseUrl" placeholder="http://127.0.0.1:8096" />
<div class="fieldDescription">How the server's own ffmpeg reaches this plugin. Leave empty to use Jellyfin's local address.</div>
</div>
<div class="checkboxContainer checkboxContainer-withDescription">
<label class="emby-checkbox-label">
<input is="emby-checkbox" type="checkbox" id="EnableMp4Sources" />
<span>Also offer progressive MP4 versions (experimental)</span>
</label>
<div class="fieldDescription checkboxFieldDescription">Uses Floatplane's download delivery. Untested — may not play.</div>
</div>
</div>
<div>
<button is="emby-button" type="submit" class="raised button-submit block"><span>Save</span></button>
</div>
</form>
<div class="verticalSection" style="margin-top:2em">
<h3 class="sectionTitle">Search test (Floatplane API)</h3>
<div class="selectContainer">
<label class="selectLabel" for="searchCreator">Creator</label>
<select is="emby-select" id="searchCreator" class="emby-select-withcolor"></select>
</div>
<div class="inputContainer">
<label class="inputLabel" for="searchQuery">Query</label>
<input is="emby-input" type="text" id="searchQuery" placeholder="framework" />
</div>
<div>
<button is="emby-button" type="button" id="btnSearch" class="raised"><span>Search</span></button>
</div>
<div id="searchResults" class="fieldDescription" style="margin-top:1em; white-space:pre-wrap"></div>
</div>
</div>
</div>
<script type="text/javascript">
(function () {
var pluginId = "7f2b6c1e-5a3d-4e8f-9b0a-2c4d6e8f0a1b";
var fields = ["SessionCookie", "ExtraCreators", "MaxPostsPerChannel", "CatalogCacheMinutes", "SyncIntervalHours",
"PreferredQuality", "MaxHeight", "DeliveryCallsPerMinute", "ProxyBaseUrl"];
var checks = ["ShowLockedPosts", "EnableMp4Sources"];
function el(id) { return document.getElementById(id); }
function esc(s) { return String(s == null ? "" : s).replace(/[&<>"]/g, function (c) { return { "&": "&amp;", "<": "&lt;", ">": "&gt;", "\"": "&quot;" }[c]; }); }
function loadStatus() {
ApiClient.getJSON(ApiClient.getUrl("Floatplane/Status")).then(function (s) {
var lines = [];
lines.push("Plugin " + esc(s.Version));
if (!s.HasSessionCookie) {
lines.push("Session: <b>no cookie</b> — browsing only.");
} else if (s.SessionState === "ok") {
lines.push("Session: <b>ok</b>" + (s.SessionUsername ? " (" + esc(s.SessionUsername) + ")" : ""));
} else if (s.SessionState === "invalid") {
lines.push("Session: <b style='color:#e55'>rejected</b> — paste a fresh cookie. " + esc(s.LastError || ""));
} else {
lines.push("Session: cookie set, not checked yet.");
}
lines.push("Creators: " + s.Creators.length + (s.LastRefresh ? " (refreshed " + new Date(s.LastRefresh).toLocaleString() + ")" : " (not loaded yet)"));
s.Creators.forEach(function (c) { lines.push("&nbsp;&nbsp;• " + esc(c.Title) + " — " + esc(c.Channels.join(", "))); });
lines.push("Cached post lists: " + s.CachedPostLists + ", cached deliveries: " + s.CachedDeliveries + ", generation " + s.Generation);
el("fpStatus").innerHTML = lines.join("<br/>");
var sel = el("searchCreator");
sel.innerHTML = s.Creators.map(function (c) { return "<option value='" + esc(c.Id) + "'>" + esc(c.Title) + "</option>"; }).join("");
}).catch(function () { el("fpStatus").textContent = "Status unavailable"; });
}
function loadConfig() {
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(pluginId).then(function (config) {
fields.forEach(function (f) { el(f).value = config[f] == null ? "" : config[f]; });
checks.forEach(function (f) { el(f).checked = !!config[f]; });
Dashboard.hideLoadingMsg();
loadStatus();
});
}
function saveConfig(e) {
e.preventDefault();
Dashboard.showLoadingMsg();
ApiClient.getPluginConfiguration(pluginId).then(function (config) {
fields.forEach(function (f) {
var v = el(f).value;
config[f] = (el(f).type === "number") ? parseInt(v || "0", 10) : v;
});
checks.forEach(function (f) { config[f] = el(f).checked; });
config.SessionCookie = (config.SessionCookie || "").replace(/^sails\.sid=/, "").trim();
var validated = el("validateResult").getAttribute("data-username");
if (validated && el("validateResult").getAttribute("data-cookie") === config.SessionCookie) {
config.SessionUsername = validated;
}
ApiClient.updatePluginConfiguration(pluginId, config).then(function (result) {
Dashboard.processPluginConfigurationUpdateResult(result);
// Reload creators with the new settings.
ApiClient.ajax({ type: "POST", url: ApiClient.getUrl("Floatplane/Refresh") }).then(loadStatus, loadStatus);
});
});
return false;
}
function validate() {
var out = el("validateResult");
out.textContent = "Checking…";
ApiClient.ajax({
type: "POST",
url: ApiClient.getUrl("Floatplane/Session/Validate"),
data: JSON.stringify({ Cookie: el("SessionCookie").value }),
contentType: "application/json",
dataType: "json"
}).then(function (r) {
out.textContent = r.Message + (r.Subscriptions && r.Subscriptions.length ? " — " + r.Subscriptions.join("; ") : "");
out.style.color = r.Ok ? "#4c4" : "#e55";
if (r.Ok) {
out.setAttribute("data-username", r.Username);
out.setAttribute("data-cookie", r.Cookie);
el("SessionCookie").value = r.Cookie;
}
}).catch(function (err) {
out.textContent = "Request failed (" + (err && err.status ? err.status : "?") + ")";
out.style.color = "#e55";
});
}
function refresh() {
el("fpStatus").textContent = "Refreshing…";
ApiClient.ajax({ type: "POST", url: ApiClient.getUrl("Floatplane/Refresh") }).then(loadStatus, loadStatus);
}
function search() {
var creator = el("searchCreator").value;
var q = el("searchQuery").value;
var out = el("searchResults");
if (!creator) { out.textContent = "No creator loaded yet."; return; }
out.textContent = "Searching…";
ApiClient.getJSON(ApiClient.getUrl("Floatplane/Search", { creatorId: creator, q: q, limit: 20 })).then(function (hits) {
if (!hits.length) { out.textContent = "No results."; return; }
out.innerHTML = hits.map(function (h) {
var d = h.ReleaseDate ? new Date(h.ReleaseDate).toISOString().slice(0, 10) : "";
return esc(d) + " [" + esc(h.Channel || "") + "] " + (h.IsAccessible ? "" : "🔒 ") + esc(h.Title) + " (" + Math.round(h.DurationSeconds / 60) + " min)";
}).join("\n");
}).catch(function () { out.textContent = "Search failed."; });
}
var page = el("FloatplaneConfigPage");
page.addEventListener("pageshow", loadConfig);
el("FloatplaneConfigForm").addEventListener("submit", saveConfig);
el("btnValidate").addEventListener("click", validate);
el("btnRefresh").addEventListener("click", refresh);
el("btnSearch").addEventListener("click", search);
})();
</script>
</div>
</body>
</html>