Skip to content

GodotSteam Documentation

Introduction

GodotSteam is an open-source and fully functional Steamworks SDK / API module and plug-in for the Godot Engine. It comes for all versions of Godot from 2.x to 4.x as well as GDNative and GDExtension plug-ins.

On this site, you can find tutorials, lists of functions and signals, and even games currently using GodotSteam.

Download It

Most people just want to download something and go. Just 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

They contain the pre-compiled editors, templates, and necessary Steam shared libraries:

GDNative Plug-ins

GDExtension Plug-ins

Compile It Yourself

Roll up your sleeves and build your own versions of GodotSteam. More instructions are availale on each branch's readme page or over to your left under Compiling How-To's.

Godot 4.x Branches

Fully working module to compile into any Godot Engine 4.x versions

See the Source

Get the TAR

Get the ZIP

The successor of GDNative, fresh for any Godot Engine 4.x versions

See the Source

Get the TAR

Get the ZIP

Use Godot's cool multiplayer nodes with Steamworks

See the Source

Get the TAR

Get the ZIP

Godot 3.x Branches

Fully working module to compile into any Godot Engine 3.x versions

See the Source

Get the TAR

Get the ZIP

Want to alter the code for the GDNative plug-in or roll your own?

See the Source

Get the TAR

Get the ZIP

Godot 2.x Branches

Fully working module to compile into any Godot Engine 2.x versions

See the Source

Get the TAR

Get the ZIP

Server Branches

A Steamworks-enabled dedicated server with any Godot Engine 4.x versions

See the Source

Get the TAR

Get the ZIP

A Steamworks-enabled dedicated server with any Godot Engine 3.x versions

See the Source

Get the TAR

Get the ZIP

A Steamworks-enabled dedicated server with any Godot Engine 4.x versions

See the Source

Get the TAR

Get the ZIP

A Steamworks-enabled dedicated server with any Godot Engine 3.x versions

See the Source

Get the TAR

Get the ZIP

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.

While we suggest the latest and greatest version of Valve's Steamworks SDK 1.58 or newer, the older versions work well too. Just make sure there are no compatibility breaks between the SDK and GodotSteam; usually noted in the readme's.

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

Multiplayer Peer 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 or submit a pull-request to our Docs repository. 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.

Need Support?

Need some help? Get support for the project through the GodotSteam GitHub issues page, by e-mail, or discussion in our Discord server.

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: