Add Directory Structure

NGnius 2024-05-05 02:38:37 +01:00
parent 71e6964fcc
commit cc259ac54d

31
Directory-Structure.md Normal file

@ -0,0 +1,31 @@
PowerTools needs to store some things persistently on the local device for functionality. The locations and usages are contained below.
# Logs
## Release
Logs are written to the `/tmp/powertools.log` file.
## Debug
Logs are written to the `~/powertools.log` file.
# Settings profiles
The filename format is `<app_id>.ron` where `<app_id>` is the game's AppId, or `default_settings` for no game (main menu settings). The file format is RON with the file structure base defined in [file.rs](https://git.ngni.us/NG-SD-Plugins/PowerTools/src/branch/main/backend/src/persist/file.rs).
## Decky
Per-game settings are stored by Steam AppId in `~/homebrew/settings/PowerTools`.
## Other
Everything is unceremoniously dumped into `/tmp`.
# Executable files
## Decky
Decky installs PowerTools to the `~/homebrew/plugins/PowerTools` folder.
## Other
This is arbitrary i.e. user-defined