summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortranch <tranch.xiao@gmail.com>2026-02-06 08:50:12 +0800
committertranch <tranch.xiao@gmail.com>2026-02-06 08:50:12 +0800
commit9f4d58a45c199f5fac1f47c6b5e365ecc0e15a7c (patch)
tree9f0e663f407569f3e966dd00213ed1c0629f93b9
parent28d026e3e346ef43aa0220eabc837e2263e947a8 (diff)
downloaddecky-installer-9f4d58a45c199f5fac1f47c6b5e365ecc0e15a7c.tar.gz
decky-installer-9f4d58a45c199f5fac1f47c6b5e365ecc0e15a7c.zip
feat: Rework README for AeroCore Accelerator installer
Update the README to reflect the shift from a generic Decky Installer mirror to the AeroCore Accelerator installer. Simplify instructions and clarify the purpose. Co-authored-by: llm-git <llm-git@ttll.de>
-rw-r--r--README.md80
1 files changed, 10 insertions, 70 deletions
diff --git a/README.md b/README.md
index 9747125..68bec45 100644
--- a/README.md
+++ b/README.md
@@ -1,76 +1,16 @@
-# Decky Installer
+# AeroCore Accelerator Installer
-A local mirror version of the Decky Installer for Steam Deck. This repository allows users to install Decky plugins without relying on the official Decky Installer servers.
+This repository contains the installer assets and a clear view of the installation flow for AeroCore Accelerator.
-## Features
+## Install
-- 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
+1. On Steam Deck or another SteamOS-like device, download `decky_installer.desktop`.
+2. Double-click `decky_installer.desktop` to start the automated setup.
-## 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.
-
-### Command Structure
-
-The `decky_client.py` script uses subcommands for different operations:
-
-```bash
-# Install a plugin
-python3 decky_client.py install [options]
-
-# Configure custom store URL
-python3 decky_client.py configure-store <url>
-
-# 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"
-```
-
-#### Get the Currently Configured Store URL
-```bash
-python3 decky_client.py get-store
-```
-
-#### Install from a Custom Store
-```bash
-python3 decky_client.py install --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_client.py install --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
+## What It Does
+- Installs Decky Loader if it is not already installed.
+- Installs the AeroCore Accelerator plugin inside Decky Loader.
+- Sets Decky Loader's plugin store URL to AeroCore's regional mirror, which keeps in sync with the official store.
+- Completes the setup so the accelerator is ready to use.