Skip to content

How-To Modules

Here we provide a hopefully thorough explanation of how to set-up, build, and use GodotSteam. You can, of course, skip all this and just download our pre-compiles or plug-in.

1a. Downloading

By far the easiest way to use GodotSteam is to download our pre-compiled editors and templates; especially good for folks who don't want to set up the tools for compiling and just want to get going.

At this point you can skip all the following steps and check out our tutorials to learn more about integrating Steamworks or just explore the SDK!

Do note that OSX users will need to open the downloaded GodotEditor.app and navigate to /Contents/MacOS then open the steam_appid.txt and add your app ID here; or keep it as 480 if you don't have an app ID yet.

1b. Compile Yourself

For those of you who are comfortable compiling or want to give it a shot, here are some steps to follow.

  • Set your system up for compiling based on Godot's recommendations / required tools.
  • Download and unpack the Godot source.
  • Acquire the GodotSteam source either by downloading it or cloning the repo:
    • Download the godot3 or godot4 branch from our repository then unpack it into a folder called godotsteam inside your Godot Engine source code /modules folder.
      • You will have to create the godotsteam folder and it must be named exactly this.
    • Alternatively, clone the godot3 or godot4 branch from our repository into your Godot Engine source code /modules folder
      • Use git clone -b godot3 https://github.com/CoaguCo-Industries/GodotSteam.git godotsteam for the Godot 3.x version
      • Use git clone -b godot4 https://github.com/CoaguCo-Industries/GodotSteam.git godotsteam for the Godot 4.x version
  • Download and unpack the Steamworks SDK.
    • This requires a Steam developer account.

2. Setting Up the SDK

Move the following from the unzipped Steamworks SDK to the /modules/godotsteam/sdk/ folder: 

    sdk/public/
    sdk/redistributable_bin/

3. Double-Checking Folder / File Structure

The compiling directory contents should now look like this: 

    godotsteam/sdk/public/*
    godotsteam/sdk/redistributable_bin/*
    godotsteam/SCsub
    godotsteam/config.py
    godotsteam/godotsteam.cpp
    godotsteam/godotsteam.h
    godotsteam/register_types.cpp
    godotsteam/register_types.h

You can also just put the godotsteam directory where ever you like and just apply the custom_modules=.../path/to/dir/godotsteam flag in SCONS when compiling. Make sure the custom_modules= flag points to where the godotsteam folder is located.

4. Compiling Time

Recompile for your platform:

For editors

scons platform=<your platform> production=yes tools=yes target=release_debug

scons platform=<your platform> tools=yes target=editor

For debug templates

scons platform=<your platform> production=yes tools=no target=release_debug

scons platform=<your platform> tools=no target=template_debug

For release templates

scons platform=<your platform> production=yes tools=no target=release

scons platform=<your platform> tools=no target=template_release

Some things to be aware of:

5. All Together Now

When recompiling the engine is finished, do the following before running it the first time:

  • Copy the shared library (steam_api), for your OS, from sdk/redistributable_bin/ folders to the Godot binary location (by default in the godot source /bin/ file but you can move them to a new folder).
    • These files are called steam_api.dll, steam_api64.dll, libsteam_api.so, or libsteam_api.dylib; no other files are needed.
  • Create a steam_appid.txt file with your game's app ID or 480 in this folder. This is necessary if the editor or game is run outside of Steam.

The finished hierarchy should look like this (if you downloaded the pre-compiles, the editor files go in place of these tools files, which are the same thing):

Linux 32/64-bit

libsteam_api.so
steam_appid.txt
./godot.linux.tools.32 or ./godot.linux.tools.64

MacOS

libsteam_api.dylib
steam_appid.txt
./godot.osx.tools.32 or ./godot.osx.tools.64

Windows

steam_api.dll
steam_appid.txt
./godot.windows.tools.32.exe

steam_api64.dll
steam_appid.txt
./godot.windows.tools.64.exe

A lack of the Steam API .dll/.so/.dylib for your respective OS or the steam_appid.txt will cause the editor or game to fail and crash when testing or running the game outside of the Steam client.

  • NOTE: Some people report putting the Steam API file inside their project folder fixes some issues.
  • NOTE: For MacOS, the libsteam_api.dylib and steam_appid.txt must be in the Content/MacOS/ folder in your application zip or the game will crash.
  • NOTE: For Linux, you may have to load the overlay library for Steam overlay to work: 
    export LD_PRELOAD=~/.local/share/Steam/ubuntu12_32/gameoverlayrenderer.so;~/.local/share/Steam/ubuntu12_64/gameoverlayrenderer.so

or 

export LD_PRELOAD=~/.local/share/Steam/ubuntu12_32/gameoverlayrenderer.so;
export LD_PRELOAD=~/.local/share/Steam/ubuntu12_64/gameoverlayrenderer.so;
    This can be done in an .sh file that runs these before running your executable. This issue may not arise for all users and can also just be done by the user in a terminal separately. You can read more about it in our Linux Caveats doc.

6. Good to Go

From here you should be able to call various functions of Steamworks. You should be able to look up the functions in Godot itself under the search section. In addition, you should be able to read the Steamworks API documentation to see what all is available and cross-reference with GodotSteam's documentation.

7. Exporting / Shipping Your Game

For a full explanation of exporting and shipping your game with GodotSteam, please refer to our Export and Shipping tutorial.

That being said, here is a quick run-down of things to remember. When uploading your game to Steam, you must upload your game's executable and Steam API .dll/.so/.dylb (steam_api.dll, steam_api64.dll, libsteam_api.dylib, and/or libsteam_api.so). Do not include the steam_appid.txt or any .lib files as they are unnecessary; however, they won't hurt anything.