Welcome to the Construct Addon SDK! We host the SDK files on GitHub. Refer to the Addon SDK manual for documentation and more details.

Downloading

Click the green Code button and choose Download ZIP to get a copy of the SDK files.

Getting started

Refer to the Addon SDK manual to get started!

JSON Schemas

The SDK includes JSON schemas for addon metadata (addon.json), action/condition/expression definitions (aces.json) and language (en-US.json) files. With a compatible editor like VS Code, this allows validation and autocomplete of these kinds of JSON files, which can make it much easier to write them correctly. If you change the folder structure of the SDK, make sure the special "$schema" key at the start of the JSON file points to the relevant schema file, e.g. "../aces.schema.json".

TypeScript

The addon SDK has optional support for TypeScript. See the section on TypeScript support in the Addon SDK documentation for more details. If you prefer to use JavaScript, just ignore or delete the .ts files in the SDK samples.

Support

Post to the Plugin SDK forum for general questions and help. If you think you've run in to a problem with Construct itself, please file an issue.

Contributions

We are hosting the SDK files on GitHub, but we don't intend to accept contributions to this code. Feel free to start a new repository if you want to provide additional SDK samples or an altered version of the SDK.

Compatibility

The editor formerly supported SDK v1. Support for this was retired in Construct 3 r450+ and the Addon SDK now only supports the newer SDK v2. In case you still have legacy SDK v1 addons that you wish to port to SDK v2, see the guide Porting to Addon SDK v2.

Samples

The SDK includes the following samples:

Plugins

• customImporterPlugin: a plugin that calls AddDragDropFileImportHandler to import data in a custom format. customImporterSampleData.zip contains some sample data in the format the plugin can import.
• domElementPlugin: a plugin that creates and manages a HTML element.
• domMessagingPlugin: a plugin that uses a "DOM-side" script to interact with browser APIs that are not typically available in a Web Worker, allowing the features to continue working in Construct's worker mode which hosts all the runtime code in a Web Worker.
• drawingPlugin: a plugin that has an editable image and demonstrates basic code to draw it in the Layout View.
• editorTextPlugin: a plugin that demonstrates rendering text in both the editor and runtime.
• singleGlobalPlugin: demonstrates a basic "single-global" plugin, where it can only be added once and provides its features globally, like the Audio plugin. This is usually the best starting point for a plugin that aims to integrate a third-party service.
• wrapperExtensionPlugin: demonstrates a plugin that interacts with a wrapper extension - a DLL written in C++ that can provide enhanced platform integration. For more details see the Wrapper extension guide in the Addon SDK manual.

Behaviors

• sample-behavior: an example behavior with template code for writing your own movement logic.
• basic-bullet: an example behavior that replicates a simple form of the Bullet behavior, in order to demonstrate the type of code you need to move instances.

Effects

• sample-tint: provides a sample minimal tint effect in both GLSL for WebGL and WGSL for WebGPU.
• sample-webgl2: demonstrates using different shaders for WebGL 1, WebGL 2, and WebGPU. Each shader outputs a different color to identify which shader is in use.

Themes

• sample-theme: template code for a custom editor theme for Construct.