From Pre-Release 2.5.2-pre1 onward, decky provides these environment variables to each plugin and any other subprocesses it runs from python. These variables can be accessed by using the built-in os python module or the decky_plugin interface available in the plugin template.
# Examples:
import os
homeDir = os.environ['HOME']
homeDir = os.environ.get('HOME')
import decky_plugin
homeDir = decky_plugin.HOME
| Environment Variable | Description | Decky Version | Example Return |
USER |
The username of the effective user running the process.[1] | v2.5.2-pre1+ | root or deck |
USER_ID |
0 or 1000 |
||
HOME |
The home directory of the effective user running the process.[1:2] | v2.5.2-pre1+ | /root or /home/deck |
DECKY_USER |
The username of the user whose home decky resides in. | v2.5.2-pre1+ | deck |
DECKY_USER_ID |
1000 |
||
DECKY_USER_HOME |
The home of the user where decky resides in. | v2.6.0-pre1+ | /home/deck |
DECKY_VERSION |
The running version of the decky loader. | v2.5.2-pre1+ | v2.5.0-pre1 |
DECKY_HOME |
The root of the decky folder | v2.5.2-pre1+ | /home/deck/homebrew |
DECKY_PLUGIN_SETTINGS_DIR |
The recommended path in which to store configuration files (created automatically) | v2.5.2-pre1+ | /home/deck/homebrew/settings/<plugin-name> |
DECKY_PLUGIN_RUNTIME_DIR |
The recommended path in which to store runtime data (created automatically) | v2.5.2-pre1+ | /home/deck/homebrew/data/<plugin-name> |
DECKY_PLUGIN_LOG_DIR |
The recommended path in which to store persistent logs (created automatically) | v2.5.2-pre1+ | /home/deck/homebrew/logs/<plugin-name> |
DECKY_PLUGIN_DIR |
The root of the plugin's directory | v2.5.2-pre1+ | /home/deck/homebrew/plugins/<plugin-name> |
DECKY_PLUGIN_NAME |
The name of the plugin as specified in the plugin.json |
v2.5.2-pre1+ | Example Plugin |
DECKY_PLUGIN_AUTHOR |
The author of the plugin as specified in the plugin.json |
v2.5.2-pre1+ | John Doe |
DECKY_PLUGIN_VERSION |
The version of the plugin as specified in the package.json |
v2.5.2-pre1+ | 0.0.1 |