summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTrainDoctor <11465594+TrainDoctor@users.noreply.github.com>2022-06-02 15:24:24 -0700
committerGitHub <noreply@github.com>2022-06-02 18:24:24 -0400
commitcadb687cd75eaedef188a08673111637bcd304fa (patch)
tree4502733c7273119337d85cc2788d2cc3bef24abc /README.md
parent1114d5593171f051c3cb65f96a2a5ce46e89d13f (diff)
downloaddecky-loader-cadb687cd75eaedef188a08673111637bcd304fa.tar.gz
decky-loader-cadb687cd75eaedef188a08673111637bcd304fa.zip
Add contributor install script (#69)
* Add contributor install script * Switched to non-tmp directory * Fixed potential issue with passwords being not being parsed properly * Replace up hardcoded ports and silence npm * Removed legacy support version, changed to https git clones * Add non-deck compatible version of script * Switch to arguments parsed while running script for contrib pc * Now compatible with curl install from terminal, but it's a bit fragile * Incorrect install directory for plugintemplate * Functionalized a ton of stuff * Changed in anticipation of merge to react-frontend-plugins branch * Added guide to enable Steam Deck UI and clarification about Windows * Moved contribution scripts to contrib and provided "how to run" * Reordered README for clarity and better placement for contribution sect. * Looks better * Removed un-needed file-transfers and added better checks and run info * Improved how to run given at end of script. * Improved warning, improved ssh invocation globally and how-to-use/run * Link to new plugin template and added link to the wiki in readme * testing for remote invocation * Fixed bug with invocation via curl * Just in case...
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 29 insertions, 7 deletions
diff --git a/README.md b/README.md
index bc9d7a38..be3008d4 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,8 @@
![steamuserimages-a akamaihd](https://user-images.githubusercontent.com/10835354/161068262-ca723dc5-6795-417a-80f6-d8c1f9d03e93.jpg)
+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`
@@ -17,10 +19,10 @@
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 developers:
+ - For plugin developers:
~~- `curl -L https://github.com/SteamDeckHomebrew/PluginLoader/raw/main/dist/install_nightly.sh | sh`~~
Nightly releases are currently broken.
-8. Done! Reboot back into Gaming mode and enjoy your plugins!
+7. Done! Reboot back into Gaming mode and enjoy your plugins!
### Install Plugins
- Simply copy the plugin's folder into `~/homebrew/plugins`
@@ -30,9 +32,6 @@
- For both users and developers:
- `curl -L https://github.com/SteamDeckHomebrew/PluginLoader/raw/main/dist/uninstall.sh | sh`
-### Developing plugins
-- There is no complete plugin development documentation yet. However a good starting point is the [Plugin Template](https://github.com/SteamDeckHomebrew/Plugin-Template) repository
-
## Features
- Clean injecting and loading of one or more plugins
- Persistent. It doesn't need to be reinstalled after every system update
@@ -40,9 +39,32 @@
- Allows plugins to define python functions and run them from javascript.
- Allows plugins to make fetch calls, bypassing cors completely.
-## Caveats
+## 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):
+ - `curl -L https://github.com/SteamDeckHomebrew/PluginLoader/raw/react-frontend-plugins/contrib/deck.sh | sh`
+- For PluginLoader contributors (without a Steam Deck):
+ - `curl -L https://github.com/SteamDeckHomebrew/PluginLoader/raw/react-frontend-plugins/contrib/pc.sh | 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 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
+```
-- You can only interact with the Plugin Menu via touchscreen.
+Source control and deploying plugins are left to each respective contributor for the cloned repos in order to keep depedencies up to date.
## Credit