mirror of
https://github.com/SteamDeckHomebrew/decky-loader.git
synced 2026-06-13 20:25:04 +03:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0e5d991c8d | |||
| 0fe3282828 | |||
| 335d38e12b | |||
| d762860eac | |||
| fdbc508fa8 | |||
| 81fbd0f83f |
@@ -0,0 +1,36 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Description**
|
||||
[A clear and concise description of what the bug is.]
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
[A clear and concise description of what you expected to happen.]
|
||||
|
||||
**Screenshots**
|
||||
[If applicable, add screenshots to help explain your problem.]
|
||||
|
||||
**Version information**
|
||||
- SteamOS Version: ``[Run ``uname -a`` and place the output here. Leave the single quotations outside.]``
|
||||
- Selected Update Channel: [Stable, Beta or Preview.]
|
||||
|
||||
**Logs**
|
||||
[Please reboot your deck (if possible) when attempting to recreate the issue, then run
|
||||
``cd ~ && journalctl -b0 -u plugin_loader.service > backendlog.txt``. This will save the log file to ``~`` aka ``/home/deck``. Please upload the file here in place of this textblock.]
|
||||
|
||||
**Additional context**
|
||||
Have you modified the read-only filesystem at any point?
|
||||
[Yes or No.]
|
||||
@@ -1,73 +0,0 @@
|
||||
name: Bug report
|
||||
description: File a bug/issue
|
||||
title: "[BUG] <title>"
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: low-effort-checks
|
||||
attributes:
|
||||
label: Please confirm
|
||||
description: Issues without all checks may be ignored/closed.
|
||||
options:
|
||||
- label: I have searched existing issues
|
||||
- label: This issue is not a duplicate of an existing one
|
||||
- label: I have checked the [common issues section in the readme file](https://github.com/SteamDeckHomebrew/decky-loader#-common-issues)
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Bug Report Description
|
||||
description: A clear and concise description of what the bug is and if possible, the steps you used to get to the bug. If appropriate, include screenshots or videos.
|
||||
placeholder: |
|
||||
When I try to use ...
|
||||
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected Behaviour
|
||||
description: A brief description of the expected behavior.
|
||||
placeholder: It should be ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
attributes:
|
||||
label: SteamOS version
|
||||
# description: Can be found with `uname -a`
|
||||
# placeholder: "Linux steamdeck 5.13.0-valve36-1-neptune #1 SMP PREEMPT Mon, 19 Dec 2022 23:39:41 +0000 x86_64 GNU/Linux"
|
||||
placeholder: "SteamOS 3.4.3 Stable"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Selected Update Channel
|
||||
description: Which branch of Decky are you on?
|
||||
multiple: false
|
||||
options:
|
||||
- Stable
|
||||
- Prerelease
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
attributes:
|
||||
label: Have you modified the read-only filesystem at any point?
|
||||
description: Describe how here, if you haven't done anything you can leave this blank
|
||||
placeholder: Yes, I've installed neofetch via pacman.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Logs
|
||||
description: Please reboot your deck (if possible) when attempting to recreate the issue, then run ``cd ~ && journalctl -b0 -u plugin_loader.service > deckylog.txt``. This will save the log file to ``~`` aka ``/home/deck``. Please upload the file here
|
||||
placeholder: deckylog.txt
|
||||
validations:
|
||||
required: false
|
||||
@@ -1,5 +0,0 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Steam Deck Homebrew Discord Server
|
||||
url: https://discord.gg/ZU74G2NJzk
|
||||
about: Please ask and answer questions here.
|
||||
@@ -1,35 +0,0 @@
|
||||
name: Feature request
|
||||
description: Request a new feature (NOT A PLUGIN)
|
||||
title: "[Request] <title>"
|
||||
labels: [feature request]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: low-effort-checks
|
||||
attributes:
|
||||
label: Please confirm
|
||||
description: Issues without all checks may be ignored/closed.
|
||||
options:
|
||||
- label: I have searched existing issues
|
||||
- label: This issue is not a duplicate of an existing one
|
||||
- label: This is not a request for a plugin
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Feature Request Description
|
||||
description: A clear and concise description of what the new feature.
|
||||
placeholder: |
|
||||
Decky plugins should be sortable in the quick access menu
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Further Description
|
||||
description: A further explanation of the feature. If appropriate, include screenshots or videos.
|
||||
placeholder: |
|
||||
This would help make the UI clearer and easier to use as there is less clutter in the QAM.
|
||||
It would also make it faster to access plugins that are used more.
|
||||
|
||||
This could be implemented by adding ...
|
||||
validations:
|
||||
required: false
|
||||
@@ -2,8 +2,6 @@
|
||||
<a name="logo" href="https://deckbrew.xyz/"><img src="https://deckbrew.xyz/logo.png" alt="Deckbrew logo" width="200"></a>
|
||||
<br>
|
||||
Decky Loader
|
||||
<br>
|
||||
<a name="logo" href="https://github.com/SteamDeckHomebrew/decky-installer/releases/latest/download/decky_installer.desktop"><img src="./docs/images/download_button.png" alt="Download decky" width="350"></a>
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
@@ -38,7 +36,11 @@ For more information about Decky Loader as well as documentation and development
|
||||
- If you are using any software that uses port 1337 or 8080, please change its port to something else or uninstall it.
|
||||
|
||||
## 💾 Installation
|
||||
- This installation can be done without an admin/sudo password set.
|
||||
|
||||
1. Press the <img src="./docs/images/light/steam.svg#gh-dark-mode-only" height=16><img src="./docs/images/dark/steam.svg#gh-light-mode-only" height=16> button and open the Settings menu.
|
||||
1. Navigate to the System menu and scroll to the System Settings. Toggle "Enable Developer Mode" so it is enabled.
|
||||
1. Navigate to the Developer menu and scroll to Miscellaneous. Toggle "CEF Remote Debugging" so it is enabled.
|
||||
1. Select "Restart Now" to apply your changes.
|
||||
1. Prepare a mouse and keyboard if possible.
|
||||
- Keyboards and mice can be connected to the Steam Deck via USB-C or Bluetooth.
|
||||
- Many Bluetooth keyboard and mouse apps are available for iOS and Android.
|
||||
@@ -46,27 +48,24 @@ For more information about Decky Loader as well as documentation and development
|
||||
- If you have no other options, use the right trackpad as a mouse and press <img src="./docs/images/light/steam.svg#gh-dark-mode-only" height=16><img src="./docs/images/dark/steam.svg#gh-light-mode-only" height=16>+<img src="./docs/images/light/x.svg#gh-dark-mode-only" height=16><img src="./docs/images/dark/x.svg#gh-light-mode-only" height=16> to open the on-screen keyboard as needed.
|
||||
1. Press the <img src="./docs/images/light/steam.svg#gh-dark-mode-only" height=16><img src="./docs/images/dark/steam.svg#gh-light-mode-only" height=16> button and open the Power menu.
|
||||
1. Select "Switch to Desktop".
|
||||
1. Navigate to this Github page on a browser of your choice.
|
||||
1. Press the 'Download' button at the top of the page.
|
||||
1. Run the downloaded file by clicking on it in Dolphin (the file manager).
|
||||
1. Either type your admin password or allow Decky to temporarily set your password to `Decky!`
|
||||
1. Choose the version of Decky Loader you want to install.
|
||||
1. Open the Konsole app and enter the command `passwd`. You can skip this step if you have already created a sudo password using this command. ([YouTube Guide](https://www.youtube.com/watch?v=1vOMYGj22rQ))
|
||||
1. You will be prompted to create a password. Your text will not be visible. After you press enter, you will need to type your password again to confirm.
|
||||
1. Choose the version of Decky Loader you want to install and paste the following command into the Konsole app.
|
||||
- **Latest Release**
|
||||
Intended for most users. This is the latest stable version of Decky Loader.
|
||||
`curl -L https://github.com/SteamDeckHomebrew/decky-loader/raw/main/dist/install_release.sh | sh`
|
||||
- **Latest Pre-Release**
|
||||
Intended for plugin developers. Pre-releases are unlikely to be fully stable but contain the latest changes. For more information on plugin development, please consult [the wiki page](https://deckbrew.xyz/en/loader-dev/development).
|
||||
Intended for plugin developers. Pre-releases are unlikely to be fully stable but contain the latest changes. For more information on plugin development, please consult [the wiki page](https://deckbrew.xyz/en/loader-dev/development).
|
||||
`curl -L https://github.com/SteamDeckHomebrew/decky-loader/raw/main/dist/install_prerelease.sh | sh`
|
||||
1. Open the Return to Gaming Mode shortcut on your desktop.
|
||||
|
||||
- There is also a fast install for those who can use Konsole. Run `curl -L https://github.com/SteamDeckHomebrew/decky-installer/releases/latest/download/install_release.sh | sh` and type your password when prompted.
|
||||
|
||||
### 👋 Uninstallation
|
||||
|
||||
We are sorry to see you go! If you are considering uninstalling because you are having issues, please consider [opening an issue](https://github.com/SteamDeckHomebrew/decky-loader/issues) or [joining our Discord](https://discord.gg/ZU74G2NJzk) so we can help you and other users.
|
||||
|
||||
1. Press the <img src="./docs/images/light/steam.svg#gh-dark-mode-only" height=16><img src="./docs/images/dark/steam.svg#gh-light-mode-only" height=16> button and open the Power menu.
|
||||
1. Select "Switch to Desktop".
|
||||
1. Run the installer file again, and select `uninstall decky loader`
|
||||
- There is also a fast uninstall for those who can use Konsole. Run `curl -L https://github.com/SteamDeckHomebrew/decky-installer/releases/latest/download/uninstall.sh | sh` and type your password when prompted.
|
||||
1. Open the Konsole app and run `curl -L https://github.com/SteamDeckHomebrew/decky-loader/raw/main/dist/uninstall.sh | sh`.
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
|
||||
+1
-12
@@ -394,12 +394,9 @@ async def get_tab_lambda(test) -> Tab:
|
||||
raise ValueError(f"Tab not found by lambda")
|
||||
return tab
|
||||
|
||||
def tab_is_gamepadui(t: Tab) -> bool:
|
||||
return "https://steamloopback.host/routes/" in t.url and (t.title == "Steam Shared Context presented by Valve™" or t.title == "Steam" or t.title == "SP")
|
||||
|
||||
async def get_gamepadui_tab() -> Tab:
|
||||
tabs = await get_tabs()
|
||||
tab = next((i for i in tabs if tab_is_gamepadui(i)), None)
|
||||
tab = next((i for i in tabs if ("https://steamloopback.host/routes/" in i.url and (i.title == "Steam" or i.title == "SP"))), None)
|
||||
if not tab:
|
||||
raise ValueError(f"GamepadUI Tab not found")
|
||||
return tab
|
||||
@@ -408,11 +405,3 @@ async def inject_to_tab(tab_name, js, run_async=False):
|
||||
tab = await get_tab(tab_name)
|
||||
|
||||
return await tab.evaluate_js(js, run_async)
|
||||
|
||||
async def close_old_tabs():
|
||||
tabs = await get_tabs()
|
||||
for t in tabs:
|
||||
if not t.title or (t.title != "Steam Shared Context presented by Valve™" and t.title != "Steam" and t.title != "SP"):
|
||||
logger.debug("Closing tab: " + getattr(t, "title", "Untitled"))
|
||||
await t.close()
|
||||
await sleep(0.5)
|
||||
+10
-6
@@ -22,7 +22,7 @@ from helpers import (REMOTE_DEBUGGER_UNIT, csrf_middleware, get_csrf_token,
|
||||
get_home_path, get_homebrew_path, get_user,
|
||||
get_user_group, set_user, set_user_group,
|
||||
stop_systemd_unit, start_systemd_unit)
|
||||
from injector import get_gamepadui_tab, Tab, get_tabs, close_old_tabs
|
||||
from injector import get_gamepadui_tab, Tab, get_tabs
|
||||
from loader import Loader
|
||||
from settings import SettingsManager
|
||||
from updater import Updater
|
||||
@@ -56,15 +56,12 @@ basicConfig(
|
||||
|
||||
logger = getLogger("Main")
|
||||
|
||||
def chown_plugin_dir():
|
||||
async def chown_plugin_dir():
|
||||
code_chown = call(["chown", "-R", USER+":"+GROUP, CONFIG["plugin_path"]])
|
||||
code_chmod = call(["chmod", "-R", "555", CONFIG["plugin_path"]])
|
||||
if code_chown != 0 or code_chmod != 0:
|
||||
logger.error(f"chown/chmod exited with a non-zero exit code (chown: {code_chown}, chmod: {code_chmod})")
|
||||
|
||||
if CONFIG["chown_plugin_path"] == True:
|
||||
chown_plugin_dir()
|
||||
|
||||
class PluginManager:
|
||||
def __init__(self, loop) -> None:
|
||||
self.loop = loop
|
||||
@@ -90,6 +87,8 @@ class PluginManager:
|
||||
self.loop.create_task(start_systemd_unit(REMOTE_DEBUGGER_UNIT))
|
||||
else:
|
||||
self.loop.create_task(stop_systemd_unit(REMOTE_DEBUGGER_UNIT))
|
||||
if CONFIG["chown_plugin_path"] == True:
|
||||
chown_plugin_dir()
|
||||
self.loop.create_task(self.loader_reinjector())
|
||||
self.loop.create_task(self.load_plugins())
|
||||
|
||||
@@ -171,7 +170,12 @@ class PluginManager:
|
||||
try:
|
||||
if first:
|
||||
if await tab.has_global_var("deckyHasLoaded", False):
|
||||
await close_old_tabs()
|
||||
tabs = await get_tabs()
|
||||
for t in tabs:
|
||||
if not t.title or (t.title != "Steam" and t.title != "SP"):
|
||||
logger.debug("Closing tab: " + getattr(t, "title", "Untitled"))
|
||||
await t.close()
|
||||
await sleep(0.5)
|
||||
await tab.evaluate_js("try{if (window.deckyHasLoaded){setTimeout(() => location.reload(), 100)}else{window.deckyHasLoaded = true;(async()=>{try{while(!window.SP_REACT){await new Promise(r => setTimeout(r, 10))};await import('http://localhost:1337/frontend/index.js')}catch(e){console.error(e)};})();}}catch(e){console.error(e)}", False, False, False)
|
||||
except:
|
||||
logger.info("Failed to inject JavaScript into tab\n" + format_exc())
|
||||
|
||||
+4
-20
@@ -7,7 +7,7 @@ from asyncio import sleep, start_server, gather, open_connection
|
||||
from aiohttp import ClientSession, web
|
||||
|
||||
from logging import getLogger
|
||||
from injector import inject_to_tab, get_gamepadui_tab, close_old_tabs
|
||||
from injector import inject_to_tab, get_gamepadui_tab
|
||||
import helpers
|
||||
import subprocess
|
||||
|
||||
@@ -233,7 +233,7 @@ class Utilities:
|
||||
self.rdt_proxy_server.close()
|
||||
self.rdt_proxy_task.cancel()
|
||||
|
||||
async def _enable_rdt(self):
|
||||
async def enable_rdt(self):
|
||||
# TODO un-hardcode port
|
||||
try:
|
||||
self.stop_rdt_proxy()
|
||||
@@ -243,26 +243,14 @@ class Utilities:
|
||||
self.logger.info("Connecting to React DevTools at " + ip)
|
||||
async with ClientSession() as web:
|
||||
res = await web.request("GET", "http://" + ip + ":8097", ssl=helpers.get_ssl_context())
|
||||
script = """
|
||||
if (!window.deckyHasConnectedRDT) {
|
||||
window.deckyHasConnectedRDT = true;
|
||||
// This fixes the overlay when hovering over an element in RDT
|
||||
Object.defineProperty(window, '__REACT_DEVTOOLS_TARGET_WINDOW__', {
|
||||
enumerable: true,
|
||||
configurable: true,
|
||||
get: function() {
|
||||
return FocusNavController?.m_ActiveContext?.ActiveWindow || window;
|
||||
}
|
||||
});
|
||||
""" + await res.text() + "\n}"
|
||||
if res.status != 200:
|
||||
self.logger.error("Failed to connect to React DevTools at " + ip)
|
||||
return False
|
||||
self.start_rdt_proxy(ip, 8097)
|
||||
script = "if(!window.deckyHasConnectedRDT){window.deckyHasConnectedRDT=true;\n" + await res.text() + "\n}"
|
||||
self.logger.info("Connected to React DevTools, loading script")
|
||||
tab = await get_gamepadui_tab()
|
||||
# RDT needs to load before React itself to work.
|
||||
await close_old_tabs()
|
||||
result = await tab.reload_and_evaluate(script)
|
||||
self.logger.info(result)
|
||||
|
||||
@@ -270,13 +258,9 @@ class Utilities:
|
||||
self.logger.error("Failed to connect to React DevTools")
|
||||
self.logger.error(format_exc())
|
||||
|
||||
async def enable_rdt(self):
|
||||
self.context.loop.create_task(self._enable_rdt())
|
||||
|
||||
async def disable_rdt(self):
|
||||
self.logger.info("Disabling React DevTools")
|
||||
tab = await get_gamepadui_tab()
|
||||
self.rdt_script_id = None
|
||||
await close_old_tabs()
|
||||
await tab.evaluate_js("location.reload();", False, True, False)
|
||||
await tab.evaluate_js("SteamClient.User.StartRestart();", False, True, False)
|
||||
self.logger.info("React DevTools disabled")
|
||||
|
||||
Vendored
+1
-3
@@ -11,12 +11,10 @@ HOMEBREW_FOLDER="${USER_DIR}/homebrew"
|
||||
rm -rf "${HOMEBREW_FOLDER}/services"
|
||||
sudo -u $SUDO_USER mkdir -p "${HOMEBREW_FOLDER}/services"
|
||||
sudo -u $SUDO_USER mkdir -p "${HOMEBREW_FOLDER}/plugins"
|
||||
touch "${USER_DIR}/.steam/steam/.cef-enable-remote-debugging"
|
||||
|
||||
# Download latest release and install it
|
||||
RELEASE=$(curl -s 'https://api.github.com/repos/SteamDeckHomebrew/decky-loader/releases' | jq -r "first(.[] | select(.prerelease == "true"))")
|
||||
VERSION=$(jq -r '.tag_name' <<< ${RELEASE} )
|
||||
DOWNLOADURL=$(jq -r '.assets[].browser_download_url | select(endswith("PluginLoader"))' <<< ${RELEASE})
|
||||
read VERSION DOWNLOADURL < <(echo $(jq -r '.tag_name, .assets[].browser_download_url' <<< ${RELEASE}))
|
||||
|
||||
printf "Installing version %s...\n" "${VERSION}"
|
||||
curl -L $DOWNLOADURL --output ${HOMEBREW_FOLDER}/services/PluginLoader
|
||||
|
||||
Vendored
+1
-3
@@ -11,12 +11,10 @@ HOMEBREW_FOLDER="${USER_DIR}/homebrew"
|
||||
rm -rf "${HOMEBREW_FOLDER}/services"
|
||||
sudo -u $SUDO_USER mkdir -p "${HOMEBREW_FOLDER}/services"
|
||||
sudo -u $SUDO_USER mkdir -p "${HOMEBREW_FOLDER}/plugins"
|
||||
touch "${USER_DIR}/.steam/steam/.cef-enable-remote-debugging"
|
||||
|
||||
# Download latest release and install it
|
||||
RELEASE=$(curl -s 'https://api.github.com/repos/SteamDeckHomebrew/decky-loader/releases' | jq -r "first(.[] | select(.prerelease == "false"))")
|
||||
VERSION=$(jq -r '.tag_name' <<< ${RELEASE} )
|
||||
DOWNLOADURL=$(jq -r '.assets[].browser_download_url | select(endswith("PluginLoader"))' <<< ${RELEASE})
|
||||
read VERSION DOWNLOADURL < <(echo $(jq -r '.tag_name, .assets[].browser_download_url' <<< ${RELEASE}))
|
||||
|
||||
printf "Installing version %s...\n" "${VERSION}"
|
||||
curl -L $DOWNLOADURL --output ${HOMEBREW_FOLDER}/services/PluginLoader
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
@@ -41,7 +41,7 @@
|
||||
}
|
||||
},
|
||||
"dependencies": {
|
||||
"decky-frontend-lib": "^3.18.9",
|
||||
"decky-frontend-lib": "^3.18.4",
|
||||
"react-file-icon": "^1.2.0",
|
||||
"react-icons": "^4.4.0",
|
||||
"react-markdown": "^8.0.3",
|
||||
|
||||
Generated
+4
-4
@@ -10,7 +10,7 @@ specifiers:
|
||||
'@types/react-file-icon': ^1.0.1
|
||||
'@types/react-router': 5.1.18
|
||||
'@types/webpack': ^5.28.0
|
||||
decky-frontend-lib: ^3.18.9
|
||||
decky-frontend-lib: ^3.18.4
|
||||
husky: ^8.0.1
|
||||
import-sort-style-module: ^6.0.0
|
||||
inquirer: ^8.2.4
|
||||
@@ -30,7 +30,7 @@ specifiers:
|
||||
typescript: ^4.7.4
|
||||
|
||||
dependencies:
|
||||
decky-frontend-lib: 3.18.9
|
||||
decky-frontend-lib: 3.18.4
|
||||
react-file-icon: 1.2.0_wcqkhtmu7mswc6yz4uyexck3ty
|
||||
react-icons: 4.4.0_react@16.14.0
|
||||
react-markdown: 8.0.3_vshvapmxg47tngu7tvrsqpq55u
|
||||
@@ -944,8 +944,8 @@ packages:
|
||||
dependencies:
|
||||
ms: 2.1.2
|
||||
|
||||
/decky-frontend-lib/3.18.9:
|
||||
resolution: {integrity: sha512-QNMHDDAHfL+JpvVVte4Vj8iyOqvz/2iyFEknbJ1/Kz7aPTygFUsJp5mq1FDVvVNjfCYfF3fYAaZVqZu3d7pCEA==}
|
||||
/decky-frontend-lib/3.18.4:
|
||||
resolution: {integrity: sha512-i3TAe3RJtT1TK0rJgW9Ek5jxMWZRCYLDvqHDylGVieUvuyI7c8X+cogz30pP4cqeGOaA1d/MxBEbhlpD3JhVvg==}
|
||||
dev: false
|
||||
|
||||
/decode-named-character-reference/1.0.2:
|
||||
|
||||
@@ -14,13 +14,13 @@ export class DeckyGlobalComponentsState {
|
||||
return { components: this._components };
|
||||
}
|
||||
|
||||
addComponent(path: string, component: FC) {
|
||||
this._components.set(path, component);
|
||||
addComponent(name: string, component: FC) {
|
||||
this._components.set(name, component);
|
||||
this.notifyUpdate();
|
||||
}
|
||||
|
||||
removeComponent(path: string) {
|
||||
this._components.delete(path);
|
||||
removeComponent(name: string) {
|
||||
this._components.delete(name);
|
||||
this.notifyUpdate();
|
||||
}
|
||||
|
||||
@@ -30,8 +30,8 @@ export class DeckyGlobalComponentsState {
|
||||
}
|
||||
|
||||
interface DeckyGlobalComponentsContext extends PublicDeckyGlobalComponentsState {
|
||||
addComponent(path: string, component: FC): void;
|
||||
removeComponent(path: string): void;
|
||||
addComponent(name: string, component: FC): void;
|
||||
removeComponent(name: string): void;
|
||||
}
|
||||
|
||||
const DeckyGlobalComponentsContext = createContext<DeckyGlobalComponentsContext>(null as any);
|
||||
|
||||
@@ -0,0 +1,147 @@
|
||||
import { CustomMainMenuItem, ItemPatch, OverlayPatch } from 'decky-frontend-lib';
|
||||
import { FC, ReactNode, createContext, useContext, useEffect, useState } from 'react';
|
||||
|
||||
interface PublicDeckyMenuState {
|
||||
items: Set<CustomMainMenuItem>;
|
||||
itemPatches: Map<string, Set<ItemPatch>>;
|
||||
overlayPatches: Set<OverlayPatch>;
|
||||
overlayComponents: Set<ReactNode>;
|
||||
}
|
||||
|
||||
export class DeckyMenuState {
|
||||
private _items = new Set<CustomMainMenuItem>();
|
||||
private _itemPatches = new Map<string, Set<ItemPatch>>();
|
||||
private _overlayPatches = new Set<OverlayPatch>();
|
||||
private _overlayComponents = new Set<ReactNode>();
|
||||
|
||||
public eventBus = new EventTarget();
|
||||
|
||||
publicState(): PublicDeckyMenuState {
|
||||
return {
|
||||
items: this._items,
|
||||
itemPatches: this._itemPatches,
|
||||
overlayPatches: this._overlayPatches,
|
||||
overlayComponents: this._overlayComponents,
|
||||
};
|
||||
}
|
||||
|
||||
addItem(item: CustomMainMenuItem) {
|
||||
this._items.add(item);
|
||||
this.notifyUpdate();
|
||||
return item;
|
||||
}
|
||||
|
||||
addPatch(path: string, patch: ItemPatch) {
|
||||
let patchList = this._itemPatches.get(path);
|
||||
if (!patchList) {
|
||||
patchList = new Set();
|
||||
this._itemPatches.set(path, patchList);
|
||||
}
|
||||
patchList.add(patch);
|
||||
this.notifyUpdate();
|
||||
return patch;
|
||||
}
|
||||
|
||||
addOverlayPatch(patch: OverlayPatch) {
|
||||
this._overlayPatches.add(patch);
|
||||
this.notifyUpdate();
|
||||
return patch;
|
||||
}
|
||||
|
||||
addOverlayComponent(component: ReactNode) {
|
||||
this._overlayComponents.add(component);
|
||||
this.notifyUpdate();
|
||||
return component;
|
||||
}
|
||||
|
||||
removePatch(path: string, patch: ItemPatch) {
|
||||
const patchList = this._itemPatches.get(path);
|
||||
patchList?.delete(patch);
|
||||
if (patchList?.size == 0) {
|
||||
this._itemPatches.delete(path);
|
||||
}
|
||||
this.notifyUpdate();
|
||||
}
|
||||
|
||||
removeItem(item: CustomMainMenuItem) {
|
||||
this._items.delete(item);
|
||||
this.notifyUpdate();
|
||||
return item;
|
||||
}
|
||||
|
||||
removeOverlayPatch(patch: OverlayPatch) {
|
||||
this._overlayPatches.delete(patch);
|
||||
this.notifyUpdate();
|
||||
}
|
||||
|
||||
removeOverlayComponent(component: ReactNode) {
|
||||
this._overlayComponents.delete(component);
|
||||
this.notifyUpdate();
|
||||
}
|
||||
|
||||
private notifyUpdate() {
|
||||
this.eventBus.dispatchEvent(new Event('update'));
|
||||
}
|
||||
}
|
||||
|
||||
interface DeckyMenuStateContext extends PublicDeckyMenuState {
|
||||
addItem: DeckyMenuState['addItem'];
|
||||
addPatch: DeckyMenuState['addPatch'];
|
||||
addOverlayPatch: DeckyMenuState['addOverlayPatch'];
|
||||
addOverlayComponent: DeckyMenuState['addOverlayComponent'];
|
||||
removePatch: DeckyMenuState['removePatch'];
|
||||
removeOverlayPatch: DeckyMenuState['removeOverlayPatch'];
|
||||
removeOverlayComponent: DeckyMenuState['removeOverlayComponent'];
|
||||
removeItem: DeckyMenuState['removeItem'];
|
||||
}
|
||||
|
||||
const DeckyMenuStateContext = createContext<DeckyMenuStateContext>(null as any);
|
||||
|
||||
export const useDeckyMenuState = () => useContext(DeckyMenuStateContext);
|
||||
|
||||
interface Props {
|
||||
deckyMenuState: DeckyMenuState;
|
||||
}
|
||||
|
||||
export const DeckyMenuStateContextProvider: FC<Props> = ({ children, deckyMenuState }) => {
|
||||
const [publicDeckyMenuState, setPublicDeckyMenuState] = useState<PublicDeckyMenuState>({
|
||||
...deckyMenuState.publicState(),
|
||||
});
|
||||
|
||||
useEffect(() => {
|
||||
function onUpdate() {
|
||||
setPublicDeckyMenuState({ ...deckyMenuState.publicState() });
|
||||
}
|
||||
|
||||
deckyMenuState.eventBus.addEventListener('update', onUpdate);
|
||||
|
||||
return () => deckyMenuState.eventBus.removeEventListener('update', onUpdate);
|
||||
}, []);
|
||||
|
||||
const addItem = deckyMenuState.addItem.bind(deckyMenuState);
|
||||
const addPatch = deckyMenuState.addPatch.bind(deckyMenuState);
|
||||
const addOverlayPatch = deckyMenuState.addOverlayPatch.bind(deckyMenuState);
|
||||
const addOverlayComponent = deckyMenuState.addOverlayComponent.bind(deckyMenuState);
|
||||
const removePatch = deckyMenuState.removePatch.bind(deckyMenuState);
|
||||
const removeOverlayPatch = deckyMenuState.removeOverlayPatch.bind(deckyMenuState);
|
||||
const removeOverlayComponent = deckyMenuState.removeOverlayComponent.bind(deckyMenuState);
|
||||
const removeItem = deckyMenuState.removeItem.bind(deckyMenuState);
|
||||
|
||||
return (
|
||||
<DeckyMenuStateContext.Provider
|
||||
value={{
|
||||
...publicDeckyMenuState,
|
||||
addItem,
|
||||
addPatch,
|
||||
addOverlayPatch,
|
||||
addOverlayComponent,
|
||||
removePatch,
|
||||
removeOverlayPatch,
|
||||
removeOverlayComponent,
|
||||
removeItem,
|
||||
}}
|
||||
>
|
||||
{children}
|
||||
</DeckyMenuStateContext.Provider>
|
||||
);
|
||||
};
|
||||
@@ -68,7 +68,6 @@ const PluginCard: FC<PluginCardProps> = ({ plugin }) => {
|
||||
style={{
|
||||
display: 'flex',
|
||||
flexDirection: 'row',
|
||||
margin: '0 0 0 10px',
|
||||
}}
|
||||
className="deckyStoreCardBody"
|
||||
>
|
||||
@@ -78,7 +77,6 @@ const PluginCard: FC<PluginCardProps> = ({ plugin }) => {
|
||||
style={{
|
||||
width: 'auto',
|
||||
height: '160px',
|
||||
borderRadius: '5px',
|
||||
}}
|
||||
src={plugin.image_url}
|
||||
/>
|
||||
@@ -146,14 +144,12 @@ const PluginCard: FC<PluginCardProps> = ({ plugin }) => {
|
||||
display: 'flex',
|
||||
flexDirection: 'row',
|
||||
width: '100%',
|
||||
margin: '10px',
|
||||
}}
|
||||
>
|
||||
<div
|
||||
className="deckyStoreCardInstallButtonContainer"
|
||||
style={{
|
||||
flex: '1',
|
||||
margin: '0 10px 0 0',
|
||||
}}
|
||||
>
|
||||
<DialogButton
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
import { Navigation, Router, sleep } from 'decky-frontend-lib';
|
||||
|
||||
import PluginLoader from './plugin-loader';
|
||||
import { DeckyUpdater } from './updater';
|
||||
|
||||
@@ -16,23 +14,6 @@ declare global {
|
||||
}
|
||||
}
|
||||
|
||||
(async () => {
|
||||
try {
|
||||
if (!Router.NavigateToAppProperties || !Router.NavigateToLibraryTab || !Router.NavigateToInvites) {
|
||||
while (!Navigation.NavigateToAppProperties) await sleep(100);
|
||||
const shims = {
|
||||
NavigateToAppProperties: Navigation.NavigateToAppProperties,
|
||||
NavigateToInvites: Navigation.NavigateToInvites,
|
||||
NavigateToLibraryTab: Navigation.NavigateToLibraryTab,
|
||||
};
|
||||
(Router as unknown as any).deckyShim = true;
|
||||
Object.assign(Router, shims);
|
||||
}
|
||||
} catch (e) {
|
||||
console.error('[DECKY]: Error initializing Navigation interface shims', e);
|
||||
}
|
||||
})();
|
||||
|
||||
(async () => {
|
||||
window.deckyAuthToken = await fetch('http://127.0.0.1:1337/auth/token').then((r) => r.text());
|
||||
|
||||
|
||||
@@ -0,0 +1,235 @@
|
||||
import {
|
||||
CustomMainMenuItem,
|
||||
ItemPatch,
|
||||
MainMenuItem,
|
||||
OverlayPatch,
|
||||
afterPatch,
|
||||
findInReactTree,
|
||||
sleep,
|
||||
} from 'decky-frontend-lib';
|
||||
import { FC } from 'react';
|
||||
import { ReactNode, cloneElement, createElement } from 'react';
|
||||
|
||||
import { DeckyMenuState, DeckyMenuStateContextProvider, useDeckyMenuState } from './components/DeckyMenuState';
|
||||
import Logger from './logger';
|
||||
|
||||
declare global {
|
||||
interface Window {
|
||||
__MENU_HOOK_INSTANCE: any;
|
||||
}
|
||||
}
|
||||
|
||||
class MenuHook extends Logger {
|
||||
private menuRenderer?: any;
|
||||
private originalRenderer?: any;
|
||||
private menuState: DeckyMenuState = new DeckyMenuState();
|
||||
|
||||
constructor() {
|
||||
super('MenuHook');
|
||||
|
||||
this.log('Initialized');
|
||||
window.__MENU_HOOK_INSTANCE?.deinit?.();
|
||||
window.__MENU_HOOK_INSTANCE = this;
|
||||
}
|
||||
|
||||
init() {
|
||||
const tree = (document.getElementById('root') as any)._reactRootContainer._internalRoot.current;
|
||||
let outerMenuRoot: any;
|
||||
const findMenuRoot = (currentNode: any, iters: number): any => {
|
||||
if (iters >= 60) {
|
||||
// currently 54
|
||||
return null;
|
||||
}
|
||||
if (currentNode?.memoizedProps?.navID == 'MainNavMenuContainer') {
|
||||
this.log(`Menu root was found in ${iters} recursion cycles`);
|
||||
return currentNode;
|
||||
}
|
||||
if (currentNode.child) {
|
||||
let node = findMenuRoot(currentNode.child, iters + 1);
|
||||
if (node !== null) return node;
|
||||
}
|
||||
if (currentNode.sibling) {
|
||||
let node = findMenuRoot(currentNode.sibling, iters + 1);
|
||||
if (node !== null) return node;
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
(async () => {
|
||||
outerMenuRoot = findMenuRoot(tree, 0);
|
||||
while (!outerMenuRoot) {
|
||||
this.error(
|
||||
'Failed to find Menu root node, reattempting in 5 seconds. A developer may need to increase the recursion limit.',
|
||||
);
|
||||
await sleep(5000);
|
||||
outerMenuRoot = findMenuRoot(tree, 0);
|
||||
}
|
||||
this.log('found outermenuroot', outerMenuRoot);
|
||||
const menuRenderer = outerMenuRoot.return;
|
||||
this.menuRenderer = menuRenderer;
|
||||
this.originalRenderer = menuRenderer.type;
|
||||
let toReplace = new Map<string, ReactNode>();
|
||||
let alreadyPatched = new Map<string, { total: number; node: ReactNode }>();
|
||||
|
||||
let patchedInnerMenu: any;
|
||||
let overlayComponentManager: any;
|
||||
|
||||
const DeckyOverlayComponentManager = () => {
|
||||
const { overlayComponents } = useDeckyMenuState();
|
||||
|
||||
return <>{overlayComponents.values()}</>;
|
||||
};
|
||||
|
||||
const DeckyInnerMenuWrapper = (props: { innerProps: any }) => {
|
||||
const { overlayPatches } = useDeckyMenuState();
|
||||
|
||||
const rendererRet = this.originalRenderer(props.innerProps);
|
||||
|
||||
// Find the first array of children, this contains [mainmenu, overlay]
|
||||
const childArray = findInReactTree(rendererRet, (x) => x?.[0]?.type);
|
||||
|
||||
// Insert the overlay components manager
|
||||
if (!overlayComponentManager) {
|
||||
overlayComponentManager = <DeckyOverlayComponentManager />;
|
||||
}
|
||||
|
||||
childArray.push(overlayComponentManager);
|
||||
|
||||
// This must be cached in patchedInnerMenu to prevent re-renders
|
||||
if (patchedInnerMenu) {
|
||||
childArray[0].type = patchedInnerMenu;
|
||||
} else {
|
||||
afterPatch(childArray[0], 'type', (_, ret) => {
|
||||
const { itemPatches, items } = useDeckyMenuState();
|
||||
|
||||
const itemList = ret.props.children;
|
||||
|
||||
// Add custom menu items
|
||||
if (items.size > 0) {
|
||||
const button = findInReactTree(ret.props.children, (x) =>
|
||||
x?.type?.toString()?.includes('exactRouteMatch:'),
|
||||
);
|
||||
|
||||
const MenuItemComponent: FC<MainMenuItem> = button.type;
|
||||
|
||||
items.forEach((item) => {
|
||||
let realIndex = 0; // there are some non-item things in the array
|
||||
let count = 0;
|
||||
itemList.forEach((i: any) => {
|
||||
if (count == item.index) return;
|
||||
if (i?.type == MenuItemComponent) count++;
|
||||
realIndex++;
|
||||
});
|
||||
itemList.splice(realIndex, 0, createElement(MenuItemComponent, item));
|
||||
});
|
||||
}
|
||||
|
||||
// Apply and revert patches
|
||||
itemList.forEach((item: { props: MainMenuItem }, index: number) => {
|
||||
if (!item?.props?.route) return;
|
||||
const replaced = toReplace.get(item?.props?.route as string);
|
||||
if (replaced) {
|
||||
itemList[index] = replaced;
|
||||
toReplace.delete(item?.props.route as string);
|
||||
}
|
||||
if (item?.props?.route && (itemPatches.has(item.props.route as string) || itemPatches.has('*'))) {
|
||||
if (
|
||||
item?.props?.route &&
|
||||
alreadyPatched.has(item.props.route) &&
|
||||
alreadyPatched.get(item.props.route)?.total ==
|
||||
(itemPatches.get(item.props.route)?.size || 0) + (itemPatches.get('*')?.size || 0)
|
||||
) {
|
||||
const patched = alreadyPatched.get(item.props.route);
|
||||
this.debug('found already patched', patched);
|
||||
itemList[index] = patched?.node;
|
||||
return;
|
||||
}
|
||||
toReplace.set(item?.props?.route as string, itemList[index]);
|
||||
itemPatches.get(item.props.route as string)?.forEach((patch) => {
|
||||
const oType = itemList[index].type;
|
||||
itemList[index] = patch({
|
||||
...cloneElement(itemList[index]),
|
||||
type: (props: any) => createElement(oType, props),
|
||||
});
|
||||
});
|
||||
itemPatches.get('*')?.forEach((patch) => {
|
||||
const oType = itemList[index].type;
|
||||
itemList[index] = patch({
|
||||
...cloneElement(itemList[index]),
|
||||
type: (props: any) => createElement(oType, props),
|
||||
});
|
||||
});
|
||||
alreadyPatched.set(item.props.route, {
|
||||
total: (itemPatches.get(item.props.route)?.size || 0) + (itemPatches.get('*')?.size || 0),
|
||||
node: itemList[index],
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
return ret;
|
||||
});
|
||||
patchedInnerMenu = childArray[0].type;
|
||||
}
|
||||
|
||||
// Apply patches to the overlay
|
||||
if (childArray[1]) {
|
||||
overlayPatches.forEach((patch) => (childArray[1] = patch(childArray[1])));
|
||||
}
|
||||
|
||||
return rendererRet;
|
||||
};
|
||||
|
||||
const DeckyOuterMenuWrapper = (props: any) => {
|
||||
return (
|
||||
<DeckyMenuStateContextProvider deckyMenuState={this.menuState}>
|
||||
<DeckyInnerMenuWrapper innerProps={props} />
|
||||
</DeckyMenuStateContextProvider>
|
||||
);
|
||||
};
|
||||
menuRenderer.type = DeckyOuterMenuWrapper;
|
||||
if (menuRenderer.alternate) {
|
||||
menuRenderer.alternate.type = menuRenderer.type;
|
||||
}
|
||||
this.log('Finished initial injection');
|
||||
})();
|
||||
}
|
||||
|
||||
deinit() {
|
||||
this.menuRenderer.type = this.originalRenderer;
|
||||
this.menuRenderer.alternate.type = this.menuRenderer.type;
|
||||
}
|
||||
|
||||
addItem(item: CustomMainMenuItem) {
|
||||
return this.menuState.addItem(item);
|
||||
}
|
||||
|
||||
addPatch(path: string, patch: ItemPatch) {
|
||||
return this.menuState.addPatch(path, patch);
|
||||
}
|
||||
|
||||
addOverlayPatch(patch: OverlayPatch) {
|
||||
return this.menuState.addOverlayPatch(patch);
|
||||
}
|
||||
|
||||
addOverlayComponent(component: ReactNode) {
|
||||
return this.menuState.addOverlayComponent(component);
|
||||
}
|
||||
|
||||
removePatch(path: string, patch: ItemPatch) {
|
||||
return this.menuState.removePatch(path, patch);
|
||||
}
|
||||
|
||||
removeItem(item: CustomMainMenuItem) {
|
||||
return this.menuState.removeItem(item);
|
||||
}
|
||||
|
||||
removeOverlayPatch(patch: OverlayPatch) {
|
||||
return this.menuState.removeOverlayPatch(patch);
|
||||
}
|
||||
|
||||
removeOverlayComponent(component: ReactNode) {
|
||||
return this.menuState.removeOverlayComponent(component);
|
||||
}
|
||||
}
|
||||
|
||||
export default MenuHook;
|
||||
@@ -1,13 +1,4 @@
|
||||
import {
|
||||
ConfirmModal,
|
||||
ModalRoot,
|
||||
Patch,
|
||||
QuickAccessTab,
|
||||
Router,
|
||||
showModal,
|
||||
sleep,
|
||||
staticClasses,
|
||||
} from 'decky-frontend-lib';
|
||||
import { ConfirmModal, ModalRoot, QuickAccessTab, Router, showModal, sleep, staticClasses } from 'decky-frontend-lib';
|
||||
import { FC, lazy } from 'react';
|
||||
import { FaCog, FaExclamationCircle, FaPlug } from 'react-icons/fa';
|
||||
|
||||
@@ -19,6 +10,7 @@ import NotificationBadge from './components/NotificationBadge';
|
||||
import PluginView from './components/PluginView';
|
||||
import WithSuspense from './components/WithSuspense';
|
||||
import Logger from './logger';
|
||||
import MenuHook from './menu-hook';
|
||||
import { Plugin } from './plugin';
|
||||
import RouterHook from './router-hook';
|
||||
import { deinitSteamFixes, initSteamFixes } from './steamfixes';
|
||||
@@ -37,6 +29,7 @@ const FilePicker = lazy(() => import('./components/modals/filepicker'));
|
||||
class PluginLoader extends Logger {
|
||||
private plugins: Plugin[] = [];
|
||||
private tabsHook: TabsHook | OldTabsHook = document.title == 'SP' ? new OldTabsHook() : new TabsHook();
|
||||
private menuHook: MenuHook = new MenuHook();
|
||||
// private windowHook: WindowHook = new WindowHook();
|
||||
private routerHook: RouterHook = new RouterHook();
|
||||
public toaster: Toaster = new Toaster();
|
||||
@@ -46,11 +39,10 @@ class PluginLoader extends Logger {
|
||||
// stores a list of plugin names which requested to be reloaded
|
||||
private pluginReloadQueue: { name: string; version?: string }[] = [];
|
||||
|
||||
private focusWorkaroundPatch?: Patch;
|
||||
|
||||
constructor() {
|
||||
super(PluginLoader.name);
|
||||
this.tabsHook.init();
|
||||
this.menuHook.init();
|
||||
this.log('Initialized');
|
||||
|
||||
const TabBadge = () => {
|
||||
@@ -185,7 +177,6 @@ class PluginLoader extends Logger {
|
||||
this.routerHook.removeRoute('/decky/settings');
|
||||
deinitSteamFixes();
|
||||
deinitFilepickerPatches();
|
||||
this.focusWorkaroundPatch?.unpatch();
|
||||
}
|
||||
|
||||
public unloadPlugin(name: string) {
|
||||
@@ -322,6 +313,7 @@ class PluginLoader extends Logger {
|
||||
|
||||
createPluginAPI(pluginName: string) {
|
||||
return {
|
||||
menuHook: this.menuHook,
|
||||
routerHook: this.routerHook,
|
||||
toaster: this.toaster,
|
||||
callServerMethod: this.callServerMethod,
|
||||
|
||||
@@ -120,6 +120,8 @@ class RouterHook extends Logger {
|
||||
return <>{renderedComponents}</>;
|
||||
};
|
||||
|
||||
let globalComponents: any;
|
||||
|
||||
this.wrapperPatch = afterPatch(this.gamepadWrapper, 'render', (_: any, ret: any) => {
|
||||
if (ret?.props?.children?.props?.children?.length == 5 || ret?.props?.children?.props?.children?.length == 4) {
|
||||
const idx = ret?.props?.children?.props?.children?.length == 4 ? 1 : 2;
|
||||
@@ -143,11 +145,17 @@ class RouterHook extends Logger {
|
||||
this.memoizedRouter = memo(this.router.type);
|
||||
this.memoizedRouter.isDeckyRouter = true;
|
||||
}
|
||||
ret.props.children.props.children.push(
|
||||
<DeckyGlobalComponentsStateContextProvider deckyGlobalComponentsState={this.globalComponentsState}>
|
||||
<DeckyGlobalComponentsWrapper />
|
||||
</DeckyGlobalComponentsStateContextProvider>,
|
||||
);
|
||||
|
||||
if (!globalComponents) {
|
||||
globalComponents = (
|
||||
<DeckyGlobalComponentsStateContextProvider deckyGlobalComponentsState={this.globalComponentsState}>
|
||||
<DeckyGlobalComponentsWrapper />
|
||||
</DeckyGlobalComponentsStateContextProvider>
|
||||
);
|
||||
}
|
||||
|
||||
ret.props.children.props.children.push(globalComponents);
|
||||
|
||||
ret.props.children.props.children[idx].props.children[0].type = this.memoizedRouter;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user