PowerTools/README.md

58 lines
3.8 KiB
Markdown
Raw Normal View History

2022-04-18 22:27:08 +01:00
# PowerTools
2023-08-25 00:26:36 +01:00
<!-- TODO Update badges for new git repo location -->
2023-03-28 03:17:59 +01:00
[![Decky store](https://img.shields.io/badge/dynamic/json?color=blue&label=release&query=%24%5B%3F%28%40.name%3D%3D%27PowerTools%27%29%5D.versions%5B0%5D.name&url=https%3A%2F%2Fplugins.deckbrew.xyz%2Fplugins&style=flat-square)](https://plugins.deckbrew.xyz/)
2024-06-13 23:37:46 +01:00
[![Custom store](https://img.shields.io/badge/dynamic/json?color=blue&label=preview&query=%24%5B%3F%28%40.name%3D%3D%27PowerTools%27%29%5D.versions%5B0%5D.name&url=https%3A%2F%2Fnot-decky-alpha.ngni.us%2Fplugins&style=flat-square)](https://git.ngni.us/NG-SD-Plugins/PowerTools/wiki)
2023-08-25 00:26:36 +01:00
[![GitHub package.json version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgit.ngni.us%2FNG-SD-Plugins%2FPowerTools%2Fraw%2Fbranch%2Fmain%2Fpackage.json&query=%24.version&style=flat-square&label=local&cacheSeconds=600)](https://git.ngni.us/NG-SD-Plugins/PowerTools/src/branch/main/package.json)
2023-03-28 03:17:59 +01:00
[![Liberapay](https://img.shields.io/liberapay/patrons/NGnius?style=flat-square)](https://liberapay.com/NGnius)
2024-06-13 23:37:46 +01:00
[![GitHub](https://img.shields.io/badge/GPL--3.0-orange?style=flat-square&label=license&cacheSeconds=600)](https://git.ngni.us/NG-SD-Plugins/PowerTools/blob/main/LICENSE)
[![GitHub package.json dependency version (local)](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgit.ngni.us%2FNG-SD-Plugins%2FPowerTools%2Fraw%2Fbranch%2Fmain%2Fpackage.json&query=%24..%5B'decky-frontend-lib'%5D&style=flat-square&label=decky-frontend-lib&cacheSeconds=600)](https://git.ngni.us/NG-SD-Plugins/PowerTools/blob/main/pnpm-lock.yaml)
2023-03-28 03:17:59 +01:00
![plugin_demo](./assets/ui.png)
2022-04-21 23:15:41 +01:00
Steam Deck power tweaks for power users.
2022-04-18 22:21:51 +01:00
This is generated from the template plugin for the [Decky Plugin Loader](https://github.com/SteamDeckHomebrew/decky-loader).
2022-05-03 01:33:40 +01:00
You will need that installed for this plugin to work.
2022-04-18 22:21:51 +01:00
2022-05-04 15:37:32 +01:00
## What does it do?
- Enable & disable CPU threads & SMT
- Set CPU frequencies
- Set GPU frequencies and power (fastPPT & slowPPT)
2024-06-13 23:37:46 +01:00
- Cap battery charge level
2022-05-04 15:37:32 +01:00
- Display supplementary battery info
2024-06-13 23:37:46 +01:00
- Keep settings between restarts (stored in `~/homebrew/settings/PowerTools/<appId>.ron`)
2022-05-04 15:37:32 +01:00
2024-06-13 23:37:46 +01:00
This plugin is tested on Steam Deck LCD/OLED, but is designed to work on other Linux devices as well. Unfortunately I am currently unable to test on most other devices.
2023-08-25 00:26:36 +01:00
2022-09-09 01:04:07 +01:00
## Install
2023-08-25 00:26:36 +01:00
Please use Decky's [built-in store](https://plugins.deckbrew.xyz/) to install official releases.
If you want to test unstable versions, use [my custom store](https://not-decky-alpha.ngni.us/plugins). If you would like to use an in-development version, feel free to build PowerTools yourself.
2022-09-09 01:04:07 +01:00
2024-06-13 23:37:46 +01:00
## Build/Deploy
2022-09-06 22:29:42 +01:00
2023-08-25 00:26:36 +01:00
0. Requirements: a functioning Rust toolchain for x86_64-unknown-linux-gnu (or -musl), pnpm, and some tech literacy
2022-09-06 22:29:42 +01:00
1. In a terminal, navigate to the backend directory of this project and run `./build.sh`
2023-08-25 00:26:36 +01:00
2. In the root of this project, run `pnpm run build`
3. Transfer the project (especially dist/ and bin/) to a folder in your Steam Deck's `~/homebrew/plugins` directory
2024-06-13 23:37:46 +01:00
4. Restart Decky with `sudo systemctl restart plugin_loader.service`
2022-09-06 22:29:42 +01:00
2022-04-18 22:21:51 +01:00
## License
2022-04-18 22:27:08 +01:00
This is licensed under GNU GPLv3.
2024-06-13 23:37:46 +01:00
## Contributing
All contributions are welcome!
Anything from a comment on an issue to a new feature pull request will be appreciated by PowerTools's crack team of one (NGnius).
### Translations
Adding new languages and keeping existing language files up to date makes PowerTools more accessible to the majority of the world which doesn't speak English. Take a look at [this comment](https://git.ngni.us/NG-SD-Plugins/PowerTools/issues/9#issuecomment-345) (and the rest of that issue) to get started.
### Code
To prevent spam, this server does not allow regular users to create/fork repositories. Please open an issue [here](https://git.ngni.us/sys/website) to request permission. There's no pressure to actually do anything with that permission, though it may be revoked when the server is running low on space.