GodotSteam Documentation
Welcome! On this site you can find everything from tutorials to resources to lists of functions and signals, and even games currently using GodotSteam. If you find any mistakes or have some additions to make, please check out our documentation repository here.
Download It
These downloads contain everything you need to start working with Steamworks. Previous versions of all branches can be found on Github.
Pre-compiled editors and template zips are self-contained and have everything you need to work with GodotSteam. The GDNative and GDExtension plug-ins require an official version of Godot Engine.
-
Godot 4.1.x / Godot 4.2.x Versions
[ | 4.2.2 ] [ | 1.60 ] [ | 4.9 ]
Pre-compiled Editor and Templates
-
Server 4.1.x / 4.2.x Versions
[ | 4.2.2 ] [ | 1.59 ] [ | 4.3 ]
-
Godot 3.5.3 Versions
[ | 3.5.3 ] [ | 1.60 ] [ | 3.26 ]
-
Server 3.5.3 Versions
[ | 3.5.3 ] [ | 1.59 ] [ | 3.3 ]
Compile It Yourself
Roll up your sleeves and build your own versions of GodotSteam. More instructions are available on each branch's readme page or up above under the Compiling tab.
-
Godot 4.x Branches
-
Server 4.x Branches
-
Godot 3.x Branches
-
Server 3.x Branches
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.
-
Steamworks SDK
While we suggest the latest version of Valve's Steamworks SDK 1.59 or newer, the older versions work well too.
-
Godot Engine Source
You will need the version that matches your GodotSteam version. Use the tags section in Github.
Just make sure there are no compatibility breaks between the SDK and GodotSteam; usually noted in the readme's.
Quick Start
-
Tutorials
There currently is a wide selection of tutorials available with more in the works. Feel free to submit corrections or new ones So far there are topics such as:
-
External Resources
A list of things related to Godot and Steam like video and text tutorials, linked to other tools and plug-ins, and other Steam API projects.
-
Compiling How-To Guides
If you want to build GdotoSteam from scratch, use one of these compiling how-to guides to continue on:
-
GodotSteam Example Project
A working example of some GodotSteam features based on current tutorials.
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 have your game added to the list of Games Using GodotSteam section.
-
E-Mail Your Game
Please include your Steam store page and up to five additional links like social platforms, Discord invite links, development website, devlog, or anything relevant to your game or studio.
-
PR Submit Your Game
You can create your own entry in our documentation by submitting a pull request on Github. Make sure not to add any more than six additional links. You can view other entries to see how the submission should be formatted.
Need Support?
-
Github Issues
These should only be used for actual bugs in the project. Please direct questions to either an e-mail or Discord.
-
By E-Mail
Send me an e-mail with as many details as you can about your issue. Unless you are just saying hi.
-
Community Support
A bunch of really smart folks can usually help out with issues; especially things like MultiplayerPeer.
Contributing and Donating
Want to help out? There are a few ways and all of them get you listed in our contributors section. Yes, even for tiny corrections.
-
Pull Requests
A huge help is the contributions of fixes and additions through pull-requests on GitHub.
-
Donations
You can provide donations for the project through Github Sponsors. One-time or reoccuring donors get a variety of perks like access to our sponsors-only repo, special Discord roles, and my undying love.