GodotSteam for Godot Engine

Name: Gramps/GodotSteam
Brand: Gramps/GodotSteam
SKU: project/Gramps/GodotSteam
Rating: 4.68 (718 reviews)

Steam API for the Godot game engine (version 3.0 - 3.2.3). For the Windows, Linux, and Mac platforms.

Additional flavors include: Godot 2.x, Server, and GDNative.

Documentation

Documentation is available here: https://gramps.github.io/GodotSteam/

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

Current Build

You can download pre-compiled versions (currently v3.8.1) of this repo here: https://github.com/Gramps/GodotSteam/releases

Version 3.8.2 Changes

Added: different avatar constants
Changed: array deletions for Clang, thanks to thisismike97
Changed: initializing char text, thanks to thisismike97
Fixed: createQueryUserUGCRequest being commented out accidentally
Fixed: logic check for setOverlayNotificationPosition, thanks to thisismike97
Fixed: UTF8 not being handled correctly in some UGC functions, thanks to EIREXE

Version 3.8.1 Changes

Added: extra newline beween each class section for readability
Added: new signal, steamworks_error, currently used for call results failures
Changed: cleared most items from to-do list
Changed: getSyncPlatforms now returns a dictionary with the bitwise and full name version of the platform
Changed: separated callbacks and call results in the godotsteam.cpp into two categories

Version 3.8 Changes

Added: default argument to steamInit to pull all current stats or not, defaults to true so no one has to change anything
Added: new SteamNetworkingMessages class; with functions, callbacks, constants, and enums
Added: all missing functions due to 5 argument limit in Godot
Changed: filterText updated to match new SDK 1.50 function
Changed: HTTP class setCookie to setHTTPCookie to prevent confusion with HTML setCookie
Changed: moved fileLoadDialogReponse into html_file_open_dialog callback as it must follow the call anyway
Fixed: retrieveConnectionDetails and getAllLobbyData functions
Fixed: (probably) various NetworkingSockets and NetworkingUtils functions

Known Issues

Using MinGW causes crashes. I strong recommend you do not use MinGW to compile at this time.

Quick How-To

Download this repository and unpack it.
Download and unpack the Steamworks SDK; this requires a Steam developer account.
Download and unpack the Godot source; preferably 3.2.3.
Move the following to godotsteam/sdk/:

    sdk/public/
    sdk/redistributable_bin/

The repo's 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

Now move the "godotsteam" directory into the "modules" directory of the unpacked Godot Engine source.
Recompile for your platform:
- Windows ( http://docs.godotengine.org/en/stable/reference/compiling_for_windows.html )
- Linux ( http://docs.godotengine.org/en/stable/reference/compiling_for_x11.html )
  - If using Ubuntu 16.10 or higher and having issues with PIE security in GCC, use LINKFLAGS='-no-pie' to get an executable instead of a shared library.
- OSX ( http://docs.godotengine.org/en/stable/reference/compiling_for_osx.html )
  - When creating templates for this, please refer to this post for assistance as the documentation is a bit lacking ( http://steamcommunity.com/app/404790/discussions/0/364042703865087202/ ).
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).
- Create a steam_appid.txt file with your game's app ID or 480 in this folder. 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

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

Windows 32-bit

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

Windows 64-bit

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

Lack of the Steam API DLL/SO/DyLib (for your respective OS) or the steam_appid.txt will cause it fail and crash when testing or running the game outside of the Steam client.
- NOTE: For OSX, 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.

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.

When uploading your game to Steam, you must upload your game's executable and Steam API DLL/SO/DyLIB (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.

Donate

Pull-requests are the best way to help the project out but you can also donate through Patreon or Paypal!

License

MIT license