Compare commits
45 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
6f5dc01876 |
|||
|
|
f912f491e2 |
||
|
|
13d5c3c75e | ||
|
|
105cbaffb6 |
||
|
|
bf767ad808 | ||
|
|
ba5cc801c5 | ||
|
|
82b4160655 |
||
|
|
9c5660deeb | ||
|
|
e6c900f4ce | ||
|
|
563b855e36 | ||
|
|
8ca4213bed |
||
|
|
0b2eb1867a | ||
|
|
f6d820c323 | ||
|
|
a0d4300fa0 | ||
|
|
e929080078 | ||
|
|
a94d624af9 | ||
|
|
03998f1fd8 | ||
|
|
901832249d | ||
|
|
8df79a7046 | ||
|
|
c92da61d6f | ||
|
|
9c1debf509 | ||
|
|
66572fce7b | ||
|
|
9858b40cd6 | ||
|
|
eb1f02f805 |
||
|
|
fe03c9d127 | ||
|
|
90d3d652b1 | ||
|
|
34ff249281 | ||
|
|
09816e5b27 |
||
|
|
c7dba4f844 | ||
|
|
bcc4100f5d | ||
|
|
559f4fe08e | ||
|
|
08e8b9517e |
||
|
|
2c3cb32c86 | ||
|
|
e0f09486c7 | ||
|
|
8e634094a3 | ||
|
|
08debc45a7 | ||
|
|
f7247ea23a | ||
|
|
a1872f1b3a | ||
|
|
417cac095a | ||
|
|
f083d0ddf7 | ||
|
|
156834bae2 | ||
|
|
b6222547e2 |
||
|
|
53720d7031 |
||
|
|
f0fb185370 | ||
|
|
a996b2c54d |
24 changed files with 2923 additions and 162 deletions
50
.gitignore
vendored
Normal file
50
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
lib-cov
|
||||||
|
*.seed
|
||||||
|
*.log
|
||||||
|
*.csv
|
||||||
|
*.dat
|
||||||
|
*.out
|
||||||
|
*.pid
|
||||||
|
*.gz
|
||||||
|
*.swp
|
||||||
|
|
||||||
|
pids
|
||||||
|
logs
|
||||||
|
results
|
||||||
|
tmp
|
||||||
|
|
||||||
|
# Coverage reports
|
||||||
|
coverage
|
||||||
|
|
||||||
|
# API keys and secrets
|
||||||
|
.env
|
||||||
|
|
||||||
|
# Dependency directory
|
||||||
|
node_modules
|
||||||
|
bower_components
|
||||||
|
.pnpm-store
|
||||||
|
|
||||||
|
# Editors
|
||||||
|
.idea
|
||||||
|
*.iml
|
||||||
|
|
||||||
|
# OS metadata
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# Ignore built ts files
|
||||||
|
dist/
|
||||||
|
|
||||||
|
__pycache__/
|
||||||
|
|
||||||
|
/.yalc
|
||||||
|
yalc.lock
|
||||||
|
|
||||||
|
.vscode/settings.json
|
||||||
|
|
||||||
|
# Ignore output folder
|
||||||
|
|
||||||
|
backend/out
|
||||||
|
|
||||||
|
# Make sure to ignore any instance of the loader's decky_plugin.py
|
||||||
|
decky_plugin.py
|
||||||
12
.vscode/config.sh
vendored
Executable file
12
.vscode/config.sh
vendored
Executable file
|
|
@ -0,0 +1,12 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]:-$0}"; )" &> /dev/null && pwd 2> /dev/null; )";
|
||||||
|
# printf "${SCRIPT_DIR}\n"
|
||||||
|
# printf "$(dirname $0)\n"
|
||||||
|
if ! [[ -e "${SCRIPT_DIR}/settings.json" ]]; then
|
||||||
|
printf '.vscode/settings.json does not exist. Creating it with default settings. Exiting afterwards. Run your task again.\n\n'
|
||||||
|
cp "${SCRIPT_DIR}/defsettings.json" "${SCRIPT_DIR}/settings.json"
|
||||||
|
exit 1
|
||||||
|
else
|
||||||
|
printf '.vscode/settings.json does exist. Congrats.\n'
|
||||||
|
printf 'Make sure to change settings.json to match your deck.\n'
|
||||||
|
fi
|
||||||
10
.vscode/defsettings.json
vendored
Executable file
10
.vscode/defsettings.json
vendored
Executable file
|
|
@ -0,0 +1,10 @@
|
||||||
|
{
|
||||||
|
"deckip" : "0.0.0.0",
|
||||||
|
"deckport" : "22",
|
||||||
|
"deckpass" : "ssap",
|
||||||
|
"deckkey" : "-i ${env:HOME}/.ssh/id_rsa",
|
||||||
|
"deckdir" : "/home/deck",
|
||||||
|
"python.analysis.extraPaths": [
|
||||||
|
"./py_modules"
|
||||||
|
]
|
||||||
|
}
|
||||||
116
.vscode/tasks.json
vendored
Executable file
116
.vscode/tasks.json
vendored
Executable file
|
|
@ -0,0 +1,116 @@
|
||||||
|
{
|
||||||
|
"version": "2.0.0",
|
||||||
|
"tasks": [
|
||||||
|
// OTHER
|
||||||
|
{
|
||||||
|
"label": "checkforsettings",
|
||||||
|
"type": "shell",
|
||||||
|
"group": "none",
|
||||||
|
"detail": "Check that settings.json has been created",
|
||||||
|
"command": "bash -c ${workspaceFolder}/.vscode/config.sh",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
// BUILD
|
||||||
|
{
|
||||||
|
"label": "pnpmsetup",
|
||||||
|
"type": "shell",
|
||||||
|
"group": "build",
|
||||||
|
"detail": "Setup pnpm",
|
||||||
|
"command": "pnpm i",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "updatefrontendlib",
|
||||||
|
"type": "shell",
|
||||||
|
"group": "build",
|
||||||
|
"detail": "Update deck-frontend-lib",
|
||||||
|
"command": "pnpm update decky-frontend-lib --latest",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "build",
|
||||||
|
"type": "npm",
|
||||||
|
"group": "build",
|
||||||
|
"detail": "rollup -c",
|
||||||
|
"script": "build",
|
||||||
|
"path": "",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "buildall",
|
||||||
|
"group": "build",
|
||||||
|
"detail": "Build decky-plugin-template",
|
||||||
|
"dependsOrder": "sequence",
|
||||||
|
"dependsOn": [
|
||||||
|
"pnpmsetup",
|
||||||
|
"build"
|
||||||
|
],
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
// DEPLOY
|
||||||
|
{
|
||||||
|
"label": "createfolders",
|
||||||
|
"detail": "Create plugins folder in expected directory",
|
||||||
|
"type": "shell",
|
||||||
|
"group": "none",
|
||||||
|
"dependsOn": [
|
||||||
|
"checkforsettings"
|
||||||
|
],
|
||||||
|
"command": "ssh deck@${config:deckip} -p ${config:deckport} ${config:deckkey} 'mkdir -p ${config:deckdir}/homebrew/pluginloader && mkdir -p ${config:deckdir}/homebrew/plugins'",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "deploy",
|
||||||
|
"detail": "Deploy dev plugin to deck",
|
||||||
|
"type": "shell",
|
||||||
|
"group": "none",
|
||||||
|
"dependsOn": [
|
||||||
|
"createfolders",
|
||||||
|
"chmodfolders"
|
||||||
|
],
|
||||||
|
"command": "rsync -azp --delete --chmod=D0755,F0755 --rsh='ssh -p ${config:deckport} ${config:deckkey}' --exclude='.git/' --exclude='.github/' --exclude='.vscode/' --exclude='node_modules/' --exclude='src/' --exclude='*.log' --exclude='.gitignore' . deck@${config:deckip}:${config:deckdir}/homebrew/plugins/${workspaceFolderBasename}",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "restartloader",
|
||||||
|
"detail": "Restart the plugin loader (to load updated python code)",
|
||||||
|
"type": "shell",
|
||||||
|
"group": "none",
|
||||||
|
"dependsOn": [],
|
||||||
|
"command": "ssh deck@${config:deckip} -p ${config:deckport} ${config:deckkey} 'echo '${config:deckpass}' | sudo -S systemctl restart plugin_loader'",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "chmodfolders",
|
||||||
|
"detail": "chmods folders to prevent perms issues",
|
||||||
|
"type": "shell",
|
||||||
|
"group": "none",
|
||||||
|
"command": "ssh deck@${config:deckip} -p ${config:deckport} ${config:deckkey} 'echo '${config:deckpass}' | sudo -S chmod -R ug+rw ${config:deckdir}/homebrew/'",
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"label": "deployall",
|
||||||
|
"dependsOrder": "sequence",
|
||||||
|
"group": "none",
|
||||||
|
"dependsOn": [
|
||||||
|
"deploy",
|
||||||
|
"chmodfolders"
|
||||||
|
],
|
||||||
|
"problemMatcher": []
|
||||||
|
},
|
||||||
|
// ALL-IN-ONE
|
||||||
|
{
|
||||||
|
"label": "allinone",
|
||||||
|
"detail": "Build and deploy",
|
||||||
|
"dependsOrder": "sequence",
|
||||||
|
"group": "test",
|
||||||
|
"dependsOn": [
|
||||||
|
"buildall",
|
||||||
|
"deployall"
|
||||||
|
// Uncomment this line if you'd like your python code reloaded after deployment (this will restart Steam)
|
||||||
|
// ,"restartloader"
|
||||||
|
],
|
||||||
|
"problemMatcher": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
674
LICENSE
Normal file
674
LICENSE
Normal file
|
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is 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. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
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 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. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
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 Affero 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 special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU 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 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 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 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 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 General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU 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 the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
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 GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
15
README.md
15
README.md
|
|
@ -1,11 +1,14 @@
|
||||||
# SDH-QuickLaunch
|
> [!TIP]
|
||||||
[Steam Deck Plugin Loader](https://github.com/SteamDeckHomebrew/PluginLoader) Plugin to Quickly Launch Apps from the Steam Deck Quick Access Menu without adding them as Shortcuts
|
> This is a fork of [Quick Launch by Fisch03](https://github.com/Fisch03/SDH-QuickLaunch) that has been modified to work on [Anatase](https://anatase.org/). Since Anatase runs Steam in a Flatpak, launching other Flatpaks and apps doesn't normally work. The purpose of this fork is to replace calls to /usr/bin/flatpak to /app/bin/flatpak, which is a wrapper that allows launching other Flatpaks within Anatase's Steam package.
|
||||||
|
|
||||||

|
# SDH-QuickLaunch
|
||||||
|
[Decky Loader](https://github.com/SteamDeckHomebrew/PluginLoader) Plugin to quickly launch Apps from the Quick Access Menu without adding them as shortcuts, and add new shortcuts entirely
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## Tips
|
## Tips
|
||||||
Feel free to hide the QuickLaunch Shortcut this creates from your library, it wont affect the functionality
|
- Feel free to hide the QuickLaunch Shortcut this creates from your library, it wont affect the functionality
|
||||||
|
- To obtain a SteamGridDB API Key, login/register at [SteamGridDB](https://www.steamgriddb.com/). You can then generate an API Key [here](https://www.steamgriddb.com/profile/preferences/api)
|
||||||
|
|
||||||
## Caveats
|
## Caveats
|
||||||
- You can only have one application open at at time
|
You can only have one application open at at time
|
||||||
- Only Flatpaks are supported for now
|
|
||||||
|
|
|
||||||
167
main.py
167
main.py
|
|
@ -1,18 +1,124 @@
|
||||||
import os
|
import os, json, base64, ssl, certifi
|
||||||
|
from pathlib import Path
|
||||||
|
from json import dumps as jsonDumps
|
||||||
|
from itertools import chain
|
||||||
|
|
||||||
|
import decky_plugin
|
||||||
|
|
||||||
from subprocess import Popen, PIPE
|
from subprocess import Popen, PIPE
|
||||||
|
|
||||||
confdir = "/home/deck/.config/SDH-QuickLaunch/"
|
from urllib.error import HTTPError
|
||||||
|
from urllib.request import urlopen, Request
|
||||||
|
|
||||||
|
FLATPAK_RUNNER = "flatpak" # or explicitly: /app/bin/flatpak
|
||||||
|
HOST_RUNNER = "hrun" # or explicitly: /app/bin/hrun
|
||||||
|
|
||||||
|
confdir = os.environ["DECKY_PLUGIN_SETTINGS_DIR"]
|
||||||
|
|
||||||
|
send_buffer = []
|
||||||
|
|
||||||
|
|
||||||
|
def split_string(string):
|
||||||
|
return [
|
||||||
|
string[i : i + 1024 * 60] for i in range(0, len(string), 1024 * 60)
|
||||||
|
] # every 60KB
|
||||||
|
|
||||||
|
|
||||||
class Plugin:
|
class Plugin:
|
||||||
async def get_flatpaks(self):
|
async def get_flatpaks(self):
|
||||||
proc = Popen('flatpak list -d --app | awk \'BEGIN {FS="\\t"} {print "{\\"name\\":\\""$1"\\",\\"package\\":\\""$3"\\"},"}\\\'', stdout=PIPE, stderr=None, shell=True)
|
def list_flatpaks(cmd):
|
||||||
packages = proc.communicate()[0]
|
flatpaks = []
|
||||||
packages = packages.decode("utf-8")
|
|
||||||
packages = packages[:-2]
|
clean_env = os.environ.copy()
|
||||||
return packages
|
clean_env["LD_LIBRARY_PATH"] = ""
|
||||||
|
with Popen(cmd, stdout=PIPE, stderr=None, env=clean_env, text=True) as p:
|
||||||
|
for line in p.stdout:
|
||||||
|
if '\t' not in line:
|
||||||
|
continue
|
||||||
|
|
||||||
|
name, app_id = line.strip().split('\t', 1)
|
||||||
|
|
||||||
|
name = name.strip()
|
||||||
|
app_id = app_id.strip()
|
||||||
|
if not name or not app_id:
|
||||||
|
continue
|
||||||
|
|
||||||
|
flatpaks.append({
|
||||||
|
"id": app_id,
|
||||||
|
"name": name,
|
||||||
|
"exec": f"{FLATPAK_RUNNER} run {app_id}"
|
||||||
|
})
|
||||||
|
|
||||||
|
return flatpaks
|
||||||
|
|
||||||
|
global_flatpaks = list_flatpaks([
|
||||||
|
'flatpak', 'list', '--app', '--columns=name,application'
|
||||||
|
])
|
||||||
|
|
||||||
|
local_flatpaks = list_flatpaks([
|
||||||
|
'runuser', '-l', decky_plugin.DECKY_USER, '-c',
|
||||||
|
'flatpak list --app --columns=name,application'
|
||||||
|
])
|
||||||
|
|
||||||
|
seen = set()
|
||||||
|
unique_flatpaks = []
|
||||||
|
|
||||||
|
for flatpak in global_flatpaks + local_flatpaks:
|
||||||
|
if flatpak["id"] not in seen:
|
||||||
|
seen.add(flatpak["id"])
|
||||||
|
unique_flatpaks.append(flatpak)
|
||||||
|
|
||||||
|
sorted_items = sorted(unique_flatpaks, key=lambda x: x.get("name", "").lower())
|
||||||
|
|
||||||
|
return jsonDumps(sorted_items)
|
||||||
|
|
||||||
|
async def get_desktops(self):
|
||||||
|
packages = []
|
||||||
|
for desktopFile in chain(
|
||||||
|
Path("/usr/share/applications").glob("*.desktop"),
|
||||||
|
Path(f"{decky_plugin.DECKY_USER_HOME}/.local/share/applications/").glob("*.desktop"),
|
||||||
|
Path("/var/usrlocal/share/applications").glob("*.desktop"),
|
||||||
|
):
|
||||||
|
if not desktopFile.is_file():
|
||||||
|
continue
|
||||||
|
with open(desktopFile) as f:
|
||||||
|
package = {}
|
||||||
|
foundName = foundExec = False
|
||||||
|
for line in f:
|
||||||
|
line = line.strip()
|
||||||
|
if line.startswith("Name="):
|
||||||
|
foundName = True
|
||||||
|
package["name"] = line[5:]
|
||||||
|
elif line.startswith("Exec="):
|
||||||
|
foundExec = True
|
||||||
|
execTarget = line[5:].split(" ", 1)
|
||||||
|
decky_plugin.logger.info("- Exec path: " + str(execTarget))
|
||||||
|
runner = FLATPAK_RUNNER if execTarget[0].endswith("flatpak") else HOST_RUNNER
|
||||||
|
package["exec"] = f"{runner} {execTarget[1]}"
|
||||||
|
if foundName and foundExec:
|
||||||
|
decky_plugin.logger.info("+ Desktop app: " + package["name"])
|
||||||
|
packages.append(package)
|
||||||
|
break
|
||||||
|
|
||||||
|
return jsonDumps(packages)
|
||||||
|
|
||||||
|
async def get_DECKY_USER_HOME(self):
|
||||||
|
return decky_plugin.DECKY_USER_HOME
|
||||||
|
|
||||||
|
async def get_config(self):
|
||||||
|
with open(os.path.join(confdir, "config.json"), "r") as f:
|
||||||
|
return json.load(f)
|
||||||
|
|
||||||
|
async def set_config_value(self, key, value):
|
||||||
|
config = json.load(open(os.path.join(confdir, "config.json")))
|
||||||
|
config[key] = value
|
||||||
|
with open(os.path.join(confdir, "config.json"), "w") as f:
|
||||||
|
json.dump(config, f)
|
||||||
|
|
||||||
|
return config
|
||||||
|
|
||||||
async def get_id(self):
|
async def get_id(self):
|
||||||
with open(os.path.join(confdir,"scid.txt"), "r") as sc:
|
with open(os.path.join(confdir, "scid.txt"), "r") as sc:
|
||||||
id = sc.read()
|
id = sc.read()
|
||||||
try:
|
try:
|
||||||
id = int(id)
|
id = int(id)
|
||||||
|
|
@ -21,17 +127,56 @@ class Plugin:
|
||||||
return -1
|
return -1
|
||||||
|
|
||||||
async def set_id(self, id):
|
async def set_id(self, id):
|
||||||
with open(os.path.join(confdir,"scid.txt"), "w") as sc:
|
with open(os.path.join(confdir, "scid.txt"), "w") as sc:
|
||||||
sc.write(str(id))
|
sc.write(str(id))
|
||||||
|
|
||||||
|
async def get_req_imgb64(self, url):
|
||||||
|
global send_buffer
|
||||||
|
if len(send_buffer) != 0:
|
||||||
|
return
|
||||||
|
|
||||||
|
req = Request(url)
|
||||||
|
|
||||||
|
req.add_header("User-Agent", "SDH-QuickLaunch")
|
||||||
|
|
||||||
|
try:
|
||||||
|
content = urlopen(
|
||||||
|
req, context=ssl.create_default_context(cafile=certifi.where())
|
||||||
|
).read()
|
||||||
|
img = base64.b64encode(content).decode("ascii")
|
||||||
|
send_buffer = split_string(img)
|
||||||
|
new_chunk = send_buffer.pop(0)
|
||||||
|
return {"data": new_chunk, "is_last": len(send_buffer) == 0}
|
||||||
|
except HTTPError:
|
||||||
|
decky_plugin.logger.error("HTTPError while requesting " + url)
|
||||||
|
pass
|
||||||
|
|
||||||
|
async def receive_next_chunk(self):
|
||||||
|
global send_buffer
|
||||||
|
new_chunk = send_buffer.pop(0)
|
||||||
|
return {"data": new_chunk, "is_last": len(send_buffer) == 0}
|
||||||
|
|
||||||
async def _main(self):
|
async def _main(self):
|
||||||
|
decky_plugin.logger.info("Loading plugin")
|
||||||
|
|
||||||
try:
|
try:
|
||||||
os.mkdir(confdir)
|
os.mkdir(confdir)
|
||||||
except FileExistsError:
|
except FileExistsError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
try:
|
try:
|
||||||
sc = open(os.path.join(confdir,"scid.txt"), "x")
|
sc = open(os.path.join(confdir, "scid.txt"), "x")
|
||||||
sc.close()
|
sc.close()
|
||||||
except FileExistsError:
|
except FileExistsError:
|
||||||
pass
|
pass
|
||||||
|
try:
|
||||||
|
sc = open(os.path.join(confdir, "config.json"), "x")
|
||||||
|
sc.write("{}")
|
||||||
|
sc.close()
|
||||||
|
except FileExistsError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
decky_plugin.logger.info("Plugin loaded")
|
||||||
|
|
||||||
|
async def _unload(self):
|
||||||
|
pass
|
||||||
|
|
|
||||||
140
main_view.html
140
main_view.html
|
|
@ -1,140 +0,0 @@
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<link rel="stylesheet" href="/steam_resource/css/2.css">
|
|
||||||
<link rel="stylesheet" href="/steam_resource/css/39.css">
|
|
||||||
<link rel="stylesheet" href="/steam_resource/css/library.css">
|
|
||||||
<script src="/static/library.js"></script>
|
|
||||||
<style>
|
|
||||||
body {
|
|
||||||
margin-left: 0;
|
|
||||||
margin-right: 0;
|
|
||||||
}
|
|
||||||
#flatpaklist {
|
|
||||||
list-style-type: none;
|
|
||||||
padding: 0;
|
|
||||||
overflow-y: scroll;
|
|
||||||
height: 90%;
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
#settings {
|
|
||||||
overflow: none;
|
|
||||||
border-top: 1px #23262e solid;
|
|
||||||
bottom: 0;
|
|
||||||
top: 0;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
#settings > div {
|
|
||||||
padding: 12px;
|
|
||||||
}
|
|
||||||
|
|
||||||
li {
|
|
||||||
padding: 12px;
|
|
||||||
border-bottom: 1px solid #23262e;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body style="overflow-y: hidden;">
|
|
||||||
<!--<h2 id="status">Opening UI...</h2>-->
|
|
||||||
<ul id="flatpaklist"></ul>
|
|
||||||
<div id="settings">
|
|
||||||
<div id="status"></div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<script>
|
|
||||||
// TODO:
|
|
||||||
// - Hide Shortcut
|
|
||||||
// - Check if Shortcut still exists
|
|
||||||
|
|
||||||
const status = document.getElementById("status")
|
|
||||||
|
|
||||||
async function show_list() {
|
|
||||||
status.innerHTML = "Fetching Packages..."
|
|
||||||
|
|
||||||
let flatpaks = await get_flatpaks();
|
|
||||||
flatpaks.forEach(flatpak => {
|
|
||||||
let e = document.createElement("li");
|
|
||||||
|
|
||||||
document.getElementById("flatpaklist").appendChild(e);
|
|
||||||
e.innerHTML = flatpak.name;
|
|
||||||
|
|
||||||
e.onclick = async function() {
|
|
||||||
launch_flatpak(flatpak.package);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
status.innerHTML = "Tap a package to launch it"
|
|
||||||
}
|
|
||||||
|
|
||||||
async function launch_flatpak(package) {
|
|
||||||
status.innerHTML = "Updating Shortcut"
|
|
||||||
let id = await get_shortcut();
|
|
||||||
|
|
||||||
sc(`Apps.SetShortcutLaunchOptions(${id}, "run ${package}")`); //This does not apply immediately and also cannot be awaited!
|
|
||||||
setTimeout(async () => {
|
|
||||||
status.innerHTML = "Launching"
|
|
||||||
|
|
||||||
let gid = await gameid_from_appid(id);
|
|
||||||
sc(`Apps.RunGame("${gid}","",-1,100)`);
|
|
||||||
//sc(`Apps.RemoveShortcut(${id})`);
|
|
||||||
setTimeout(() => {
|
|
||||||
exit()
|
|
||||||
}, 1000);
|
|
||||||
}, 100)
|
|
||||||
}
|
|
||||||
|
|
||||||
async function get_shortcut() {
|
|
||||||
let id = await call_plugin_method("get_id", {})
|
|
||||||
if(id == -1) {
|
|
||||||
id = await create_shortcut()
|
|
||||||
} else if(await gameid_from_appid(id) == -1) {
|
|
||||||
id = await create_shortcut()
|
|
||||||
}
|
|
||||||
|
|
||||||
return id
|
|
||||||
}
|
|
||||||
|
|
||||||
async function create_shortcut() {
|
|
||||||
let id = (await sc('Apps.AddShortcut("QuickLaunch","/usr/bin/flatpak")')).result;
|
|
||||||
call_plugin_method("set_id", {id: id})
|
|
||||||
return id
|
|
||||||
}
|
|
||||||
|
|
||||||
async function get_flatpaks() {
|
|
||||||
let list = await call_plugin_method("get_flatpaks", {});
|
|
||||||
list = JSON.parse(`[${list}]`);
|
|
||||||
return list;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function gameid_from_appid(appid) {
|
|
||||||
//executint most of js in the tab avoids some errors i cannot explain myself
|
|
||||||
let game = (await execute_in_tab("SP", true, `
|
|
||||||
async function get_gameid() {
|
|
||||||
let res = await appStore.GetAppOverviewByAppID(${appid})
|
|
||||||
return JSON.stringify(res)
|
|
||||||
}
|
|
||||||
|
|
||||||
get_gameid()
|
|
||||||
`)).result;
|
|
||||||
|
|
||||||
if(game != "null") {
|
|
||||||
game = JSON.parse(game);
|
|
||||||
return game.m_gameid;
|
|
||||||
} else {
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
async function sc(action) {
|
|
||||||
return execute_in_tab("SP", true, `SteamClient.${action}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
function exit() {
|
|
||||||
location.href = "http://127.0.0.1:1337/plugins/iframe";
|
|
||||||
}
|
|
||||||
|
|
||||||
show_list();
|
|
||||||
</script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
53
package.json
Normal file
53
package.json
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
{
|
||||||
|
"name": "sdh-quicklaunch-anatase",
|
||||||
|
"version": "1.2.1",
|
||||||
|
"description": "Quickly launch apps from the Steam Deck Quick Access Menu without adding them as shortcuts",
|
||||||
|
"scripts": {
|
||||||
|
"build": "shx rm -rf dist && rollup -c",
|
||||||
|
"watch": "rollup -c -w",
|
||||||
|
"test": "echo \"Error: no test specified\" && exit 1"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://gitdab.com/dj/SDH-QuickLaunch-Anatase.git"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"decky",
|
||||||
|
"plugin",
|
||||||
|
"steam-deck",
|
||||||
|
"deck"
|
||||||
|
],
|
||||||
|
"author": "Fisch03 & djsime1",
|
||||||
|
"license": "GPL-3.0-or-later",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://gitdab.com/dj/SDH-QuickLaunch-Anatase/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://gitdab.com/dj/SDH-QuickLaunch-Anatase",
|
||||||
|
"devDependencies": {
|
||||||
|
"@rollup/plugin-commonjs": "^21.1.0",
|
||||||
|
"@rollup/plugin-json": "^4.1.0",
|
||||||
|
"@rollup/plugin-node-resolve": "^13.3.0",
|
||||||
|
"@rollup/plugin-replace": "^4.0.0",
|
||||||
|
"@rollup/plugin-typescript": "^8.3.3",
|
||||||
|
"@types/react": "16.14.0",
|
||||||
|
"@types/webpack": "^5.28.0",
|
||||||
|
"decky-frontend-lib": "^3.24.5",
|
||||||
|
"rollup": "^2.77.1",
|
||||||
|
"rollup-plugin-import-assets": "^1.1.1",
|
||||||
|
"shx": "^0.3.4",
|
||||||
|
"tslib": "^2.4.0",
|
||||||
|
"typescript": "^4.7.4"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"react-icons": "^4.8.0"
|
||||||
|
},
|
||||||
|
"pnpm": {
|
||||||
|
"peerDependencyRules": {
|
||||||
|
"ignoreMissing": [
|
||||||
|
"react",
|
||||||
|
"react-dom",
|
||||||
|
"decky-frontend-lib"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
11
plugin.json
11
plugin.json
|
|
@ -1,11 +1,10 @@
|
||||||
{
|
{
|
||||||
"name": "Quick Launch",
|
"name": "Quick Launch",
|
||||||
"author": "Fisch03",
|
"author": "Fisch03 & djsime1",
|
||||||
"main_view_html": "main_view.html",
|
"flags": ["root"],
|
||||||
"flags": [],
|
|
||||||
"publish": {
|
"publish": {
|
||||||
"discord_id": "431374517462499328",
|
"description": "Quickly Launch Non-Steam-Apps from the Quick Access menu without adding them as Shortcuts, or add them to the Steam Library.",
|
||||||
"description": "Quickly Launch Non-Steam-Apps from the Quick Access menu without adding them as Shortcuts",
|
"tags": [ "utility" ],
|
||||||
"tags": [ "utility" ]
|
"image": "https://gitdab.com/dj/SDH-QuickLaunch-Anatase/raw/branch/master/ui_full.png"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
1066
pnpm-lock.yaml
generated
Normal file
1066
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load diff
38
rollup.config.js
Normal file
38
rollup.config.js
Normal file
|
|
@ -0,0 +1,38 @@
|
||||||
|
import commonjs from '@rollup/plugin-commonjs';
|
||||||
|
import json from '@rollup/plugin-json';
|
||||||
|
import { nodeResolve } from '@rollup/plugin-node-resolve';
|
||||||
|
import replace from '@rollup/plugin-replace';
|
||||||
|
import typescript from '@rollup/plugin-typescript';
|
||||||
|
import { defineConfig } from 'rollup';
|
||||||
|
import importAssets from 'rollup-plugin-import-assets';
|
||||||
|
|
||||||
|
import { name } from "./plugin.json";
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
input: './src/index.tsx',
|
||||||
|
plugins: [
|
||||||
|
commonjs(),
|
||||||
|
nodeResolve(),
|
||||||
|
typescript(),
|
||||||
|
json(),
|
||||||
|
replace({
|
||||||
|
preventAssignment: false,
|
||||||
|
'process.env.NODE_ENV': JSON.stringify('production'),
|
||||||
|
}),
|
||||||
|
importAssets({
|
||||||
|
publicPath: `http://127.0.0.1:1337/plugins/${name}/`
|
||||||
|
})
|
||||||
|
],
|
||||||
|
context: 'window',
|
||||||
|
external: ['react', 'react-dom', 'decky-frontend-lib'],
|
||||||
|
output: {
|
||||||
|
file: 'dist/index.js',
|
||||||
|
globals: {
|
||||||
|
react: 'SP_REACT',
|
||||||
|
'react-dom': 'SP_REACTDOM',
|
||||||
|
'decky-frontend-lib': 'DFL',
|
||||||
|
},
|
||||||
|
format: 'iife',
|
||||||
|
exports: 'default',
|
||||||
|
},
|
||||||
|
});
|
||||||
47
src/appoperations.tsx
Normal file
47
src/appoperations.tsx
Normal file
|
|
@ -0,0 +1,47 @@
|
||||||
|
import { ServerAPI } from "decky-frontend-lib";
|
||||||
|
import { App, getLaunchOptions, getTarget } from "./apptypes";
|
||||||
|
import { getImagesForGame } from "./steamgriddb";
|
||||||
|
import { gameIDFromAppID, getShortcutID, createShortcut } from "./utils";
|
||||||
|
import { Settings } from "./settings";
|
||||||
|
|
||||||
|
export async function launchApp(sAPI: ServerAPI, app: App) {
|
||||||
|
let id: number = await getShortcutID(sAPI);
|
||||||
|
|
||||||
|
SteamClient.Apps.SetShortcutName(id, `[QL] ${app.name}`)
|
||||||
|
SteamClient.Apps.SetShortcutLaunchOptions(id, getLaunchOptions(app))
|
||||||
|
SteamClient.Apps.SetShortcutExe(id, `"${getTarget(app)}"`)
|
||||||
|
SteamClient.Apps.SetShortcutStartDir(id, "/app/bin")
|
||||||
|
SteamClient.Apps.SpecifyCompatTool(id, app.compatTool === undefined ? "" : app.compatTool)
|
||||||
|
|
||||||
|
setTimeout(() => {
|
||||||
|
let gid = gameIDFromAppID(id);
|
||||||
|
SteamClient.Apps.RunGame(gid,"",-1,100);
|
||||||
|
}, 500)
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createAppShortcut(sAPI: ServerAPI, app: App, settings: Settings, launchOptions?: string, target?: string) {
|
||||||
|
let shortcutLaunchOptions = launchOptions === undefined ? getLaunchOptions(app) : launchOptions
|
||||||
|
let shortcutTarget = target === undefined ? getTarget(app) : target
|
||||||
|
|
||||||
|
createShortcut(app.name, shortcutLaunchOptions, shortcutTarget).then((id:number) => {
|
||||||
|
if(settings.get("useGridDB")) {
|
||||||
|
getImagesForGame(sAPI, settings.get("gridDBKey") ,app.name)
|
||||||
|
.then(images => {
|
||||||
|
if(images.Grid !== null) SteamClient.Apps.SetCustomArtworkForApp(id, images.Grid, "png", 0);
|
||||||
|
if(images.Hero !== null) SteamClient.Apps.SetCustomArtworkForApp(id, images.Hero, "png", 1);
|
||||||
|
if(images.Logo !== null) SteamClient.Apps.SetCustomArtworkForApp(id, images.Logo, "png", 2);
|
||||||
|
//if(images.Grid !== null) SteamClient.Apps.SetCustomArtworkForApp(id, images.GridH, "png", 3);
|
||||||
|
})
|
||||||
|
.catch(() => {}); //Maybe display error to the user in the future?
|
||||||
|
}
|
||||||
|
|
||||||
|
//This should theoretically not be needed with the new SteamClient.Apps.AddShortcut params but they seem to be pretty broken rn. It's not like it hurts either.
|
||||||
|
setTimeout(() => {
|
||||||
|
SteamClient.Apps.SetShortcutName(id, app.name);
|
||||||
|
SteamClient.Apps.SetShortcutLaunchOptions(id, shortcutLaunchOptions);
|
||||||
|
SteamClient.Apps.SetShortcutExe(id, `"${shortcutTarget}"`);
|
||||||
|
SteamClient.Apps.SetShortcutStartDir(id, "/app/bin")
|
||||||
|
SteamClient.Apps.SpecifyCompatTool(id, app.compatTool === undefined ? "" : app.compatTool);
|
||||||
|
}, 500)
|
||||||
|
})
|
||||||
|
}
|
||||||
16
src/apptypes.tsx
Normal file
16
src/apptypes.tsx
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
export interface App {
|
||||||
|
name: string;
|
||||||
|
exec: string;
|
||||||
|
compatTool?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getLaunchOptions(app: App) {
|
||||||
|
let launchOptions: string[] = app.exec.split(" ")
|
||||||
|
launchOptions.shift()
|
||||||
|
return launchOptions.join(" ")
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getTarget(app: App) {
|
||||||
|
let target: string[] = app.exec.split(" ")
|
||||||
|
return target[0]
|
||||||
|
}
|
||||||
101
src/fileoptions.tsx
Normal file
101
src/fileoptions.tsx
Normal file
|
|
@ -0,0 +1,101 @@
|
||||||
|
import {
|
||||||
|
ServerAPI,
|
||||||
|
ConfirmModal,
|
||||||
|
ToastData,
|
||||||
|
TextField,
|
||||||
|
FilePickerRes,
|
||||||
|
ToggleField
|
||||||
|
} from "decky-frontend-lib"
|
||||||
|
import { useEffect, useState } from "react"
|
||||||
|
import { App } from "./apptypes"
|
||||||
|
|
||||||
|
import { createAppShortcut, launchApp } from "./appoperations"
|
||||||
|
import { Settings } from "./settings"
|
||||||
|
|
||||||
|
export const FileOptionsModal = (props: {closeModal?: CallableFunction, settings: Settings, starApp: CallableFunction, filepath: FilePickerRes, serverAPI: ServerAPI}) => {
|
||||||
|
const closeModal = () => { if (props.closeModal) {props.closeModal()} }
|
||||||
|
const {settings, starApp, filepath, serverAPI} = props
|
||||||
|
const [appName, setAppName] = useState<string>(filepath.path)
|
||||||
|
const [compatTool, setCompatTool] = useState<string|undefined>()
|
||||||
|
const [addToFavorites, setAddToFavorites] = useState<boolean>(false)
|
||||||
|
const [addAsShortcut, setAddAsShortcut] = useState<boolean>(false)
|
||||||
|
|
||||||
|
useEffect(()=>{
|
||||||
|
let filenameWithExtension = filepath.realpath.split(/[\\\/]/).pop() // potentially has an extension
|
||||||
|
let filename = filenameWithExtension
|
||||||
|
let fileext = ''
|
||||||
|
if (filenameWithExtension) {
|
||||||
|
filename = filenameWithExtension.slice(0, filenameWithExtension.lastIndexOf('.'))
|
||||||
|
fileext = filenameWithExtension.slice(filenameWithExtension.lastIndexOf('.')+1, filenameWithExtension.length).toLowerCase()
|
||||||
|
}
|
||||||
|
let path = filepath.realpath.substring(0, filepath.realpath.length - (filenameWithExtension ? filenameWithExtension.length : 0))
|
||||||
|
localStorage.setItem('decky-addtosteam', path)
|
||||||
|
let appName = filename || filenameWithExtension || 'MissingAppName'
|
||||||
|
setAppName(appName)
|
||||||
|
if (['exe', 'bat'].includes(fileext)) setCompatTool('proton-experimental')
|
||||||
|
},[])
|
||||||
|
|
||||||
|
const onOK = () => {
|
||||||
|
let app: App = {
|
||||||
|
name: appName,
|
||||||
|
exec: filepath.realpath,
|
||||||
|
compatTool: compatTool
|
||||||
|
}
|
||||||
|
|
||||||
|
if (addAsShortcut) {
|
||||||
|
createAppShortcut(serverAPI, app, settings, "", app.exec)
|
||||||
|
|
||||||
|
let toastData: ToastData = {
|
||||||
|
title: 'Added Shortcut',
|
||||||
|
body: appName,
|
||||||
|
playSound: true,
|
||||||
|
showToast: true
|
||||||
|
}
|
||||||
|
serverAPI.toaster.toast(toastData)
|
||||||
|
} else if (addToFavorites) {
|
||||||
|
//TODO: Doing this looses information about the compat tool. An app should also be able to store data about compat tools.
|
||||||
|
starApp(app);
|
||||||
|
} else {
|
||||||
|
launchApp(serverAPI, app);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const nameField = <TextField
|
||||||
|
label='Name'
|
||||||
|
focusOnMount={true}
|
||||||
|
value={appName}
|
||||||
|
onChange={(e) => setAppName(e.currentTarget.value)}
|
||||||
|
/>
|
||||||
|
|
||||||
|
return (
|
||||||
|
<ConfirmModal
|
||||||
|
strTitle='File Options'
|
||||||
|
strOKButtonText={addAsShortcut ? 'Add Shortcut' : addToFavorites ? 'Add to starred Apps' : 'Launch'}
|
||||||
|
closeModal={closeModal}
|
||||||
|
onOK={onOK}
|
||||||
|
onCancel={closeModal}
|
||||||
|
onEscKeypress={closeModal}
|
||||||
|
>
|
||||||
|
<ToggleField
|
||||||
|
label='Add to favorites'
|
||||||
|
checked={addToFavorites}
|
||||||
|
onChange={addToFavorites => {
|
||||||
|
setAddToFavorites(addToFavorites);
|
||||||
|
if(addToFavorites) setAddAsShortcut(false);
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
|
||||||
|
<ToggleField
|
||||||
|
label='Add as shortcut'
|
||||||
|
checked={addAsShortcut}
|
||||||
|
onChange={addAsShortcut => {
|
||||||
|
setAddAsShortcut(addAsShortcut);
|
||||||
|
if(addAsShortcut) setAddToFavorites(false);
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
|
||||||
|
{ (addToFavorites || addAsShortcut) && nameField }
|
||||||
|
|
||||||
|
</ConfirmModal>
|
||||||
|
)
|
||||||
|
}
|
||||||
270
src/index.tsx
Executable file
270
src/index.tsx
Executable file
|
|
@ -0,0 +1,270 @@
|
||||||
|
import {
|
||||||
|
definePlugin,
|
||||||
|
ServerAPI,
|
||||||
|
staticClasses,
|
||||||
|
Dropdown,
|
||||||
|
MultiDropdownOption,
|
||||||
|
PanelSection,
|
||||||
|
PanelSectionRow,
|
||||||
|
ToggleField,
|
||||||
|
showModal,
|
||||||
|
ModalRoot,
|
||||||
|
SingleDropdownOption,
|
||||||
|
DropdownOption,
|
||||||
|
DialogButton,
|
||||||
|
Focusable,
|
||||||
|
FileSelectionType
|
||||||
|
} from "decky-frontend-lib";
|
||||||
|
import { Fragment, useEffect } from "react";
|
||||||
|
import { VFC, useState } from "react";
|
||||||
|
import { FaRocket, FaStar, FaRegStar } from "react-icons/fa";
|
||||||
|
|
||||||
|
import { App } from "./apptypes";
|
||||||
|
import { Settings } from "./settings";
|
||||||
|
import { GridDBPanel } from "./steamgriddb";
|
||||||
|
import { fetchApps } from "./utils";
|
||||||
|
import { FileOptionsModal } from "./fileoptions";
|
||||||
|
import { launchApp, createAppShortcut } from "./appoperations";
|
||||||
|
|
||||||
|
enum SpecialSelections {
|
||||||
|
FileShortcut = -1,
|
||||||
|
}
|
||||||
|
|
||||||
|
let appList: App[] = [];
|
||||||
|
|
||||||
|
const Content: VFC<{ serverAPI: ServerAPI }> = ({ serverAPI }) => {
|
||||||
|
const [dropdownOptions, setDropdownOptions] = useState<DropdownOption[]>([]);
|
||||||
|
const [selectedApp, setSelectedApp] = useState<number | null>(null);
|
||||||
|
|
||||||
|
const [settings] = useState<Settings>(new Settings(serverAPI))
|
||||||
|
|
||||||
|
const [showKeyInput, setShowKeyInput] = useState<boolean>(false);
|
||||||
|
|
||||||
|
const [isStarred, setIsStarred] = useState<boolean>(false);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
settings.readSettings().then(() => {
|
||||||
|
if(dropdownOptions.length === 0 || appList.length === 0)
|
||||||
|
buildAppList();
|
||||||
|
setShowKeyInput(settings.get("useGridDB"));
|
||||||
|
});
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
function buildAppList() {
|
||||||
|
return new Promise<void>((resolve) => {
|
||||||
|
let newDropdownOptions: DropdownOption[] = [];
|
||||||
|
appList = [];
|
||||||
|
|
||||||
|
let starredApps = settings.get("starredApps");
|
||||||
|
|
||||||
|
if(starredApps.length > 0)
|
||||||
|
newDropdownOptions.push(...createSubcategory("Starred Apps", settings.get("starredApps")).options);
|
||||||
|
|
||||||
|
fetchApps(serverAPI, "flatpaks")
|
||||||
|
.then(list => {
|
||||||
|
list = list.filter(app => {
|
||||||
|
for(let starredApp of starredApps) {
|
||||||
|
if(starredApp.name === app.name) return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
});
|
||||||
|
|
||||||
|
newDropdownOptions.push(createSubcategory("Flatpaks", list));
|
||||||
|
if(settings.get("enableAll")) {
|
||||||
|
return fetchApps(serverAPI, "desktops")
|
||||||
|
} else {
|
||||||
|
return Promise.resolve([]);
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.then(list => {
|
||||||
|
if(list.length > 0) {
|
||||||
|
list = list.filter(app => {
|
||||||
|
for(let starredApp of starredApps) {
|
||||||
|
if(starredApp.name === app.name) return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
});
|
||||||
|
newDropdownOptions.push(createSubcategory(".desktop files", list));
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.finally(() => {
|
||||||
|
if(settings.get("enableAll")) newDropdownOptions.push({label: "Choose a file...", data: SpecialSelections.FileShortcut} as SingleDropdownOption);
|
||||||
|
setDropdownOptions(newDropdownOptions);
|
||||||
|
resolve();
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
function createSubcategory(categoryName: string, list: App[]) {
|
||||||
|
appList = appList.concat(list);
|
||||||
|
|
||||||
|
return {
|
||||||
|
label: categoryName,
|
||||||
|
options: list.map((a, i) => {return { data: i + appList.length- list.length, label: a.name } as SingleDropdownOption})
|
||||||
|
} as MultiDropdownOption;
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createFileShortcut() {
|
||||||
|
let lastUsedPath = localStorage.getItem('decky-addtosteam')
|
||||||
|
let deckyUserHome = (await serverAPI.callPluginMethod('get_DECKY_USER_HOME', {})).result
|
||||||
|
let path: string
|
||||||
|
if (lastUsedPath != null) {
|
||||||
|
path = lastUsedPath
|
||||||
|
} else if (typeof deckyUserHome === 'string') {
|
||||||
|
path = deckyUserHome
|
||||||
|
} else {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
let filepath = await serverAPI.openFilePickerV2(
|
||||||
|
FileSelectionType.FILE,
|
||||||
|
path,
|
||||||
|
true,
|
||||||
|
undefined,
|
||||||
|
undefined,
|
||||||
|
undefined,
|
||||||
|
false,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
if (!filepath) { return }
|
||||||
|
|
||||||
|
const starApp = async (app: App) => {
|
||||||
|
let starredApps = settings.get("starredApps");
|
||||||
|
if(!starredApps.find((a: App) => a.name === app.name && a.exec === app.exec))
|
||||||
|
starredApps.push(app);
|
||||||
|
settings.set("starredApps", starredApps);
|
||||||
|
|
||||||
|
await buildAppList();
|
||||||
|
setSelectedApp(appList.findIndex((a: App) => a.name === app.name && a.exec === app.exec));
|
||||||
|
}
|
||||||
|
|
||||||
|
showModal(<FileOptionsModal filepath={filepath} starApp={starApp} settings={settings} serverAPI={serverAPI}/>)
|
||||||
|
}
|
||||||
|
|
||||||
|
function newShortcut() {
|
||||||
|
if(selectedApp != null){
|
||||||
|
createAppShortcut(serverAPI, appList[selectedApp], settings)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Fragment>
|
||||||
|
<PanelSection>
|
||||||
|
<PanelSectionRow>
|
||||||
|
<Focusable flow-children="horizontal" style={{display: "flex", justifyContent: "space-between", padding: 0, gap: "8px"}}>
|
||||||
|
<div style={{flexGrow: 1}}>
|
||||||
|
<Dropdown
|
||||||
|
strDefaultLabel="Select App..."
|
||||||
|
rgOptions={dropdownOptions}
|
||||||
|
selectedOption={selectedApp}
|
||||||
|
onChange={(e: SingleDropdownOption) => {
|
||||||
|
setIsStarred(e.data < settings.get("starredApps").length);
|
||||||
|
if(e.data === SpecialSelections.FileShortcut) {
|
||||||
|
createFileShortcut();
|
||||||
|
setSelectedApp(null);
|
||||||
|
}
|
||||||
|
else setSelectedApp(e.data);
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<DialogButton style={{minWidth: 0, width: "15%", padding: 0}} onClick={() => {
|
||||||
|
if(selectedApp === null) return;
|
||||||
|
|
||||||
|
let toBeStarred = appList[selectedApp];
|
||||||
|
|
||||||
|
setIsStarred(!isStarred);
|
||||||
|
let starredApps = settings.get("starredApps");
|
||||||
|
if(isStarred) {
|
||||||
|
starredApps.splice(starredApps.indexOf(appList[selectedApp]), 1);
|
||||||
|
} else {
|
||||||
|
starredApps.push(appList[selectedApp]);
|
||||||
|
}
|
||||||
|
settings.set("starredApps", starredApps);
|
||||||
|
|
||||||
|
buildAppList()
|
||||||
|
.then(() => {
|
||||||
|
if(isStarred) {
|
||||||
|
let foundApp = 0;
|
||||||
|
for(let app of appList) {
|
||||||
|
if(app.name === toBeStarred.name) {
|
||||||
|
foundApp = appList.indexOf(app);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
setSelectedApp(foundApp);
|
||||||
|
} else {
|
||||||
|
setSelectedApp(starredApps.length-1);
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}}>
|
||||||
|
{isStarred ? <FaStar /> : <FaRegStar />}
|
||||||
|
</DialogButton>
|
||||||
|
</Focusable>
|
||||||
|
</PanelSectionRow>
|
||||||
|
<PanelSectionRow>
|
||||||
|
<DialogButton style={{ marginTop: "8px" }} onClick={() => {
|
||||||
|
if(selectedApp === null) return;
|
||||||
|
launchApp(serverAPI, appList[selectedApp])
|
||||||
|
}}>
|
||||||
|
Launch!
|
||||||
|
</DialogButton>
|
||||||
|
</PanelSectionRow>
|
||||||
|
<PanelSectionRow>
|
||||||
|
<DialogButton style={{ marginTop: "8px" }} onClick={() => {newShortcut()}}>
|
||||||
|
Create Shortcut
|
||||||
|
</DialogButton>
|
||||||
|
</PanelSectionRow>
|
||||||
|
</PanelSection>
|
||||||
|
<PanelSection title="Settings">
|
||||||
|
<PanelSectionRow>
|
||||||
|
<ToggleField
|
||||||
|
label="Automatically download Artworks from SteamGridDB"
|
||||||
|
checked={settings.get("useGridDB")}
|
||||||
|
onChange={(e) => {settings.set("useGridDB", e); setShowKeyInput(e)}}
|
||||||
|
/>
|
||||||
|
</PanelSectionRow>
|
||||||
|
<PanelSectionRow>
|
||||||
|
<GridDBPanel
|
||||||
|
enabled={showKeyInput}
|
||||||
|
key={settings.get("gridDBKey")}
|
||||||
|
updateKey={(key) => {settings.set("gridDBKey", key)}}
|
||||||
|
/>
|
||||||
|
</PanelSectionRow>
|
||||||
|
<PanelSectionRow>
|
||||||
|
<ToggleField
|
||||||
|
label="Enable Launching all Apps"
|
||||||
|
checked={settings.get("enableAll")}
|
||||||
|
onChange={(e) => {
|
||||||
|
|
||||||
|
if(e) {
|
||||||
|
showModal(
|
||||||
|
<ModalRoot
|
||||||
|
bAllowFullSize={true}
|
||||||
|
>
|
||||||
|
Warning: Launching some Applications will temporarily break the ability to start any Shortcut from the Steam Deck UI.<br />
|
||||||
|
If that happens hold down the Power Button and hit "Restart Steam". This is a bug within the Steam Deck and unfortunately cannot be circumvented on my side.<br />
|
||||||
|
<br />
|
||||||
|
By continuing, you acknowledge to have read this Warning. Thanks for reading and have fun!
|
||||||
|
</ModalRoot>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
settings.set("enableAll", e)
|
||||||
|
buildAppList();
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</PanelSectionRow>
|
||||||
|
</PanelSection>
|
||||||
|
</Fragment>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export default definePlugin((serverApi: ServerAPI) => {
|
||||||
|
return {
|
||||||
|
title: <div className={staticClasses.Title}>SDH-QuickLaunch</div>,
|
||||||
|
content: <Content serverAPI={serverApi} />,
|
||||||
|
icon: <FaRocket />,
|
||||||
|
alwaysRender: true,
|
||||||
|
};
|
||||||
|
});
|
||||||
58
src/settings.tsx
Normal file
58
src/settings.tsx
Normal file
|
|
@ -0,0 +1,58 @@
|
||||||
|
import { ServerAPI } from "decky-frontend-lib";
|
||||||
|
|
||||||
|
export class Settings {
|
||||||
|
sAPI: ServerAPI;
|
||||||
|
|
||||||
|
//@ts-ignore
|
||||||
|
private createNewShortcut: boolean = false;
|
||||||
|
//@ts-ignore
|
||||||
|
private useGridDB: boolean = false;
|
||||||
|
//@ts-ignore
|
||||||
|
private gridDBKey: string = "";
|
||||||
|
//@ts-ignore
|
||||||
|
private enableAll: boolean = false;
|
||||||
|
//@ts-ignore
|
||||||
|
private starredApps: App[] = [];
|
||||||
|
|
||||||
|
constructor(sAPI: ServerAPI, startingSettings: Settings = {} as Settings) {
|
||||||
|
this.sAPI = sAPI;
|
||||||
|
|
||||||
|
this.setMultiple(startingSettings);
|
||||||
|
}
|
||||||
|
|
||||||
|
set(key: string, value: any) {
|
||||||
|
if(this.hasOwnProperty(key)) {
|
||||||
|
this[key] = value;
|
||||||
|
this.writeChange(key, value);
|
||||||
|
}
|
||||||
|
return this
|
||||||
|
}
|
||||||
|
|
||||||
|
setMultiple(settings: Settings) {
|
||||||
|
Object.keys(settings).forEach(key => {
|
||||||
|
this.set(key, settings[key]);
|
||||||
|
})
|
||||||
|
return this
|
||||||
|
}
|
||||||
|
|
||||||
|
get(key: string): any {
|
||||||
|
return this[key];
|
||||||
|
}
|
||||||
|
|
||||||
|
readSettings(): Promise<Settings> {
|
||||||
|
return new Promise<Settings>((resolve, reject) => {
|
||||||
|
this.sAPI.callPluginMethod<any, Settings>("get_config", {}).then(result => {
|
||||||
|
if(result.success) {
|
||||||
|
this.setMultiple(result.result);
|
||||||
|
resolve(this);
|
||||||
|
} else {
|
||||||
|
reject();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private writeChange(key: string, value: any) {
|
||||||
|
this.sAPI.callPluginMethod<any, Settings>("set_config_value", {key: key, value: value});
|
||||||
|
}
|
||||||
|
}
|
||||||
164
src/steamgriddb.tsx
Normal file
164
src/steamgriddb.tsx
Normal file
|
|
@ -0,0 +1,164 @@
|
||||||
|
import { ButtonItem, ModalRoot, ServerAPI, showModal, TextField } from "decky-frontend-lib";
|
||||||
|
import { Component } from "react";
|
||||||
|
|
||||||
|
interface HTMLResponse {
|
||||||
|
status: number,
|
||||||
|
headers: any,
|
||||||
|
body: string;
|
||||||
|
blob: () => Promise<Blob>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface APIResponse {
|
||||||
|
success: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SearchAPIResponse extends APIResponse {
|
||||||
|
data: SearchObject[]
|
||||||
|
}
|
||||||
|
interface SearchObject {
|
||||||
|
id: number
|
||||||
|
name: string
|
||||||
|
types: string[]
|
||||||
|
verified: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ImageAPIResponse extends APIResponse {
|
||||||
|
success: boolean;
|
||||||
|
data: APIImage[]
|
||||||
|
}
|
||||||
|
interface APIImage {
|
||||||
|
id: number,
|
||||||
|
score: number,
|
||||||
|
style: "alternate" | "blurred" | "nologo" | "material" | "whitelogo",
|
||||||
|
url: string,
|
||||||
|
thumb: string,
|
||||||
|
tags: string[],
|
||||||
|
author: SteamUser
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SteamUser {
|
||||||
|
name: string,
|
||||||
|
steam64: string,
|
||||||
|
avatar: string,
|
||||||
|
}
|
||||||
|
interface ImageCollection {
|
||||||
|
Grid: string | null,
|
||||||
|
Hero: string | null,
|
||||||
|
Logo: string | null,
|
||||||
|
GridH: string | null
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ImageChunk {
|
||||||
|
data: string;
|
||||||
|
is_last: boolean;
|
||||||
|
}
|
||||||
|
export class GridDBPanel extends Component<{ enabled: boolean, key: string, updateKey: (key: string) => void }> {
|
||||||
|
constructor(props:any) {
|
||||||
|
super(props);
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
if(this.props.enabled) {
|
||||||
|
return (
|
||||||
|
<ButtonItem
|
||||||
|
onClick={() => {
|
||||||
|
showModal(
|
||||||
|
<ModalRoot
|
||||||
|
bAllowFullSize={true}
|
||||||
|
>
|
||||||
|
<TextField
|
||||||
|
label="SteamGridDB Key"
|
||||||
|
value={this.props.key}
|
||||||
|
onChange={(e) => {this.props.updateKey(e?.target.value)}}
|
||||||
|
/>
|
||||||
|
</ModalRoot>
|
||||||
|
)
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
Set New SteamGridDB API Key
|
||||||
|
</ButtonItem>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function apiRequest(sAPI: ServerAPI, key:string, endpoint: string, data: string | number) {
|
||||||
|
return new Promise<APIResponse>((resolve, reject) => {
|
||||||
|
sAPI.fetchNoCors<HTMLResponse>(`https://www.steamgriddb.com/api/v2${endpoint}/${encodeURIComponent(data)}`, {
|
||||||
|
method: "GET",
|
||||||
|
headers: {
|
||||||
|
"Authorization": `Bearer ${key}`,
|
||||||
|
"User-Agent": "SDH-QuickLaunch",
|
||||||
|
"Content-Type": "application/json"
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.then(res => {
|
||||||
|
if(res.success) {
|
||||||
|
resolve(JSON.parse(res.result.body))
|
||||||
|
} else {
|
||||||
|
reject(res.result)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
function downloadImageB64(sAPI: ServerAPI, url: string) {
|
||||||
|
return new Promise<any>((resolve, reject) => {
|
||||||
|
sAPI.callPluginMethod<any, ImageChunk>("get_req_imgb64", {url: url})
|
||||||
|
.then(async (res) => {
|
||||||
|
if(!res.success) reject(res.result);
|
||||||
|
|
||||||
|
let chunk: ImageChunk = res.result as ImageChunk;
|
||||||
|
let imgB64: string = chunk.data;
|
||||||
|
|
||||||
|
while(!chunk.is_last) {
|
||||||
|
let res = await sAPI.callPluginMethod<any, ImageChunk>("receive_next_chunk", {})
|
||||||
|
if(!res.success) reject(res.result);
|
||||||
|
|
||||||
|
chunk = res.result as ImageChunk;
|
||||||
|
imgB64 += chunk.data;
|
||||||
|
};
|
||||||
|
|
||||||
|
resolve(imgB64);
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const searchGame = (sAPI: ServerAPI, key: string, gameName: string) => apiRequest(sAPI, key, "/search/autocomplete", gameName) as Promise<SearchAPIResponse>
|
||||||
|
const getGrids = (sAPI: ServerAPI, key: string, gameID: number) => apiRequest(sAPI, key, "/grids/game", gameID) as Promise<ImageAPIResponse>
|
||||||
|
const getHeroes = (sAPI: ServerAPI, key: string, gameID: number) => apiRequest(sAPI, key, "/heroes/game", gameID) as Promise<ImageAPIResponse>
|
||||||
|
const getLogos = (sAPI: ServerAPI, key: string, gameID: number) => apiRequest(sAPI, key, "/logos/game", gameID) as Promise<ImageAPIResponse>
|
||||||
|
//const getIcons = (sAPI: ServerAPI, key: string, gameID: number) => apiRequest(sAPI, key, "/icons/game", gameID) as Promise<ImageAPIResponse>
|
||||||
|
//const getGridH = (sAPI: ServerAPI, key: string, gameID: number) => apiRequest(sAPI, key, "/grids/game", gameID) as Promise<ImageAPIResponse>
|
||||||
|
|
||||||
|
export function getImagesForGame(sAPI: ServerAPI, key: string, gameName: string): Promise<ImageCollection> {
|
||||||
|
return new Promise<ImageCollection>((resolve, reject) => {
|
||||||
|
searchGame(sAPI, key, gameName)
|
||||||
|
.then(res => {
|
||||||
|
if(!res.data[0]) reject("No results found");
|
||||||
|
let id: number = res.data[0].id;
|
||||||
|
let images: ImageCollection = {Grid: null, Hero: null, Logo: null, GridH: null};
|
||||||
|
|
||||||
|
getGrids(sAPI, key, id)
|
||||||
|
.then(res => downloadImageB64(sAPI, res.data[0].url))
|
||||||
|
|
||||||
|
.then(img => {
|
||||||
|
images.Grid = img;
|
||||||
|
return getHeroes(sAPI, key, id)
|
||||||
|
})
|
||||||
|
.then(res => downloadImageB64(sAPI, res.data[0].url))
|
||||||
|
.then(img => {
|
||||||
|
images.Hero = img;
|
||||||
|
return getLogos(sAPI, key, id)
|
||||||
|
})
|
||||||
|
.then(res => downloadImageB64(sAPI, res.data[0].url))
|
||||||
|
.then(img => {
|
||||||
|
images.Logo = img;
|
||||||
|
resolve(images);
|
||||||
|
})
|
||||||
|
.catch(err => reject(err))
|
||||||
|
})
|
||||||
|
.catch(err => reject(err))
|
||||||
|
})
|
||||||
|
}
|
||||||
56
src/utils.tsx
Normal file
56
src/utils.tsx
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
import { ServerAPI } from "decky-frontend-lib";
|
||||||
|
|
||||||
|
import { App } from "./apptypes";
|
||||||
|
|
||||||
|
export const createShortcut = (name: string, launchOptions: string = "", target:string = "") => {
|
||||||
|
return SteamClient.Apps.AddShortcut(name,"/usr/bin/ifyouseethisyoufoundabug", target, launchOptions); //The Part after the last Slash does not matter because it should always be replaced when launching an app
|
||||||
|
}
|
||||||
|
|
||||||
|
export const gameIDFromAppID = (appid: number) => {
|
||||||
|
//@ts-ignore
|
||||||
|
let game = appStore.GetAppOverviewByAppID(appid);
|
||||||
|
|
||||||
|
if(game !== null) {
|
||||||
|
return game.m_gameid;
|
||||||
|
} else {
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function fetchApps(sAPI: ServerAPI, type: string): Promise<App[]> {
|
||||||
|
const result = await sAPI.callPluginMethod<any, string>(`get_${type}`, {});
|
||||||
|
let apps: App[] = []
|
||||||
|
if (result.success) {
|
||||||
|
let appsDict = new Map<string, App>();
|
||||||
|
for (let app of JSON.parse(result.result)) {
|
||||||
|
if (app.name !== "" && !appsDict.has(app.name)) {
|
||||||
|
appsDict.set(app.name, app);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// map values to list
|
||||||
|
apps = Array.from(appsDict.values()).sort((a, b) => a.name.localeCompare(b.name));
|
||||||
|
}
|
||||||
|
|
||||||
|
return apps
|
||||||
|
}
|
||||||
|
|
||||||
|
export const getShortcutID = async (sAPI: ServerAPI) => {
|
||||||
|
const result = await sAPI.callPluginMethod<any, number>("get_id", {})
|
||||||
|
|
||||||
|
if(result.success) {
|
||||||
|
let id: number = result.result;
|
||||||
|
|
||||||
|
if(id == -1) {
|
||||||
|
id = await createShortcut("QuickLaunch");
|
||||||
|
sAPI.callPluginMethod("set_id", {id: id});
|
||||||
|
} else if(await gameIDFromAppID(id) == -1) {
|
||||||
|
id = await createShortcut("QuickLaunch");
|
||||||
|
sAPI.callPluginMethod("set_id", {id: id});
|
||||||
|
}
|
||||||
|
|
||||||
|
return id
|
||||||
|
}
|
||||||
|
|
||||||
|
return -1
|
||||||
|
}
|
||||||
23
tsconfig.json
Normal file
23
tsconfig.json
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"outDir": "dist",
|
||||||
|
"module": "ESNext",
|
||||||
|
"target": "ES2020",
|
||||||
|
"jsx": "react",
|
||||||
|
"jsxFactory": "window.SP_REACT.createElement",
|
||||||
|
"declaration": false,
|
||||||
|
"moduleResolution": "node",
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"noImplicitReturns": true,
|
||||||
|
"noImplicitThis": true,
|
||||||
|
"noImplicitAny": true,
|
||||||
|
"strict": true,
|
||||||
|
"suppressImplicitAnyIndexErrors": true,
|
||||||
|
"allowSyntheticDefaultImports": true,
|
||||||
|
"skipLibCheck": true
|
||||||
|
},
|
||||||
|
"include": ["src"],
|
||||||
|
"exclude": ["node_modules"]
|
||||||
|
}
|
||||||
BIN
ui.jpg
BIN
ui.jpg
Binary file not shown.
|
Before Width: | Height: | Size: 65 KiB |
BIN
ui.png
Normal file
BIN
ui.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 110 KiB |
BIN
ui_full.png
Normal file
BIN
ui_full.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 307 KiB |
Loading…
Add table
Add a link
Reference in a new issue