Skip to content

Commit cce0001

Browse files
Update README.md
Updated simple install instructions.
1 parent 61c3c07 commit cce0001

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# Ally Center
2-
32
A comprehensive Decky Loader plugin for the **ASUS ROG Ally** running SteamOS.
43

54
## Features
6-
75
- **🖥️ Screen Off Mode** - Turn off the display for background downloads to save battery
86
- **⚡ Performance Profiles** - Quick switch between Silent (15W), Performance (25W), and Turbo (30W) modes
97
- **🔋 Battery Health** - Monitor battery health, cycle count, temperature, and set charge limits
@@ -17,7 +15,6 @@ A comprehensive Decky Loader plugin for the **ASUS ROG Ally** running SteamOS.
1715
![AllyCenter Screenshot](images/5.png)
1816

1917
## Requirements
20-
2118
- ASUS ROG Ally or ROG Ally X
2219
- SteamOS (or compatible distro like Bazzite, ChimeraOS)
2320
- [Decky Loader](https://github.com/SteamDeckHomebrew/decky-loader) installed
@@ -26,25 +23,41 @@ A comprehensive Decky Loader plugin for the **ASUS ROG Ally** running SteamOS.
2623

2724
### Quick Install (Recommended)
2825

26+
**Important:** The installation script must be run directly on your ROG Ally or via SSH connection to your Ally. It cannot be run from your PC.
27+
28+
**On your ROG Ally:**
29+
1. Switch to Desktop Mode
30+
2. Open Konsole (terminal)
31+
3. Run the following command:
32+
2933
```bash
3034
curl -L https://github.com/PixelAddictUnlocked/allycenter/raw/main/install.sh | sh
3135
```
3236

33-
### Manual Install
37+
**Or via SSH from another computer:**
38+
```bash
39+
ssh deck@<your-ally-ip>
40+
curl -L https://github.com/PixelAddictUnlocked/allycenter/raw/main/install.sh | sh
41+
```
3442

43+
The installer will:
44+
- Download the latest prebuilt release
45+
- Install to the correct plugin directory
46+
- Automatically restart Decky Loader
47+
- The plugin will be ready to use immediately
48+
49+
### Manual Install
3550
1. Download the latest release from the [Releases](https://github.com/PixelAddictUnlocked/allycenter/releases) page
3651
2. Extract to `~/homebrew/plugins/Ally Center/`
3752
3. Restart Decky Loader or reboot
3853

3954
## Development
4055

4156
### Prerequisites
42-
4357
- Node.js v16.14+
4458
- pnpm v9
4559

4660
### Setup
47-
4861
```bash
4962
# Clone the repository
5063
git clone https://github.com/PixelAddictUnlocked/allycenter.git
@@ -58,12 +71,10 @@ pnpm run build
5871
```
5972

6073
### Deploy to ROG Ally
61-
6274
1. Edit `.vscode/settings.json` with your ROG Ally's IP address and SSH credentials
6375
2. Run the deploy task in VSCode: `Ctrl+Shift+P``Tasks: Run Task``deploy-restart`
6476

6577
Or manually:
66-
6778
```bash
6879
# Build
6980
pnpm run build
@@ -76,18 +87,15 @@ ssh deck@192.168.1.100 'sudo systemctl restart plugin_loader'
7687
```
7788

7889
### Debugging
79-
8090
1. On ROG Ally: Decky Settings → Developer → Enable "Allow Remote CEF Debugging"
8191
2. On your PC: Open Chrome and navigate to `chrome://inspect/#devices`
8292
3. Click Configure and add `<ally-ip>:8081`
8393
4. Click "inspect" on the QuickAccess target
8494

8595
## Configuration
86-
8796
Settings are stored in `~/homebrew/settings/Ally Center/settings.json`
8897

8998
## Hardware Support
90-
9199
| Feature | ROG Ally | ROG Ally X |
92100
| -------------------- | -------- | ---------- |
93101
| Screen Off |||
@@ -98,15 +106,12 @@ Settings are stored in `~/homebrew/settings/Ally Center/settings.json`
98106
| Device Info |||
99107

100108
## License
101-
102109
MIT License - see [LICENSE](LICENSE) for details.
103110

104111
## Credits
105-
106112
- [Decky Loader](https://github.com/SteamDeckHomebrew/decky-loader) - Plugin framework
107113
- [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) - UI components
108114

109115
## Support
110-
111116
- [GitHub Issues](https://github.com/PixelAddictUnlocked/allycenter/issues)
112117
- [Discord](https://discord.gg/pixeladdictgames)

0 commit comments

Comments
 (0)