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.14 Changes
- Added: new functions and enums to SteamRemotePlay
- Added: Steam icon to the class
- Added: Project Settings for Steam, optional app ID, can set auto-initialization, can set embedded callbacks, thanks to TriMay
- Added: new functions to UGC
- Changed: replaced previous
MouseCursorenum with newHTMLMouseCursorenum - Changed: updated docs
- Changed: updated to Steamworks SDK 1.62
- Changed:
getNumSubscribedItemsandgetSubscribedItemsnow take include_locally_disabled argument - Changed:
steamInitnow return intended boolean and first argument removed since client syncs stats/achieves at boot - Fixed: various bits in the in-editor docs
- Fixed:
network_messages_session_failedmissing returned properties in bind - Removed:
UserRestrictionsenum - Removed:
SetPersonaNamefunction and related callbackname_changed - Removed:
GetUserRestrictionsfunction
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.62 or newer | 4.14 or newer |
| 1.61 | 4.12 to 4.13 |
| 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' |
| 4.14 | Removed first argument for stat request in steamInit and steamInitEx, steamInit returns intended bool value |
- Steam overlay may not work when running your game from the editor if you are using Forward+ as the renderer unless you use auto-initialization from the Project Settings menu. Your exported project should 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
