mirror of
https://github.com/SteamDeckHomebrew/decky-loader.git
synced 2026-06-13 12:15:09 +03:00
TrainDoctor
71 lines
3.6 KiB
Markdown
71 lines
3.6 KiB
Markdown
# TODO
|
|
- Fix button size/display
|
|
- Add plugin installation prompts for browser
|
|
- Fix components not updating unless tab opened first (with new tab hook)
|
|
- Clean up code
|
|
|
|
# Plugin Loader [](https://discord.gg/ZU74G2NJzk)
|
|
|
|
|
|
|
|
Keep an eye on the [Wiki](https://deckbrew.xyz) for more information about Plugin Loader, documentation + tools for plugin development and more.
|
|
|
|
## Installation
|
|
1. Go into the Steam Deck Settings
|
|
2. Under System -> System Settings toggle `Enable Developer Mode`
|
|
3. Scroll the sidebar all the way down and click on `Developer`
|
|
4. Under Miscellaneous, enable `CEF Remote Debugging`
|
|
5. Click on the `STEAM` button and select `Power` -> `Switch to Desktop`
|
|
6. Open a terminal and paste the following command into it:
|
|
- For users:
|
|
- `curl -L https://github.com/SteamDeckHomebrew/PluginLoader/raw/main/dist/install_release.sh | sh`
|
|
- For plugin developers:
|
|
~~- `curl -L https://github.com/SteamDeckHomebrew/PluginLoader/raw/main/dist/install_nightly.sh | sh`~~
|
|
Nightly releases are currently broken.
|
|
7. Done! Reboot back into Gaming mode and enjoy your plugins!
|
|
|
|
### Install Plugins
|
|
- Using the shopping bag button in the top right corner, you can go to the offical ["Plugin Store"](https://plugins.deckbrew.xyz/)
|
|
- Simply copy the plugin's folder into `~/homebrew/plugins`
|
|
|
|
### Uninstall
|
|
- Open a terminal and paste the following command into it:
|
|
- For both users and developers:
|
|
- `curl -L https://github.com/SteamDeckHomebrew/PluginLoader/raw/main/dist/uninstall.sh | sh`
|
|
|
|
## Features
|
|
- Clean injecting and loading of one or more plugins
|
|
- Persistent. It doesn't need to be reinstalled after every system update
|
|
- Allows 2-way communication between the plugins and the loader.
|
|
- Allows plugins to define python functions and run them from javascript.
|
|
- Allows plugins to make fetch calls, bypassing cors completely.
|
|
|
|
## Developing plugins
|
|
- There is no complete plugin development documentation yet. However a good starting point is the [Plugin Template](https://github.com/SteamDeckHomebrew/decky-plugin-template) repository.
|
|
|
|
## Contribution
|
|
- For Plugin Loader contributors (in possession of a Steam Deck):
|
|
- `bash <(curl -s https://github.com/SteamDeckHomebrew/PluginLoader/raw/react-frontend-plugins/contrib/deck.sh)`
|
|
- For PluginLoader contributors (without a Steam Deck):
|
|
- `bash <(curl -s https://github.com/SteamDeckHomebrew/PluginLoader/raw/react-frontend-plugins/contrib/nodeck.sh)`
|
|
- [Here's how to get the Steam Deck UI on your enviroment of choice.](https://youtu.be/1IAbZte8e7E?t=112)
|
|
- (The video shows Windows usage but unless you're using Arch WSL/cygwin this script is unsupported on Windows.)
|
|
|
|
To run your development version of Plugin Loader on Deck, run a command like this:
|
|
```bash
|
|
ssh deck@steamdeck 'export PLUGIN_PATH=/home/deck/loaderdev/plugins; export CHOWN_PLUGIN_PATH=0; echo 'password' | sudo -SE python3 /home/deck/loaderdev/pluginloader/backend/main.py'
|
|
```
|
|
|
|
Or on PC with the Deck UI enabled:
|
|
```bash
|
|
export PLUGIN_PATH=/home/user/installdirectory/plugins;
|
|
export CHOWN_PLUGIN_PATH=0;
|
|
sudo python3 /home/deck/loaderdev/pluginloader/backend/main.py
|
|
```
|
|
|
|
Source control and deploying plugins are left to each respective contributor for the cloned repos in order to keep depedencies up to date.
|
|
|
|
## Credit
|
|
|
|
The original idea for the concept is based on the work of [marios8543's steamdeck-ui-inject](https://github.com/marios8543/steamdeck-ui-inject) project.
|