This repository contains code for the Steamworks Construct plugin, and its associated wrapper extension (a DLL which integrates the Steamworks SDK). This allows integrating Construct projects with Steam using the Windows WebView2 and Linux CEF export options. There are two main components in this repository:
- construct-plugin: the Construct plugin, written in JavaScript using the Construct Addon SDK
- wrapper-extension: a Visual Studio 2022 project to build the wrapper extension DLL, written in C++. This also supports using CMake to build the Linux wrapper extension.
The wrapper extension builds an .ext.dll (Windows) and .ext.so (Linux) file in the construct-plugin subfolder. The Construct plugin is configured to load the wrapper extension in the Windows WebView2/Linux CEF exporters, and then communicates with it via a messaging API.
Warning
If you want to modify the plugin for your own purposes, we strongly advise to change the Construct plugin ID. This will avoid serious compatibility problems which could result in your project becoming unopenable. For more information see the Contributing guide.
To build the wrapper extension for Windows, you will need:
- Visual Studio 2022 or newer (the Community edition is free)
- The Steamworks SDK - download and extract the sdk subfolder in the steamworks-sdk subfolder such that the file
steamworks-sdk\public\steam\steam_api.hexists.
The Construct plugin requires 3 DLLs, each in the x86 (32-bit) and x64 (64-bit) architectures, for a total of 6 DLL files. These are:
- Steam_x86.ext.dll / Steam_x64.ext.dll - the wrapper extension DLL, built from the wrapper-extension files
- steam_api.dll / steam_api64.dll - the Steamworks API DLLs from the Steamworks SDK
- D3D11Overlay_x86.ext.dll / D3D11Overlay_x64.ext.dll - an optional wrapper extension used to display a D3D11 surface over the application, solely so the Steam Overlay can render in to it, as bugs and limitations in the Steam Overlay make it impossible to display over the WebView2 control directly. (If missing the in-game Steam Overlay will not be supported, but Steam will revert to fallbacks and everything else will still work.)
For convenience these DLLs are provided in this repository. However if you make changes you may want to replace some of these DLLs.
Warning
Linux support is currently experimental.
To build the wrapper extension for Linux, use CMake. Create a new empty build directory in the wrapper-extension folder, open a terminal in that folder, and run:
cmake -DCMAKE_BUILD_TYPE=Release ..
make
Currently only the x64 architecture is supported for Linux. There are two necessary .so files:
- steamworks-x64.ext.so - the wrapper extension shared object (equivalent of a DLL) built from the wrapper-extension files
- libsteam_api.so - the Steamworks API shared object from the Steamworks SDK
For convenience these SOs are provided in this repository. However if you make changes you may want to replace some of these SOs.
Use developer mode for a more convenient way to test the Construct plugin during development.
For details about configuring and exporting projects for Steam, refer to the Steamworks plugin documentation.
A sample Construct project is provided in this repository which is just a technical test of the plugin features.
The Construct plugin is distributed as a .c3addon file, which is essentially a renamed zip file with the addon files.
Warning
If you want to modify the plugin for your own purposes, we strongly advise to change the Construct plugin ID. This will avoid serious compatibility problems which could result in your project becoming unopenable. Further, if you wish to add support for more Steam API methods, you may be better off creating an independent plugin rather than modifying this one. For more information see the Contributing guide.
If you think there is an issue with this plugin, please file it following all the guidelines at the main Construct issue tracker, so we can keep all our issues in the same place. Issues have been disabled for this repository.
Due to Scirra Ltd's obligation to provide long-term commercial support, we may reject any submitted changes to this plugin. However there are other options such as developing an independent companion plugin. For more information see the Contributing guide.
This code is published under the MIT license.