Compare commits
3 commits
Author | SHA1 | Date | |
---|---|---|---|
bf7b5617b2 | |||
fadf492aac | |||
921f360e9e |
6 changed files with 67 additions and 13 deletions
6
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
6
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
|
@ -20,7 +20,7 @@ body:
|
|||
id: reproduction
|
||||
attributes:
|
||||
label: Steps To Reproduce
|
||||
description: Steps to reproduce the behavior
|
||||
description: Steps to reproduce the behaviour.
|
||||
placeholder: |
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
|
@ -33,12 +33,12 @@ body:
|
|||
attributes:
|
||||
label: Anything else?
|
||||
description: |
|
||||
Screenshots? Logs? pt_oc.json? limits_overrides.json? Anything that will give more context about the problem!
|
||||
Screenshots? Logs? limits_overrides.ron? limits_cache.ron? Anything that will give more context about the problem!
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
Please include the log (located at `/tmp/powertools.log`) if possible.
|
||||
Note: the log is deleted when the device is restarted.
|
||||
|
||||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
|
||||
Tip: You can attach files by clicking this area to highlight it and then dragging them in.
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
|
|
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
|
@ -1,5 +1,5 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: NGnius
|
||||
url: https://github.com/NGnius
|
||||
url: https://git.ngni.us/sys/website/wiki#contact-information
|
||||
about: Repository owner
|
||||
|
|
8
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
8
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
|
@ -3,7 +3,7 @@ description: Suggest functionality to add
|
|||
labels: "enhancement"
|
||||
body:
|
||||
- type: textarea
|
||||
id: described
|
||||
id: feature-description
|
||||
attributes:
|
||||
label: Describe what you'd like to be able to do
|
||||
description: A clear and concise description of what you want.
|
||||
|
@ -22,7 +22,11 @@ body:
|
|||
id: extras
|
||||
attributes:
|
||||
label: Anything else?
|
||||
description: Description of how this can be achieved, or other additional context
|
||||
description: |
|
||||
Description of how this can be achieved, or other additional context.
|
||||
If this is related to the UI, consider adding a picture.
|
||||
|
||||
Tip: You can attach files by clicking this area to highlight it and then dragging them in.
|
||||
placeholder: This can be accomplished by doing ...
|
||||
validations:
|
||||
required: false
|
||||
|
|
23
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
23
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
|
@ -0,0 +1,23 @@
|
|||
name: "Question"
|
||||
description: "Ask for more information about PowerTools"
|
||||
labels: "question"
|
||||
body:
|
||||
- type: textarea
|
||||
id: question-elaboration
|
||||
attributes:
|
||||
label: Question
|
||||
description: |
|
||||
A clear and concise description of what you'd like to know.
|
||||
Please check the wiki and closed issues to avoid waiting for an answer when you didn't need to.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: extras
|
||||
attributes:
|
||||
label: Extra Info
|
||||
description: |
|
||||
Additional context or information which may be helpful when answering your question.
|
||||
|
||||
Tip: You can attach files by clicking this area to highlight it and then dragging them in.
|
||||
validations:
|
||||
required: false
|
13
.github/pull_request_template.md
vendored
Normal file
13
.github/pull_request_template.md
vendored
Normal file
|
@ -0,0 +1,13 @@
|
|||
## Description
|
||||
|
||||
A short description of what the PR changes.
|
||||
If this is a minor change and the commit message(s) explains it well, feel free to delete this section.
|
||||
|
||||
## Motivation
|
||||
|
||||
Why did you write this PR and/or why should it be accepted.
|
||||
|
||||
## Fixes
|
||||
|
||||
Please indicate issues that this fixes or addresses here.
|
||||
If this is a bugfix with no pre-existing issue, please describe the bug here instead.
|
28
README.md
28
README.md
|
@ -1,12 +1,12 @@
|
|||
# PowerTools
|
||||
<!-- TODO Update badges for new git repo location -->
|
||||
[![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/)
|
||||
[![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://github.com/NGnius/PowerTools/wiki)
|
||||
[![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)
|
||||
[![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)
|
||||
|
||||
[![Liberapay](https://img.shields.io/liberapay/patrons/NGnius?style=flat-square)](https://liberapay.com/NGnius)
|
||||
[![GitHub](https://img.shields.io/badge/GPL--3.0-orange?style=flat-square&label=license&cacheSeconds=600)](https://github.com/NGnius/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://github.com/NGnius/PowerTools/blob/main/pnpm-lock.yaml)
|
||||
[![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)
|
||||
|
||||
![plugin_demo](./assets/ui.png)
|
||||
|
||||
|
@ -20,24 +20,38 @@ You will need that installed for this plugin to work.
|
|||
- Enable & disable CPU threads & SMT
|
||||
- Set CPU frequencies
|
||||
- Set GPU frequencies and power (fastPPT & slowPPT)
|
||||
- Cap battery charge rate (when awake)
|
||||
- Cap battery charge level
|
||||
- Display supplementary battery info
|
||||
- Keep settings between restarts (stored in `~/.config/powertools/<gameId>.json`)
|
||||
- Keep settings between restarts (stored in `~/homebrew/settings/PowerTools/<appId>.ron`)
|
||||
|
||||
This plugin is tested on Steam Deck, but is designed to work on other Linux devices as well. Unfortunately I am currently unable to test on other devices.
|
||||
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.
|
||||
|
||||
## Install
|
||||
|
||||
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.
|
||||
|
||||
## Build
|
||||
## Build/Deploy
|
||||
|
||||
0. Requirements: a functioning Rust toolchain for x86_64-unknown-linux-gnu (or -musl), pnpm, and some tech literacy
|
||||
1. In a terminal, navigate to the backend directory of this project and run `./build.sh`
|
||||
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
|
||||
4. Restart Decky with `sudo systemctl restart plugin_loader.service`
|
||||
|
||||
## License
|
||||
|
||||
This is licensed under GNU GPLv3.
|
||||
|
||||
## 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.
|
||||
|
|
Loading…
Reference in a new issue