GodotSteam Documentation
Introduction
This is the documentation site for GodotSteam, a Steamworks module for Godot Engine which includes a fully-functional version for all versions of Godot from 2.x to 4.x as well as a GDNative plug-in. Here you can find tutorials, lists of functions and signals, and even games currently using GodotSteam.
Support for the project is provided through the GodotSteam GitHub issues page by e-mail, or discussion in our Discord server.
Pre-builds
Most people just want to download something and go. For that, we have a few different options: either pre-compiled module-enabled editors and templates, the GDNative (Godot 3.x) plug-in, or the GDExtension (Godot 4.x) plug-in.
Make sure you don't mix and match the pre-compiled editors with the plug-ins or you'll have a really bad time.
Module Pre-Compiles
Get integrating Steamworks into your game with pre-compiled editors and templates
Or build dedicated servers with pre-compiled editors and templates
GDNative Plug-in
Get integrating Steamworks into your game with the GDNative plug-in for Godot Engine 3.x
Godot Asset Library GitHub Drop-in TAR GitHub Drop-in ZIP
Or build dedicated servers with the GDNative Server plug-in for Godot Engine 3.x
GDExtension Plug-ins
Get integrating Steamworks into your game with the GDExtension plug-in via Godot Engine 4.x
Godot Asset Library GitHub Drop-in TAR GitHub Drop-in ZIP
Or build dedicated servers with the GDExtension Server plug-in via Godot Engine 4.x
Compiling Yourself
Roll up your sleeves and build your own versions of GodotSteam. It does also require the source code for Godot. More instructions are availale on each branch's readme page.
Godot 4.x Branches
Godot Engine 4.x
Fully working module to compile into any Godot Engine 4.x versions
GDExtension
The successor of GDNative, fresh for any Godot Engine 4.x versions
Godot 3.x Branches
Godot Engine 3.x
Fully working module to compile into any Godot Engine 3.x versions
GDNative
Want to alter the code for the GDNative plug-in or roll your own?
Godot 2.x Branches
Godot Engine 2.x
Fully working module to compile into any Godot Engine 2.x versions
Server Branches
Godot 4.x Steamworks Server
A Steamworks-enabled dedicated server with any Godot Engine 4.x versions
Godot 3.x Steamworks Server
A Steamworks-enabled dedicated server with any Godot Engine 3.x versions
Godot GDExtension Steamworks Server
A Steamworks-enabled dedicated server with any Godot Engine 4.x versions
Godot GDNative Steamworks Server
A Steamworks-enabled dedicated server with any Godot Engine 3.x versions
Requirements
If you are compiling the module, GDNative, or GDExtension version yourself, there are a few things you'll need to start working regardless of which flavor you decide to try out.
Source
Download the appropriate tag versions for the GodotSteam branch you are using.
Quick Start
If you are downloading our pre-compiles or using the GDNative plugin, or have finished fresh compiling, you can move on to the how-to sections or just start experimenting.
How-To Guides
Based on what you want to work with, use one of these how-to guides to continue on.
Module How-To GDNative How-To GDExtension How-To Server How-To
GodotSteam Example Project
A working example of some GodotSteam features based on current tutorials.
Last, but absolutely not least, make sure you are logged into your Steam client if testing your game or any scenes. Otherwise you will experience some pretty brutal crashing.
Have fun!
Have A Game Using GodotSteam?
Finally got your Steam store page up? Whether you are about to release your game, already did, or are just tinkering away at it, you can send me the details and I will post it in the Games Using GodotSteam section.
You can use the button below to submit your game to the list. Please remember to include your game's Steam store page URL. Additionally you can include up to four additional links like your Mastodon or Twitter account, Discord invite link, development website, devlog, or anything relevant to your game or studio.
Donating And Contributing
Want to help out? The best way is to contribute fixes or additions through pull-requests on GitHub. We also accept donations through these places: