An ecosystem of tools for Godot Engine and Valve's Steam. For the Windows, Linux, and Mac platforms.
| Pre-Compiles | Plug-ins | Server | Examples |
|---|---|---|---|
| Godot 2.x | GDNative | Server 3.x | Skillet |
| Godot 3.x | GDExtension | Server 4.x | --- |
| Godot 4.x | --- | GDNative | --- |
| MultiplayerPeer | --- | GDExtension | --- |
Documentation is available here. You can also check out the Search Help section inside Godot Engine.
Feel free to chat with us about GodotSteam or ask for assistance on the Discord server.
Pull-requests are the best way to help the project out but you can also donate through Github Sponsors!
You can download pre-compiled versions of this repo here.
Version 4.13 Changes
- Added: missing functions
openDeveloperToolsandsetDPIScalingFactor - Added: two missing Video class callbacks:
broadcast_upload_startandbroadcast_upload_stop - Changed: minor housekeeping
- Changed: updated docs
- Changed:
getItemDefinitionPropertynow returns dictionary, thanks to gkwaerp - Changed: returned dictionary of
html_needs_paintsignal key 'bgra' renamed to 'rbga', thanks to obscurelyme - Fixed: history variables not initialized in
getGlobalStatIntHistoryandgetGlobalStatFloatHistory - Fixed: missing argument in
activateGameOverlayToWebPage - Fixed: missing argument in
keyDown - Fixed: incorrect callback signal for
get_opf_settings_result
You can read more change-logs here.
While rare, sometimes Steamworks SDK updates will break compatilibity with older GodotSteam versions. Any compatability breaks are noted below. Newer API files (dll, so, dylib) should still work for older versions.
| Steamworks SDK Version | GodotSteam Version |
|---|---|
| 1.61 or newer | 4.12 or newer |
| 1.60 | 4.6 to 4.11 |
| 1.59 | 4.6 to 4.8 |
| 1.58a or older | 4.5.4 or older |
Versions of GodotSteam that have compatibility breaks introduced.
| GodotSteam Version | Broken Compatibility |
|---|---|
| 4.8 | Networking identity system removed, replaced with Steam IDs |
| 4.9 | sendMessages returns an Array |
| 4.11 | setLeaderboardDetailsMax removed |
| 4.13 | getItemDefinitionProperty return a dictionary, html_needs_paint key 'bgra' changed to 'rbga' |
- Steam overlay will not work when running your game from the editor if you are using Forward+ as the renderer. It does work with Compatibility though. Your exported project will work perfectly fine in the Steam client, however.
- When self-compiling, do not use MinGW as it will cause crashes.
For complete instructions on how to build the Godot 4.x version of GodotSteam from scratch, please refer to our documentation's 'How-To Modules' section. It will have the most up-to-date information.
Alternatively, you can just download the pre-compiled versions in our Releases section and skip compiling it yourself!
To start, check out our tutorial on initializing Steam. There are additional tutorials with more in the works. You can also check out additional Godot and Steam related videos, text, additional tools, plug-ins, etc. here.
MIT license
