Home

Contents

• Installation
  • System Requirements
  • Installing the Shotgun API
  • Installing shotgunEvents
    • Cloning the source
    • Downloading the archive
  • Windows Specifics
• Configuration
  • Edit shotgunEventDaemon.conf
    • Shotgun Settings
    • Plugin Settings
    • Location of shotgunEventDaemon.conf
  • Testing the daemon
  • Running the daemon
    • A Note About Logging
  • Common Errors
  • List of Configuration File Settings
    • Daemon Settings
    • Shotgun Settings
    • Plugin Settings
    • Email Settings
• Plugins
  • registerCallbacks function
  • Callbacks
  • Logging
  • Building Robust Plugins
• API
  • registerCallbacks
  • Registrar
  • Callback
• Technical Details
  • Event Types
  • Plugin processing order
  • Sharing state
  • Event Backlogs
• Example Plugins

Known Issues

• When processing a large amount of items through a batch process. The resulting events may not be processed. There is code to address this but it is rather new and might not be completely bug free.

If you would like to submit issues please go to the GitHub issues page.

Going forward

Here is some stuff that could be changed or added going forward:

• Parallelize the processing of events. A tough one considering possible event dependencies.
• Pass all data to the callbacks using a context object for better future scalability.
• Allow for late creation of the Shotgun connections on access by the callback.
• Make config reading more robust.