Skip to content

Latest commit

 

History

History
executable file
·
62 lines (47 loc) · 3.49 KB

README.md

File metadata and controls

executable file
·
62 lines (47 loc) · 3.49 KB
Raw

GodotSteam for Godot Engine

An open-source and fully functional Steamworks SDK / API module and plug-in for the Godot Game Engine (version 4.x). 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
Multiplayer Peer --- GDExtension Server 4.x

Documentation

Documentation is available here. You can also check out the Search Help section inside Godot Engine after compiling it with GodotSteam.

Feel free to chat with us about GodotSteam on the Discord server.

Current Build

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

Version 4.10 Changes

  • Changed: now using Steam Flat API, should allow compiling with MinGW
  • Changed: updated in-editor docs

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

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.
  • Using MinGW causes crashes. I strongly recommend you do not use MinGW to compile at this time. GodotSteam 4.10 should allow this, however.

"Quick" How-To

For complete instructions on how to build the Godot 4.x version of GodotSteam 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!

Donate

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

License

MIT license