From 6f40607b692ee4be76b954ec647fc0d8617c86bb Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Feb 2026 13:51:40 +0000 Subject: Update README with custom store configuration documentation Co-authored-by: tranch <5999732+tranch@users.noreply.github.com> --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3dda5ed..bfa1184 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,55 @@ A local mirror version of the Decky Installer for Steam Deck. This repository al - Local hosting of Decky Installer files - Easy installation of Decky plugins - No dependency on external servers +- **Custom store configuration support** - Configure and use custom plugin store URLs ## Usage +### Basic Plugin Installation + 1. Download the `user_install_script.sh` or the `decky_installer.desktop` file from the releases section. 2. Place the downloaded file in a convenient location on your Steam Deck. 3. Run the script or launch the desktop file to start the Decky Installer. +### Custom Store Configuration + +The installer now supports configuring custom plugin store URLs: + +#### Configure a Custom Store URL +```bash +python3 decky_plugin_installer.py --configure-store "https://your-custom-store.com/plugins" +``` + +#### Get the Currently Configured Store URL +```bash +python3 decky_plugin_installer.py --get-store +``` + +#### Install from a Custom Store +```bash +python3 decky_plugin_installer.py --target-id 42 --store-url "https://your-custom-store.com/plugins" +``` + +## Mock Server for Testing + +This repository includes a mock Decky Loader server for testing purposes: + +### Start the Mock Server +```bash +python3 mock_decky_server.py --auto-confirm +``` + +### Test with the Mock Server +```bash +python3 decky_plugin_installer.py --target-id 42 +``` + +The mock server implements the following Decky Loader backend routes: +- `utilities/ping` - Health check +- `utilities/install_plugin` - Plugin installation +- `utilities/confirm_plugin_install` - Confirm installation +- `utilities/cancel_plugin_install` - Cancel installation +- `utilities/settings/get` - Get configuration settings +- `utilities/settings/set` - Set configuration settings + -- cgit v1.2.3 From 06d1b194d4ce46524bc03628ecdf15fa2e135e5f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Feb 2026 14:02:28 +0000 Subject: Rename decky_plugin_installer.py to decky_client.py Co-authored-by: tranch <5999732+tranch@users.noreply.github.com> --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bfa1184..53f0122 100644 --- a/README.md +++ b/README.md @@ -23,17 +23,17 @@ The installer now supports configuring custom plugin store URLs: #### Configure a Custom Store URL ```bash -python3 decky_plugin_installer.py --configure-store "https://your-custom-store.com/plugins" +python3 decky_client.py --configure-store "https://your-custom-store.com/plugins" ``` #### Get the Currently Configured Store URL ```bash -python3 decky_plugin_installer.py --get-store +python3 decky_client.py --get-store ``` #### Install from a Custom Store ```bash -python3 decky_plugin_installer.py --target-id 42 --store-url "https://your-custom-store.com/plugins" +python3 decky_client.py --target-id 42 --store-url "https://your-custom-store.com/plugins" ``` ## Mock Server for Testing @@ -47,7 +47,7 @@ python3 mock_decky_server.py --auto-confirm ### Test with the Mock Server ```bash -python3 decky_plugin_installer.py --target-id 42 +python3 decky_client.py --target-id 42 ``` The mock server implements the following Decky Loader backend routes: -- cgit v1.2.3 From a1164d396c54c8a7a3d17746b12c6e62816ed344 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Feb 2026 14:08:50 +0000 Subject: Refactor CLI to use subcommands for better semantics Co-authored-by: tranch <5999732+tranch@users.noreply.github.com> --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 53f0122..390f529 100644 --- a/README.md +++ b/README.md @@ -17,23 +17,38 @@ A local mirror version of the Decky Installer for Steam Deck. This repository al 2. Place the downloaded file in a convenient location on your Steam Deck. 3. Run the script or launch the desktop file to start the Decky Installer. +### Command Structure + +The `decky_client.py` script uses subcommands for different operations: + +```bash +# Install a plugin (default operation) +python3 decky_client.py install [options] + +# Configure custom store URL +python3 decky_client.py configure-store + +# Get configured store URL +python3 decky_client.py get-store +``` + ### Custom Store Configuration The installer now supports configuring custom plugin store URLs: #### Configure a Custom Store URL ```bash -python3 decky_client.py --configure-store "https://your-custom-store.com/plugins" +python3 decky_client.py configure-store "https://your-custom-store.com/plugins" ``` #### Get the Currently Configured Store URL ```bash -python3 decky_client.py --get-store +python3 decky_client.py get-store ``` #### Install from a Custom Store ```bash -python3 decky_client.py --target-id 42 --store-url "https://your-custom-store.com/plugins" +python3 decky_client.py install --target-id 42 --store-url "https://your-custom-store.com/plugins" ``` ## Mock Server for Testing @@ -47,7 +62,7 @@ python3 mock_decky_server.py --auto-confirm ### Test with the Mock Server ```bash -python3 decky_client.py --target-id 42 +python3 decky_client.py install --target-id 42 ``` The mock server implements the following Decky Loader backend routes: -- cgit v1.2.3 From 0b539e22aa9bcbd92fba3d416177e9f39cb93ec7 Mon Sep 17 00:00:00 2001 From: Tranch Date: Wed, 4 Feb 2026 23:16:15 +0800 Subject: Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 390f529..9747125 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ A local mirror version of the Decky Installer for Steam Deck. This repository al The `decky_client.py` script uses subcommands for different operations: ```bash -# Install a plugin (default operation) +# Install a plugin python3 decky_client.py install [options] # Configure custom store URL -- cgit v1.2.3