Development

Here's a few things you need to know when working with this repo.

Maintaining the repo

This framework integrates code from tk-core and tk-framework-desktopserver. Integrating a new version of the core or the framework can be done using the tk_core_update.sh and tk_framework_desktopserver_update.sh scripts respectively. Both need to be invoked with a GitHub tag name in order to update to a specific release.

Auto-updates

This framework auto-updates itself and the auto-updates are installed inside the user directory. Here's the location for each platform:

Windows: %APPDATA%\Shotgun\desktop\install\frameworks\app_store\tk-framework-desktopstartup\vX.Y.Z
MacOSX: ~/Library/Caches/Shotgun/desktop/install/frameworks/app_store/tk-framework-desktopstartup/vX.Y.Z
Linux: ~/.shotgun/desktop/install/frameworks/app_store/tk-framework-desktopstartup/vX.Y.Z

Debugging

There are a lot of environment variables that can be set for debugging. You can either set them on the command line or you can set them inside a special debugging file called debug.ini. They are documented here.

Here's the location of the debug.ini file for each platform:

Windows: %APPDATA%\Shotgun\desktop\config\debug.ini
MacOSX: ~/Library/Caches/Shotgun/desktop/config/debug.ini
Linux: ~/.shotgun/desktop/config/debug.ini