Skip to content

Commit 34183aa

Browse files
committed
Updated readme
1 parent 7900da6 commit 34183aa

File tree

1 file changed

+83
-62
lines changed

1 file changed

+83
-62
lines changed

README.md

Lines changed: 83 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,63 @@
11
# Ally Center
2-
A comprehensive Decky Loader plugin for the **ASUS ROG Ally** running SteamOS.
32

4-
## Features
5-
- **🖥️ Screen Off Mode** - Turn off the display for background downloads to save battery
6-
- **⚡ Performance Profiles** - Quick switch between Silent (15W), Performance (25W), and Turbo (30W) modes
7-
- **🔋 Battery Health** - Monitor battery health, cycle count, temperature, and set charge limits
8-
- **💡 RGB Lighting** - Control RGB colors, brightness, and effects (static, breathing, rainbow)
9-
- **📱 Device Info** - View system information including CPU, GPU, BIOS, and kernel version
3+
A comprehensive Decky Loader plugin for the **ASUS ROG Ally** running SteamOS.
104

115
![AllyCenter Screenshot](images/1.png)
126
![AllyCenter Screenshot](images/2.png)
137
![AllyCenter Screenshot](images/3.png)
148
![AllyCenter Screenshot](images/4.png)
159
![AllyCenter Screenshot](images/5.png)
1610

