patkub / PluginLoader

A plugin loader for the Steam Deck

Home Page:https://deckbrew.xyz

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Plugin Loader Chat

steamuserimages-a akamaihd

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 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

  • 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

Developing plugins

  • There is no complete plugin development documentation yet. However a good starting point is the 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
  • 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.

Caveats

  • You can only interact with the Plugin Menu via touchscreen.

Credit

The original idea for the concept is based on the work of marios8543's steamdeck-ui-inject project.

About

A plugin loader for the Steam Deck

https://deckbrew.xyz

License:GNU General Public License v2.0


Languages

Language:Python 72.4%Language:JavaScript 17.1%Language:HTML 10.2%Language:CSS 0.3%