Distribution

Distribution Methods

Project-Specific Plugins

Project-specific plugins are copied directly within the d3 project file. This means:

• They are automatically distributed when you share or copy the d3 projects folder
• No separate installation is required for recipients
• Ensures all project collaborators have access to the same plugin functionality
• Version control is simplified as the plugin travels with the project

Remote Plugins

Remote plugins exist independently of specific projects and require installation:

• Typically require an installer for distribution to end users
• Can be packaged using installer systems like NSIS (Nullsoft Scriptable Install System)
• May include additional dependencies that need to be managed
• Often used when the plugin needs to integrate with external hardware or systems

Distribution Options for Remote Plugins

• Standalone Installer: Create a dedicated installer package that users download and run
• Integrated with Hardware: Some remote plugins are created within other equipment (e.g., LED processors) and distributed as part of that hardware’s software package
• Package Management: Consider distributing through package managers or repositories for easier version control and updates
• Web Distribution: Host installers on websites or cloud storage for easy access

Best Practices

• Include clear installation instructions
• Provide version information and change logs
• Ensure compatibility information is clearly stated
• Consider digital signing for improved security
• Test the installation process on fresh systems

Plugin Gallery Submission

Plugin developers can submit their work to the disguise Plugin Gallery found in the user guide by:

1. Sending an email to integrations@disguise.one with the following information:

   • Plugin name and description
   • Features and capabilities
   • Installation instructions
   • High-quality screenshots demonstrating the plugin in action
   • Contact information for support
   • Compatibility information (supported Disguise software versions)

2. The disguise team will review submissions and include appropriate plugins in the Gallery.

Documentation

We strongly encourage plugin implementors to create comprehensive user-facing documentation to support:

• Installation procedures
• Configuration options
• Usage instructions and tutorials
• Troubleshooting guides
• Version history

Good documentation significantly improves user adoption and satisfaction with your plugin. Consider hosting documentation on a dedicated website or repository where it can be easily updated and accessed by users.