11+
## Features
12+
13+
### Download Mode
14+
15+
Turn off the display for background downloads to save battery. When enabled:
16+
17+
- Screen brightness set to 0 (OLED pixels off)
18+
- Automatically switches to 5W power profile
19+
- RGB lighting disabled
20+
- MCU powersave enabled (stops charging LED blink)
21+
- Open the Quick Access Menu to exit
22+
23+
### Performance
24+
25+
- **Performance Presets** - Quick switch between Download (5W), Silent (15W), Performance (25W), and Turbo (30W) modes
26+
- **TDP Override** - Manually set TDP from 5W to 30W with fine-grained control
27+
- **Fan Mode** - Choose between Auto, Quiet, Balanced, and Performance fan profiles
28+
- **Live Monitoring** - View current CPU and GPU temperatures in real-time
29+
30+
### CPU Settings
31+
32+
- **SMT (Hyper-Threading)** - Toggle on/off for better single-thread performance in some games
33+
- **CPU Boost** - Disable to reduce heat and power consumption
34+
35+
### Battery
36+
37+
- **Charge Level** - Current battery percentage and charging status
38+
- **Battery Health** - Monitor battery health percentage
39+
- **Detailed Stats** - View cycle count, voltage, design capacity, current capacity, and temperature
40+
- **Charge Limit** - Set maximum charge level (60-100%) to extend battery lifespan
41+
42+
### RGB Lighting
43+
44+
- **Color Selection** - Full color spectrum slider with preset colors (ROG Red, Cyan, Purple, Green, Orange, Pink, White, Blue)
45+
- **Brightness Control** - Adjust LED brightness from 0-100%
46+
- **Effects** - Static, Pulse, Spectrum, Wave, Flash, Battery Level, or Off
47+
- **Speed Control** - Adjust animation speed for animated effects
48+
49+
### Device Info
50+
51+
View detailed system information:
52+
53+
- CPU model
54+
- GPU model
55+
- Memory total
56+
- BIOS version
57+
- Kernel version
58+
1759
## Requirements
60+
1861
- ASUS ROG Ally or ROG Ally X
1962
- SteamOS (or compatible distro like Bazzite, ChimeraOS)
2063
- [Decky Loader](https://github.com/SteamDeckHomebrew/decky-loader) installed
@@ -23,95 +66,73 @@ A comprehensive Decky Loader plugin for the **ASUS ROG Ally** running SteamOS.
2366

2467
### Quick Install (Recommended)
2568

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.
69+
**Important:** Run this directly on your ROG Ally or via SSH.
2770

2871
**On your ROG Ally:**
72+
2973
1. Switch to Desktop Mode
3074
2. Open Konsole (terminal)
31-
3. Run the following command:
75+
3. Run:
3276

3377
```bash
3478
curl -L https://github.com/PixelAddictUnlocked/allycenter/raw/main/install.sh | sh
3579
```
3680

37-
**Or via SSH from another computer:**
81+
**Via SSH:**
82+
3883
```bash
3984
ssh deck@<your-ally-ip>
4085
curl -L https://github.com/PixelAddictUnlocked/allycenter/raw/main/install.sh | sh
4186
```
4287

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
88+
The installer will download the latest release, install it, and restart Decky Loader automatically.
4889

4990
### Manual Install
91+
5092
1. Download the latest release from the [Releases](https://github.com/PixelAddictUnlocked/allycenter/releases) page
5193
2. Extract to `~/homebrew/plugins/Ally Center/`
5294
3. Restart Decky Loader or reboot
5395

54-
## Development
96+
## Usage
5597

56-
### Prerequisites
57-
- Node.js v16.14+
58-
- pnpm v9
98+
1. Press the **...** button on your ROG Ally to open the Quick Access Menu
99+
2. Navigate to the **Decky** plugin icon (plug icon)
100+
3. Select **Ally Center** from the plugin list
101+
4. Use the toggles, sliders, and buttons to control your device
59102

60-
### Setup
61-
```bash
62-
# Clone the repository
63-
git clone https://github.com/PixelAddictUnlocked/allycenter.git
64-
cd allycenter
65-
66-
# Install dependencies
67-
pnpm install
68-
69-
# Build the plugin
70-
pnpm run build
71-
```
103+
## Hardware Support
72104

73-
### Deploy to ROG Ally
74-
1. Edit `.vscode/settings.json` with your ROG Ally's IP address and SSH credentials
75-
2. Run the deploy task in VSCode: `Ctrl+Shift+P``Tasks: Run Task``deploy-restart`
105+
| Feature | ROG Ally | ROG Ally X |
106+
| ------------------- | -------- | ---------- |
107+
| Download Mode |||
108+
| Performance Presets |||
109+
| TDP Override |||
110+
| Fan Control |||
111+
| CPU Settings |||
112+
| Battery Health |||
113+
| Charge Limit |||
114+
| RGB Lighting |||
115+
| Device Info |||
76116

77-
Or manually:
78-
```bash
79-
# Build
80-
pnpm run build
117+
## Settings
81118

82-
# Copy to device (replace IP with your Ally's IP)
83-
rsync -azp --delete . deck@192.168.1.100:~/homebrew/plugins/Ally\ Center/
119+
Your preferences are automatically saved and restored between sessions. Settings are stored in:
84120

85-
# Restart Decky Loader
86-
ssh deck@192.168.1.100 'sudo systemctl restart plugin_loader'
87121
```
88-
89-
### Debugging
90-
1. On ROG Ally: Decky Settings → Developer → Enable "Allow Remote CEF Debugging"
91-
2. On your PC: Open Chrome and navigate to `chrome://inspect/#devices`
92-
3. Click Configure and add `<ally-ip>:8081`
93-
4. Click "inspect" on the QuickAccess target
94-
95-
## Configuration
96-
Settings are stored in `~/homebrew/settings/Ally Center/settings.json`
97-
98-
## Hardware Support
99-
| Feature | ROG Ally | ROG Ally X |
100-
| -------------------- | -------- | ---------- |
101-
| Screen Off |||
102-
| Performance Profiles |||
103-
| Battery Health |||
104-
| Charge Limit |||
105-
| RGB Lighting |||
106-
| Device Info |||
122+
~/homebrew/settings/Ally Center/settings.json
123+
```
107124

108125
## License
126+
109127
MIT License - see [LICENSE](LICENSE) for details.
110128

111129
## Credits
130+
112131
- [Decky Loader](https://github.com/SteamDeckHomebrew/decky-loader) - Plugin framework
113-
- [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) - UI components
132+
- [HueSync](https://github.com/honjow/HueSync) - RGB inspiration
133+
- [ASUS Linux](https://asus-linux.org) - Hardware documentation
114134

115135
## Support
136+
116137
- [GitHub Issues](https://github.com/PixelAddictUnlocked/allycenter/issues)
117138
- [Discord](https://discord.gg/pixeladdictgames)

0 commit comments

Comments
 (0)