Compare commits
No commits in common. "main" and "v1.0.4" have entirely different histories.
9 changed files with 123 additions and 860 deletions
|
|
@ -1,30 +0,0 @@
|
||||||
# Scan the repository for accidentally-committed secrets with gitleaks on
|
|
||||||
# every push and pull request. Runs over full history so it catches secrets
|
|
||||||
# introduced in any commit in the pushed range.
|
|
||||||
|
|
||||||
name: gitleaks
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
pull_request:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
scan:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
# Full history — gitleaks needs depth to scan a commit range.
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: install gitleaks
|
|
||||||
run: |
|
|
||||||
curl -sSL -o gl.tar.gz \
|
|
||||||
https://github.com/gitleaks/gitleaks/releases/download/v8.21.2/gitleaks_8.21.2_linux_x64.tar.gz
|
|
||||||
tar xzf gl.tar.gz gitleaks
|
|
||||||
chmod +x gitleaks
|
|
||||||
./gitleaks version
|
|
||||||
|
|
||||||
- name: scan
|
|
||||||
run: |
|
|
||||||
./gitleaks detect --source . --no-banner --redact --verbose
|
|
||||||
666
LICENSE
666
LICENSE
|
|
@ -1,661 +1,9 @@
|
||||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
torttube is licensed under the GNU General Public License version 3 or
|
||||||
Version 3, 19 November 2007
|
(at your option) any later version. SPDX-License-Identifier: GPL-3.0-or-later.
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
The full text of the GPL-3.0 is available at
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
https://www.gnu.org/licenses/gpl-3.0.txt and will be bundled with the
|
||||||
of this license document, but changing it is not allowed.
|
addon.zip release artifact. This file is a pointer placeholder for the
|
||||||
|
in-repo development tree.
|
||||||
|
|
||||||
Preamble
|
Copyright (C) 2026 Sulkta and contributors.
|
||||||
|
|
||||||
The GNU Affero General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works, specifically designed to ensure
|
|
||||||
cooperation with the community in the case of network server software.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
our General Public Licenses are intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights
|
|
||||||
with two steps: (1) assert copyright on the software, and (2) offer
|
|
||||||
you this License which gives you legal permission to copy, distribute
|
|
||||||
and/or modify the software.
|
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that
|
|
||||||
improvements made in alternate versions of the program, if they
|
|
||||||
receive widespread use, become available for other developers to
|
|
||||||
incorporate. Many developers of free software are heartened and
|
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
|
||||||
software used on network servers, this result may fail to come about.
|
|
||||||
The GNU General Public License permits making a modified version and
|
|
||||||
letting the public access it on a server without ever releasing its
|
|
||||||
source code to the public.
|
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
|
||||||
ensure that, in such cases, the modified source code becomes available
|
|
||||||
to the community. It requires the operator of a network server to
|
|
||||||
provide the source code of the modified version running there to the
|
|
||||||
users of that server. Therefore, public use of a modified version, on
|
|
||||||
a publicly accessible server, gives the public access to the source
|
|
||||||
code of the modified version.
|
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
|
||||||
released a new version of the Affero GPL which permits relicensing under
|
|
||||||
this license.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, if you modify the
|
|
||||||
Program, your modified version must prominently offer all users
|
|
||||||
interacting with it remotely through a computer network (if your version
|
|
||||||
supports such interaction) an opportunity to receive the Corresponding
|
|
||||||
Source of your version by providing access to the Corresponding Source
|
|
||||||
from a network server at no charge, through some standard or customary
|
|
||||||
means of facilitating copying of software. This Corresponding Source
|
|
||||||
shall include the Corresponding Source for any work covered by version 3
|
|
||||||
of the GNU General Public License that is incorporated pursuant to the
|
|
||||||
following paragraph.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the work with which it is combined will remain governed by version
|
|
||||||
3 of the GNU General Public License.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU Affero General Public License from time to time. Such new versions
|
|
||||||
will be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU Affero General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU Affero General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU Affero General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
<one line to give the program's name and a brief idea of what it does.>
|
|
||||||
Copyright (C) <year> <name of author>
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU Affero General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU Affero General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU Affero General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If your software can interact with users remotely through a computer
|
|
||||||
network, you should also make sure that it provides a way for users to
|
|
||||||
get its source. For example, if your program is a web application, its
|
|
||||||
interface could display a "Source" link that leads users to an archive
|
|
||||||
of the code. There are many ways you could offer source, and different
|
|
||||||
solutions will be better for different programs; see section 13 for the
|
|
||||||
specific requirements.
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
## M0 — Scaffold [current]
|
## M0 — Scaffold [current]
|
||||||
|
|
||||||
- [x] repository scaffolded
|
- [x] `Sulkta/torttube`
|
||||||
- [x] Layout: `addon/` (Python) + `sidecar/` (Rust workspace)
|
- [x] Layout: `addon/` (Python) + `sidecar/` (Rust workspace)
|
||||||
- [x] GPL-3.0 license headers
|
- [x] GPL-3.0 license headers
|
||||||
- [ ] the build container produces a static aarch64 sidecar binary
|
- [ ] the build container produces a static aarch64 sidecar binary
|
||||||
|
|
@ -31,7 +31,7 @@
|
||||||
`?url=<full-url>` — wired so JSON-RPC `Player.Open` from any LAN client
|
`?url=<full-url>` — wired so JSON-RPC `Player.Open` from any LAN client
|
||||||
(phone, HA, curl) triggers resolve + play. See docs/remote-control.md.
|
(phone, HA, curl) triggers resolve + play. See docs/remote-control.md.
|
||||||
- [ ] cross-compile sidecar for aarch64, drop into `bin/` of addon dir
|
- [ ] cross-compile sidecar for aarch64, drop into `bin/` of addon dir
|
||||||
- [ ] install + smoke on a LibreELEC RPi on the LAN
|
- [ ] install + smoke on LibreELEC RPi at `kodi-host`
|
||||||
- [ ] (later) hardcoded list of 3 test videos for in-Kodi navigation
|
- [ ] (later) hardcoded list of 3 test videos for in-Kodi navigation
|
||||||
|
|
||||||
## M4 — search + channel browse [PARTIAL]
|
## M4 — search + channel browse [PARTIAL]
|
||||||
|
|
@ -73,9 +73,9 @@
|
||||||
aarch64 dynamic loader doesn't exist; Python zipapp runs on
|
aarch64 dynamic loader doesn't exist; Python zipapp runs on
|
||||||
`/usr/bin/python3` which is always there).
|
`/usr/bin/python3` which is always there).
|
||||||
- [x] zip layout matches Kodi "install from zip" expectations
|
- [x] zip layout matches Kodi "install from zip" expectations
|
||||||
- [x] addon.zip dropped at `dist/` under the repo root
|
- [x] addon.zip dropped at `smb://fileserver/downloads/torttube/`
|
||||||
- [x] install + smoke recipe documented at `docs/install.md`
|
- [x] install + smoke recipe documented at `docs/install.md`
|
||||||
- [x] **installed on a LibreELEC Pi** via SSH +
|
- [x] **installed on a LibreELEC Pi** (`kodi-host`) via SSH +
|
||||||
`systemctl restart kodi` + `Addons.SetAddonEnabled`
|
`systemctl restart kodi` + `Addons.SetAddonEnabled`
|
||||||
- [x] **JSON-RPC `Player.Open` smoke verified** — Rick Astley played
|
- [x] **JSON-RPC `Player.Open` smoke verified** — Rick Astley played
|
||||||
end-to-end with audio + video synced (yt-dlp `-f best[ext=mp4]/best`
|
end-to-end with audio + video synced (yt-dlp `-f best[ext=mp4]/best`
|
||||||
|
|
@ -103,8 +103,8 @@ Our delegation:
|
||||||
on the `tv_unplugged` client — succeeds on the next client without
|
on the `tv_unplugged` client — succeeds on the next client without
|
||||||
needing the user to link an account
|
needing the user to link an account
|
||||||
|
|
||||||
Verified live on a LibreELEC Pi 2026-05-23 — 1080p H.264 with synced
|
Verified live on a LibreELEC Pi 2026-05-23 — LTT 'Trump Phone' video
|
||||||
audio, fullscreen.
|
played at 1080p with audio, fullscreen.
|
||||||
|
|
||||||
Settings: `prefer_pv_youtube` (default true). Disable to fall through
|
Settings: `prefer_pv_youtube` (default true). Disable to fall through
|
||||||
to our native DASH/progressive paths.
|
to our native DASH/progressive paths.
|
||||||
|
|
|
||||||
169
README.md
169
README.md
|
|
@ -1,135 +1,82 @@
|
||||||
# torttube
|
# torttube
|
||||||
|
|
||||||
A [Kodi](https://kodi.tv/) add-on that browses, searches, and plays YouTube
|
Kodi addon for YouTube via [RustyPipe](https://codeberg.org/ThetaDev/rustypipe)
|
||||||
videos **without a YouTube account**, with automatic
|
extraction + [SponsorBlock](https://sponsor.ajay.app/) segment skipping.
|
||||||
[SponsorBlock](https://sponsor.ajay.app/) skipping. It pairs a small Python
|
|
||||||
plugin UI with a native Rust sidecar that does the heavy lifting (metadata,
|
|
||||||
stream resolution, SponsorBlock lookups).
|
|
||||||
|
|
||||||
> **Project status:** torttube is feature-complete but no longer under active
|
Replaces the dead `plugin.video.youtube` on LibreELEC RPi TVs after Google
|
||||||
> development. For everyday use on a stock Kodi box you are probably better
|
required account-linking for the upstream addon.
|
||||||
> served by the mature upstream add-ons it ended up leaning on:
|
|
||||||
> [`plugin.video.youtube`](https://github.com/anxdpanic/plugin.video.youtube)
|
|
||||||
> for playback and
|
|
||||||
> [`script.service.sponsorblock`](https://github.com/siku2/script.service.sponsorblock)
|
|
||||||
> for SponsorBlock skipping across *all* YouTube playback. torttube remains a
|
|
||||||
> compact, hackable reference for a Rust-sidecar + Python-plugin Kodi add-on.
|
|
||||||
|
|
||||||
## What it does
|
|
||||||
|
|
||||||
- **Browse & search** YouTube from the Kodi UI — search, channels, playlists,
|
|
||||||
per-user subscriptions and a "Watch Later" list, all account-free and curated
|
|
||||||
by you (no recommendation algorithm).
|
|
||||||
- **Play any video** by ID or URL, including over Kodi's JSON-RPC API so a
|
|
||||||
phone, Home Assistant, or a `curl` one-liner can "send to TV".
|
|
||||||
- **Skip SponsorBlock segments** automatically during playback (sponsor,
|
|
||||||
self-promo and interaction reminders by default).
|
|
||||||
- **Account-free extraction** via a native Rust sidecar (RustyPipe) with a
|
|
||||||
`yt-dlp` fallback, and optional delegation to `plugin.video.youtube` for
|
|
||||||
high-definition DASH playback.
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
```
|
```
|
||||||
addon/plugin.video.torttube/ Python Kodi plugin (UI, routing, SponsorBlock service)
|
Kodi (LibreELEC, RPi)
|
||||||
sidecar/ Rust workspace — the torttube-sidecar binary
|
└── plugin.video.torttube [Python addon — UI, browse, SponsorBlock]
|
||||||
|
├── torttube-sidecar [Rust binary — JSON-over-stdio]
|
||||||
|
│ ├── rustypipe [Native Rust Innertube for browse]
|
||||||
|
│ ├── yt-dlp subprocess [Fallback resolve]
|
||||||
|
│ └── sponsorblock [REST client, SHA-256 prefix lookup]
|
||||||
|
└── plugin.video.youtube [DEPENDENCY — handles HD playback]
|
||||||
|
└── inputstream.adaptive [DASH demux + decode]
|
||||||
```
|
```
|
||||||
|
|
||||||
The plugin talks to the sidecar over a simple JSON-over-stdio protocol. Stream
|
`plugin.video.youtube` is declared as a Kodi addon dependency in
|
||||||
resolution is three-tier:
|
[addon.xml](addon/plugin.video.torttube/addon.xml). When a user installs
|
||||||
|
torttube, Kodi auto-fetches pv.youtube from the official Kodi addon
|
||||||
|
repository — user only manages torttube; the dep is transparent.
|
||||||
|
|
||||||
1. **RustyPipe** (native Rust InnerTube client) — fast metadata + stream URLs.
|
torttube does what it's faster at: rustypipe-backed search/channel/playlist
|
||||||
2. **`yt-dlp`** subprocess fallback when tier 1 can't resolve a video.
|
browse, SponsorBlock auto-skip via a tight `xbmc.Player()` monitor loop,
|
||||||
3. **`rip`** — last-resort download-to-temp for streams that die mid-play.
|
JSON-RPC remote-control for share-to-TV. Playback hands off to
|
||||||
|
pv.youtube via `plugin://plugin.video.youtube/play/?video_id=<id>` —
|
||||||
|
they've spent years getting the DASH-MPD + multi-client Innertube
|
||||||
|
fallback right. Our SponsorBlock monitor runs in parallel because
|
||||||
|
`xbmc.Player()` is a global accessor that works regardless of which
|
||||||
|
addon initiated playback.
|
||||||
|
|
||||||
For HD playback the add-on can delegate to `plugin.video.youtube`, which has a
|
Kodi addons are Python — the engine layer (n-param sig decoding, Innertube,
|
||||||
mature DASH manifest builder; torttube layers its account-free browse UI and
|
SponsorBlock hashing) lives in a Rust sidecar so we get a single maintained
|
||||||
SponsorBlock skipping on top. A SponsorBlock service component (`service.py`)
|
extraction surface and clean aarch64/armv7 cross-compiles.
|
||||||
also watches *all* YouTube playback in Kodi — including videos cast from a
|
|
||||||
phone — and skips segments globally.
|
|
||||||
|
|
||||||
## Requirements
|
**Three-tier resolve** because YouTube actively fights every extractor:
|
||||||
|
|
||||||
- Kodi 20 (Nexus) or newer (`xbmc.python` 3.0.0).
|
1. **rustypipe (Rust)** — preferred. Fast, in-process, no Python dep on the RPi.
|
||||||
- `inputstream.adaptive` (optional, for DASH playback).
|
2. **yt-dlp subprocess** — fallback when rustypipe sig-decoding falls behind YouTube's deobfuscator changes. yt-dlp updates weekly; we shell out, parse `-j` JSON.
|
||||||
- A target device that can run the sidecar binary (the build targets
|
3. **Rip-to-temp** — last resort when stream URLs 403 mid-playback (poToken expiry, cookie session mismatch). yt-dlp downloads to `/storage/.kodi/temp/torttube/<id>.<ext>`, Kodi plays the local file. Temp dir has size cap + age cleanup.
|
||||||
`aarch64`; see below).
|
|
||||||
|
|
||||||
## Build
|
## Status
|
||||||
|
|
||||||
The add-on ships as a single installable zip containing the Python plugin, a
|
M0 scaffold. Nothing playable yet — see [MILESTONES.md](MILESTONES.md).
|
||||||
statically-linked sidecar binary, and `yt-dlp`'s universal Python zipapp:
|
|
||||||
|
|
||||||
```bash
|
## Upstream — we fight with the FOSS extractor ecosystem, not next to it
|
||||||
bash scripts/build-addon-zip.sh
|
|
||||||
# → dist/plugin.video.torttube-<version>.zip
|
|
||||||
```
|
|
||||||
|
|
||||||
The script cross-compiles the sidecar for `aarch64-musl` in a throwaway
|
YouTube's anti-scraping changes hit every extractor: NewPipe, yt-dlp, Invidious,
|
||||||
`messense/rust-musl-cross` container (so no host Rust toolchain is required,
|
rustypipe. Every fix we make in our sidecar gets evaluated for "is this
|
||||||
only Docker), fetches the `yt-dlp` zipapp, and packages everything into the
|
upstreamable?" — if yes, the fix lands at the upstream project, not just here.
|
||||||
Kodi "install from zip" layout. Override `DEST_DIR=...` to land the zip
|
|
||||||
elsewhere. Requirements: `docker`, `zip`, `curl`.
|
|
||||||
|
|
||||||
## Install
|
Active lanes:
|
||||||
|
|
||||||
In Kodi: **Settings → Add-ons → Install from zip file**, then pick the built
|
- **rustypipe** (Rust, codeberg.org/ThetaDev/rustypipe) — maintenance has slowed.
|
||||||
zip. Unsigned add-ons require **Settings → System → Add-ons → Unknown sources**
|
Open PR #77 "Some fixes" is unmerged as of 2026-05-23. We will either help land
|
||||||
to be enabled. If you opt into delegated playback, Kodi will pull
|
it (review + ping maintainer) or fork to `your own fork` if upstream
|
||||||
`plugin.video.youtube` from the official repository.
|
stays quiet. Forking is the worst case, not the first move.
|
||||||
|
- **NewPipeExtractor** (Java, github.com/TeamNewPipe/NewPipeExtractor) — actively
|
||||||
|
maintained, 177 open issues. We use it as the reference implementation for
|
||||||
|
Innertube behaviour. PRs to NPE land in Rust here via rustypipe, and vice
|
||||||
|
versa.
|
||||||
|
- **yt-dlp** (Python, github.com/yt-dlp/yt-dlp) — the gold standard. We're more
|
||||||
|
consumers than contributors here, but if our rip-to-temp tier surfaces a
|
||||||
|
specific extractor bug we file it.
|
||||||
|
|
||||||
A headless install over SSH + JSON-RPC is documented in
|
Issues we're watching:
|
||||||
[`docs/install.md`](docs/install.md).
|
- [NPE #1339](https://github.com/TeamNewPipe/NewPipeExtractor/issues/1339) — n-parameter deobfuscation
|
||||||
|
- [NPE #1444](https://github.com/TeamNewPipe/NewPipeExtractor/issues/1444) — distinguish unavailable vs unextractable
|
||||||
|
- [NPE #1360](https://github.com/TeamNewPipe/NewPipeExtractor/issues/1360) — refactor link handlers (help wanted)
|
||||||
|
- [NPE #1357](https://github.com/TeamNewPipe/NewPipeExtractor/issues/1357) — JDoc checks in PR pipeline (good first issue)
|
||||||
|
- [rustypipe PR #77](https://codeberg.org/ThetaDev/rustypipe/pulls/77) — open as of 2026-05-23, unmerged
|
||||||
|
|
||||||
## Usage
|
Contribution log lives at [docs/upstream.md](docs/upstream.md) — every PR we
|
||||||
|
file lands there with its outcome.
|
||||||
Open the add-on under **Video add-ons** and use Search / Channels /
|
|
||||||
Subscriptions / Watch Later from the root menu.
|
|
||||||
|
|
||||||
To start playback from another device on the network, POST to Kodi's JSON-RPC
|
|
||||||
endpoint (enable the HTTP control server + a password under
|
|
||||||
**Settings → Services → Control** first):
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -u kodi:<pw> -H "Content-Type: application/json" \
|
|
||||||
-X POST http://<kodi-host>:8080/jsonrpc -d '{
|
|
||||||
"jsonrpc": "2.0", "id": 1, "method": "Player.Open",
|
|
||||||
"params": {"item": {"file":
|
|
||||||
"plugin://plugin.video.torttube/?action=play&id=dQw4w9WgXcQ"}}}'
|
|
||||||
```
|
|
||||||
|
|
||||||
The add-on accepts a bare 11-character ID or any `youtube.com` / `youtu.be` /
|
|
||||||
`shorts` / `embed` / `live` URL. See
|
|
||||||
[`docs/remote-control.md`](docs/remote-control.md) for the full JSON-RPC recipe.
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Add-on settings (**Settings → Add-on settings → torttube**):
|
|
||||||
|
|
||||||
- **Use plugin.video.youtube for playback (HD)** — delegate playback to
|
|
||||||
`plugin.video.youtube` for proper DASH/HD (default on).
|
|
||||||
- **Native DASH (WIP)** — experimental in-add-on DASH manifest path, used when
|
|
||||||
`plugin.video.youtube` is absent (default off).
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Contributions are welcome. The add-on intentionally leans on the wider FOSS
|
|
||||||
ecosystem — when a bug traces back to an upstream project (RustyPipe,
|
|
||||||
NewPipeExtractor, `yt-dlp`), the fix should land there first. Please keep the
|
|
||||||
Python plugin dependency-free (Kodi modules + stdlib only) and the sidecar's
|
|
||||||
JSON-over-stdio protocol stable. See [`docs/upstream.md`](docs/upstream.md) for
|
|
||||||
the upstream-contribution log and [`MILESTONES.md`](MILESTONES.md) for the
|
|
||||||
development history.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
AGPL-3.0-or-later. See [`LICENSE`](LICENSE).
|
GPL-3.0-or-later. Matches RustyPipe and NewPipeExtractor.
|
||||||
|
|
||||||
### Acknowledgements
|
|
||||||
|
|
||||||
torttube stands on the shoulders of
|
|
||||||
[RustyPipe](https://codeberg.org/ThetaDev/rustypipe),
|
|
||||||
[NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor),
|
|
||||||
[`yt-dlp`](https://github.com/yt-dlp/yt-dlp),
|
|
||||||
[SponsorBlock](https://sponsor.ajay.app/), and
|
|
||||||
[`plugin.video.youtube`](https://github.com/anxdpanic/plugin.video.youtube).
|
|
||||||
|
|
|
||||||
|
|
@ -5,24 +5,27 @@ contains the Python addon, a static aarch64 sidecar binary, and yt-dlp's
|
||||||
aarch64 release binary (for Tier 2/3 fallback). Nothing else needs to be
|
aarch64 release binary (for Tier 2/3 fallback). Nothing else needs to be
|
||||||
installed on the Pi.
|
installed on the Pi.
|
||||||
|
|
||||||
## Build the zip
|
## Build the zip (Sulkta-internal)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bash scripts/build-addon-zip.sh
|
bash scripts/build-addon-zip.sh
|
||||||
# → dist/plugin.video.torttube-<version>.zip
|
# → /srv/downloads/torttube/plugin.video.torttube-0.0.1.zip on the build host
|
||||||
```
|
```
|
||||||
|
|
||||||
The script cross-compiles the sidecar in a throwaway
|
The script cross-compiles the sidecar in a throwaway
|
||||||
`messense/rust-musl-cross:aarch64-musl` container, fetches yt-dlp's
|
`messense/rust-musl-cross:aarch64-musl` container, fetches yt-dlp's
|
||||||
universal Python zipapp, and drops the result at `dist/` under the
|
official `yt-dlp_linux_aarch64` release binary, packages everything,
|
||||||
repo root. Override `DEST_DIR=...` to land it elsewhere.
|
drops the result at `/srv/downloads/torttube/` (file share).
|
||||||
|
|
||||||
## Install on the Pi (Kodi UI flow)
|
## Install on the Pi (Kodi UI flow)
|
||||||
|
|
||||||
1. Copy the zip onto the Pi (SMB share, scp, USB stick — anything).
|
1. On the Pi: Settings → File manager → Add source → enter
|
||||||
2. Settings → Add-ons → Install from zip file → pick the zip.
|
`smb://fileserver/downloads/` → name it `downloads`.
|
||||||
3. Kodi installs torttube and pulls `plugin.video.youtube` from the
|
2. Settings → Add-ons → Install from zip file → `downloads` →
|
||||||
official Kodi repo (declared as a dep in addon.xml).
|
`torttube/plugin.video.torttube-<version>.zip`.
|
||||||
|
3. Kodi installs torttube **and automatically installs
|
||||||
|
`plugin.video.youtube`** from the official Kodi repo because it's
|
||||||
|
declared as a dep in our addon.xml. No separate install step needed.
|
||||||
4. The addon appears under Video add-ons.
|
4. The addon appears under Video add-ons.
|
||||||
|
|
||||||
Unsigned addons need `Settings → System → Add-ons → Unknown sources` ON.
|
Unsigned addons need `Settings → System → Add-ons → Unknown sources` ON.
|
||||||
|
|
@ -38,7 +41,7 @@ ssh kodi-host 'cd /storage/.kodi/addons && unzip -o /tmp/plugin.video.torttube-0
|
||||||
ssh kodi-host 'systemctl restart kodi'
|
ssh kodi-host 'systemctl restart kodi'
|
||||||
|
|
||||||
# wait ~5s for Kodi to come back, then enable the addon
|
# wait ~5s for Kodi to come back, then enable the addon
|
||||||
curl -u kodi:<pw> -H "Content-Type: application/json" -X POST http://kodi-host:8080/jsonrpc \
|
curl -u kodi:<pw> -H "Content-Type: application/json" -X POST http://<kodi-host>:8080/jsonrpc \
|
||||||
-d '{"jsonrpc":"2.0","id":1,"method":"Addons.SetAddonEnabled","params":{"addonid":"plugin.video.torttube","enabled":true}}'
|
-d '{"jsonrpc":"2.0","id":1,"method":"Addons.SetAddonEnabled","params":{"addonid":"plugin.video.torttube","enabled":true}}'
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -79,6 +82,6 @@ few seconds (rustypipe resolve takes ~1s, then Kodi starts the stream).
|
||||||
|
|
||||||
## Updating
|
## Updating
|
||||||
|
|
||||||
Bump the version in `addon/plugin.video.torttube/addon.xml`, re-run
|
Just rebuild + bump the version in `addon/plugin.video.torttube/addon.xml`,
|
||||||
`build-addon-zip.sh`, install the new zip. Kodi treats it as an
|
re-run `build-addon-zip.sh`, install the new zip from the same SMB
|
||||||
upgrade if the version is higher.
|
location. Kodi will treat it as an upgrade if the version is higher.
|
||||||
|
|
|
||||||
|
|
@ -7,14 +7,13 @@ out of the box once the addon is installed.
|
||||||
## Endpoint
|
## Endpoint
|
||||||
|
|
||||||
```
|
```
|
||||||
POST http://<kodi-host>:8080/jsonrpc
|
POST http://<rpi-host>:8080/jsonrpc
|
||||||
Authorization: Basic base64(kodi:<password>)
|
Authorization: Basic base64(kodi:<password>)
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
```
|
```
|
||||||
|
|
||||||
Default Kodi user is `kodi`. The HTTP-control web server and a
|
Example defaults: `http://kodi-host:8080`, user
|
||||||
password must be enabled via `Settings → Services → Control` before
|
`kodi`, password `<password>`.
|
||||||
JSON-RPC works.
|
|
||||||
|
|
||||||
## Play by YouTube ID
|
## Play by YouTube ID
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,34 +1,30 @@
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
# Build addon.zip for torttube.
|
# Build addon.zip for torttube — runs from a host with SSH access to the build host.
|
||||||
#
|
#
|
||||||
# Cross-compiles the sidecar via messense/rust-musl-cross:aarch64-musl
|
# Cross-compiles the sidecar via messense/rust-musl-cross:aarch64-musl
|
||||||
# (one-shot docker container, no host toolchain mutation), bundles
|
# (one-shot container, no host-toolchain mutation), bundles yt-dlp's
|
||||||
# yt-dlp's universal Python zipapp, packages with the Kodi addon dir
|
# aarch64 release binary, packages with the Kodi addon dir layout, and
|
||||||
# layout, and drops the zip in dist/ at the repo root.
|
# drops the zip at /srv/downloads/torttube/ on the build host.
|
||||||
#
|
#
|
||||||
# Usage: bash scripts/build-addon-zip.sh
|
# Usage: bash scripts/build-addon-zip.sh
|
||||||
#
|
#
|
||||||
# Requirements: docker, zip, curl. Runs from any clone of the repo.
|
# Expected: ssh alias "build-host" works (per your SSH config), and the
|
||||||
|
# torttube source is at /build/torttube/
|
||||||
|
# on the build host (rsync first if you're iterating locally).
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
VERSION="${VERSION:-0.0.1}"
|
VERSION="${VERSION:-0.0.1}"
|
||||||
|
SRC=/build/torttube
|
||||||
# Resolve repo root from script location — works from any clone path.
|
CARGO_HOME_CACHE=/build/.cargo-aarch64
|
||||||
REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
TARGET_DIR=/build/.aarch64-target
|
||||||
SRC="${REPO_ROOT}"
|
STAGE=/tmp/torttube-stage
|
||||||
CARGO_HOME_CACHE="${REPO_ROOT}/.cargo-aarch64"
|
DEST_DIR=/srv/downloads/torttube
|
||||||
TARGET_DIR="${REPO_ROOT}/.aarch64-target"
|
|
||||||
STAGE="$(mktemp -d -t torttube-stage.XXXXXX)"
|
|
||||||
DEST_DIR="${DEST_DIR:-${REPO_ROOT}/dist}"
|
|
||||||
trap 'rm -rf "$STAGE"' EXIT
|
|
||||||
|
|
||||||
mkdir -p "$CARGO_HOME_CACHE" "$TARGET_DIR" "$DEST_DIR"
|
|
||||||
|
|
||||||
echo ">>> Cross-compile sidecar for aarch64-musl"
|
echo ">>> Cross-compile sidecar for aarch64-musl"
|
||||||
docker run --rm \
|
ssh build-host "docker run --rm \
|
||||||
-v "$SRC/sidecar":/src \
|
-v $SRC/sidecar:/src \
|
||||||
-v "$CARGO_HOME_CACHE":/cargo-home \
|
-v $CARGO_HOME_CACHE:/cargo-home \
|
||||||
-v "$TARGET_DIR":/target \
|
-v $TARGET_DIR:/target \
|
||||||
-e PATH=/root/.cargo/bin:/usr/local/musl/bin:/usr/local/bin:/usr/bin:/bin \
|
-e PATH=/root/.cargo/bin:/usr/local/musl/bin:/usr/local/bin:/usr/bin:/bin \
|
||||||
-e CARGO_HOME=/cargo-home \
|
-e CARGO_HOME=/cargo-home \
|
||||||
-e CARGO_TARGET_DIR=/target \
|
-e CARGO_TARGET_DIR=/target \
|
||||||
|
|
@ -36,29 +32,29 @@ docker run --rm \
|
||||||
-e CC_aarch64_unknown_linux_musl=aarch64-unknown-linux-musl-gcc \
|
-e CC_aarch64_unknown_linux_musl=aarch64-unknown-linux-musl-gcc \
|
||||||
-w /src \
|
-w /src \
|
||||||
messense/rust-musl-cross:aarch64-musl \
|
messense/rust-musl-cross:aarch64-musl \
|
||||||
cargo build --release
|
cargo build --release"
|
||||||
|
|
||||||
echo ">>> Stage addon tree"
|
echo ">>> Stage addon tree"
|
||||||
mkdir -p "$STAGE/plugin.video.torttube/bin"
|
ssh build-host "rm -rf $STAGE && mkdir -p $STAGE/plugin.video.torttube/bin"
|
||||||
rsync -a "$SRC/addon/plugin.video.torttube/" "$STAGE/plugin.video.torttube/" --exclude bin
|
ssh build-host "rsync -a $SRC/addon/plugin.video.torttube/ $STAGE/plugin.video.torttube/ --exclude bin"
|
||||||
cp "$TARGET_DIR/aarch64-unknown-linux-musl/release/torttube-sidecar" \
|
ssh build-host "cp $TARGET_DIR/aarch64-unknown-linux-musl/release/torttube-sidecar $STAGE/plugin.video.torttube/bin/"
|
||||||
"$STAGE/plugin.video.torttube/bin/"
|
|
||||||
|
|
||||||
echo ">>> Fetch yt-dlp universal Python zipapp"
|
echo ">>> Fetch yt-dlp universal Python zipapp"
|
||||||
# Pure-Python zipapp runs on any Python 3.9+ — works around LibreELEC's
|
# Pure-Python zipapp runs on any Python 3.9+ — works around LibreELEC's
|
||||||
# armhf userspace (where yt-dlp's dynamic aarch64 binary can't find
|
# armhf userspace (where yt-dlp's dynamic aarch64 binary can't find
|
||||||
# ld-linux-aarch64.so.1). Kodi 20 ships Python 3.11.
|
# ld-linux-aarch64.so.1). Kodi 20 ships Python 3.11.
|
||||||
curl -sSL -o "$STAGE/plugin.video.torttube/bin/yt-dlp" \
|
ssh build-host "curl -sSL -o $STAGE/plugin.video.torttube/bin/yt-dlp \
|
||||||
https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp
|
https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp"
|
||||||
chmod +x "$STAGE/plugin.video.torttube/bin/"*
|
ssh build-host "chmod +x $STAGE/plugin.video.torttube/bin/*"
|
||||||
|
|
||||||
echo ">>> Build addon.zip"
|
echo ">>> Build addon.zip"
|
||||||
( cd "$STAGE" && \
|
ssh build-host "cd $STAGE && rm -f plugin.video.torttube.zip && \
|
||||||
rm -f plugin.video.torttube.zip && \
|
zip -r plugin.video.torttube.zip plugin.video.torttube/ -x '*.DS_Store' > /dev/null"
|
||||||
zip -r plugin.video.torttube.zip plugin.video.torttube/ -x '*.DS_Store' > /dev/null )
|
|
||||||
|
|
||||||
OUT="$DEST_DIR/plugin.video.torttube-$VERSION.zip"
|
echo ">>> Drop at $DEST_DIR/plugin.video.torttube-$VERSION.zip"
|
||||||
cp "$STAGE/plugin.video.torttube.zip" "$OUT"
|
ssh build-host "mkdir -p $DEST_DIR && cp $STAGE/plugin.video.torttube.zip \
|
||||||
ls -la "$DEST_DIR/"
|
$DEST_DIR/plugin.video.torttube-$VERSION.zip"
|
||||||
echo ">>> done — $OUT"
|
|
||||||
echo " Install via Kodi: Settings > Add-ons > Install from zip"
|
ssh build-host "ls -la $DEST_DIR/"
|
||||||
|
echo ">>> done — install via Kodi: Settings > Add-ons > Install from zip"
|
||||||
|
echo " SMB path: smb://fileserver/downloads/torttube/plugin.video.torttube-$VERSION.zip"
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ members = ["crates/torttube-sidecar"]
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
version = "1.0.4"
|
version = "1.0.4"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
license = "AGPL-3.0-or-later"
|
license = "GPL-3.0-or-later"
|
||||||
authors = ["Sulkta <oss@sulkta.com>"]
|
authors = ["Sulkta <oss@sulkta.com>"]
|
||||||
repository = "https://github.com/Sulkta/torttube"
|
repository = "https://github.com/Sulkta/torttube"
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ serde_json = "1"
|
||||||
|
|
||||||
# Errors + logging
|
# Errors + logging
|
||||||
anyhow = "1"
|
anyhow = "1"
|
||||||
thiserror = "2"
|
thiserror = "1"
|
||||||
tracing = "0.1"
|
tracing = "0.1"
|
||||||
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
tracing-subscriber = { version = "0.3", features = ["env-filter"] }
|
||||||
|
|
||||||
|
|
|
||||||
Reference in a new issue