GodotSteam for Godot Engine 4.x

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/Demos
Godot 2.x	GDNative	Server 3.x	Godot 3.x
Godot 3.x	GDExtension	Server 4.x	Godot 4.x
Godot 4.x	---	GDNative	Server 3.x
MultiplayerPeer	---	GDExtension	Server 4.x

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 or Patreon! Both types of contributions keep things rolling!

Current Build

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

Version 4.11 Changes

• Added: getDLCData to get all DLC information and getDLCDataByIndex now acts as Steam intended with an index passed
• Added: properties for all variants GodotSteam stores
• Changed: using Godot's macros for error reporting back to the editor
• Changed: buffer_size argument to decompressVoice with default of original value
• Changed: steamworksError replaced with prints to editor
• Changed: all options array parameters for all Sockets class functions changed to dictionaries, check class docs
• Changed: deprecated getAvailableVoice, merged functionality into getVoice
• Changed: setLeaderboardDetailsMax changed to the set/get for leaderboard_details_max, now set_leaderboard_details_max
• Changed: Steam singleton now removed during uninitialization
• Fixed: proper type for network_connection_status_changed, thanks to stickyShift
• Fixed: getResultItemProperty now takes empty string to send all property list, thanks to Stralor
• Fixed: missing return value hints from lobby_data_update
• Fixed: get_app_dependencies_result now passed back app_ids array
• Fixed: missing argument hints for item_installed callback
• Fixed: both global stat history functions - getGlobalStatIntHistory and getGlobalStatFloatHistory
• Fixed: broken returned variable in network_connection_status_changed
• Fixed: a variety of small tweaks
• Removed: duplicate call on setting embedded callbacks

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.59 or newer	4.6 or newer
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

Known Issues

• 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, using MinGW will cause crashes unless you are using GodotSteam 4.10 or newer.

"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