GodotSteam for Godot Engine 4.x | Community Edition

An ecosystem of tools for Godot Engine and Valve's Steam. For the Windows, Linux, and Mac platforms.

Additional Flavors

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

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.

Donate

Pull-requests are the best way to help the project out but you can also donate through Github Sponsors!

Current Build

You can download pre-compiled versions of this repo here.

Version 4.15 Changes

• Added: missing functions checkFileSignature, getConnectedUniverse() and getIPv6ConnectivityState to Utils class
• Changed: added default of true to setVRHeadsetStreamingEnabled()
• Fixed: embedding callbacks not working correctly
• Fixed: check_file_signature variant now int instead of string
• Removed: storeStats() from deconstructor as it should be storing them automatically

You can read more change-logs here.

Compatibility

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

Known Issues

• 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.

Quick How-To

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.

License

MIT license