Updated Customization (markdown)

NGnius (Graham) 2023-02-03 04:12:48 +00:00
parent 1b60440484
commit a3bd863417

@ -2,7 +2,7 @@ As of v1.1.0, PowerTools supports customizing values for most functionality. Thi
# Steam Deck
The Steam Deck driver has an optional advanced mode which is activated when a valid `pt_oc.json` JSON file is present in the `~/.config/powertools` folder. This file roughly reflects the design of PowerTools internal Steam Deck drivers.
The Steam Deck driver has an optional advanced mode which is activated when a valid `pt_oc.json` JSON file is present in the `~/.config/powertools` folder. No values are optional. Any file error will be logged to `/tmp/powertools-rs.log` (release builds) and the default config will be used instead. This file roughly reflects the design of PowerTools internal Steam Deck drivers.
The structure and default values are defined in [oc_limits.rs](https://github.com/NGnius/PowerTools/blob/dev/backend/src/settings/steam_deck/oc_limits.rs). If you do not understand the [JSON sample](https://github.com/NGnius/PowerTools/blob/dev/pt_oc.json) as well as the [Rust declaration](https://github.com/NGnius/PowerTools/blob/dev/backend/src/settings/steam_deck/oc_limits.rs) you should not use this feature.
@ -68,4 +68,6 @@ GPU frequency slider quanta. This is a `u64`.
# Other AMD APUs
// TODO
The generic driver is part of a more sophisticated system to automatically detect which driver and which config need to be loaded for the system that PowerTools is running on. This information is cached in `limits_cache.json` in the `~/.config/powertools` folder. Loading behaviour is similar to `pt_oc.json` except `limits_cache.json` will also be updated by PowerTools daily by downloading the latest version from the URL in the file.
The structure and default values are defined in the [limits_core crate](https://github.com/NGnius/PowerTools/tree/dev/backend/limits_core/src/json). The automatic detection and configuration of the generic AMD drivers are handled by [auto_detect.rs](https://github.com/NGnius/PowerTools/blob/dev/backend/src/settings/detect/auto_detect.rs). That should be used as the ultimate source of truth, since this documentation cannot communicate that functionality as exhaustively or effectively.