From cc259ac54d3f4db5f6282cc676e5d407cc612856 Mon Sep 17 00:00:00 2001 From: NGnius Date: Sun, 5 May 2024 02:38:37 +0100 Subject: [PATCH] Add Directory Structure --- Directory-Structure.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 Directory-Structure.md diff --git a/Directory-Structure.md b/Directory-Structure.md new file mode 100644 index 0000000..23a5a63 --- /dev/null +++ b/Directory-Structure.md @@ -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 `.ron` where `` 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 \ No newline at end of file