Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/godotsteam/godotsteam
An ecosystem of tools for Godot Engine and Valve's Steam. For the Windows, Linux, and Mac platforms.
https://github.com/godotsteam/godotsteam
game-development gamedev godot godot-engine godotengine steam-api steamworks
Last synced: 5 days ago
JSON representation
An ecosystem of tools for Godot Engine and Valve's Steam. For the Windows, Linux, and Mac platforms.
- Host: GitHub
- URL: https://github.com/godotsteam/godotsteam
- Owner: GodotSteam
- License: mit
- Created: 2016-04-29T21:11:54.000Z (over 8 years ago)
- Default Branch: godot4
- Last Pushed: 2024-10-16T18:17:23.000Z (3 months ago)
- Last Synced: 2024-10-29T17:12:02.856Z (2 months ago)
- Topics: game-development, gamedev, godot, godot-engine, godotengine, steam-api, steamworks
- Language: C++
- Homepage: http://godotsteam.com/
- Size: 435 MB
- Stars: 2,812
- Watchers: 51
- Forks: 188
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: license.txt
Awesome Lists containing this project
README
# GodotSteam for Godot Engine 4.x | Community Edition
An ecosystem of tools for [Godot Engine](https://godotengine.org) and [Valve's Steam](https://store.steampowered.com). For the Windows, Linux, and Mac platforms.
Additional Flavors
---
Pre-Compiles | Plug-ins | Server | Examples
--- | --- | --- | ---
[Godot 2.x](https://github.com/GodotSteam/GodotSteam/tree/godot2) | [GDNative](https://github.com/GodotSteam/GodotSteam/tree/gdnative) | [Server 3.x](https://github.com/GodotSteam/GodotSteam-Server/tree/godot3) | [Skillet](https://github.com/GodotSteam/Skillet)
[Godot 3.x](https://github.com/GodotSteam/GodotSteam/tree/godot3) | [GDExtension](https://github.com/GodotSteam/GodotSteam/tree/gdextension) | [Server 4.x](https://github.com/GodotSteam/GodotSteam-Server/tree/godot4) | ---
[Godot 4.x](https://github.com/GodotSteam/GodotSteam/tree/godot4) | --- | [GDNative](https://github.com/GodotSteam/GodotSteam-Server/tree/gdnative) | ---
[MultiplayerPeer](https://github.com/GodotSteam/MultiplayerPeer)| --- | [GDExtension](https://github.com/GodotSteam/GodotSteam-Server/tree/gdextension) | ---
Documentation
---
[Documentation is available here](https://godotsteam.com). You can also check out the Search Help section inside Godot Engine.
Feel free to chat with us about GodotSteam or ask for assistance on the [Discord server](https://discord.gg/SJRSq6K).
Donate
---
Pull-requests are the best way to help the project out but you can also donate through [Github Sponsors](https://github.com/sponsors/Gramps)!
Current Build
---
You can [download pre-compiled versions of this repo here](https://github.com/GodotSteam/GodotSteam/releases).
**Version 4.12 Changes**
- Added: new Timeline functions, call results, and enums
- Added: new Inputs enums for Horipad; `INPUT_ACTION_ORIGIN`
- Added: new Networking config enum `NETWORKING_CONFIG_SEND_TIME_SINCE_PREVIOUS_PACKET`
- Added: new Networking config enums for fake packet jitter; `NETWORKING_CONFIG_FAKE_JITTER_`
- Changed: `equipped_profile_items` callback now sends `from_cache` bool
- Changed: first argument for `steamInit` and `steamInitEx` no longer calls for stats as they are synced by client; left to prevent compatibility breakage
- Fixed: `getAchievement` and related achievement functions breaking under rare conditions
- Fixed: incorrect type for `set_inventory_update_handle`
- Removed: `setTimelineGameMode` function which was removed in 1.61
- Removed: `current_stats_received` callback removed for redundancy
- Removed: Google Stadia, Nintendo, Epic Games, and WeGame Networking identity types fully removed, from 1.61
- Removed: unncessary commenting
[You can read more change-logs here](https://godotsteam.com/changelog/godot4/).
Compatibility
---
While rare, sometimes Steamworks SDK updates will break compatilibity with older GodotSteam versions. Any compatability breaks are noted below. Newer API files (dll, so, dylib) _should_ still work for older versions.
Steamworks SDK Version | GodotSteam Version
---|---
1.59 or newer | 4.6 or newer
1.58a or older | 4.5.4 or older
Versions of GodotSteam that have compatibility breaks introduced.
GodotSteam Version | Broken Compatibility
---|---
4.8 | Networking identity system removed, replaced with Steam IDs
4.9 | sendMessages returns an Array
4.11 | setLeaderboardDetailsMax removed
Known Issues
---
- Steam overlay will not work when running your game from the editor if you are using Forward+ as the renderer. It does work with Compatibility though. Your exported project will work perfectly fine in the Steam client, however.
- When self-compiling, **do not** use MinGW as it will cause crashes.
Quick How-To
---
For complete instructions on how to build the Godot 4.x version of GodotSteam from scratch, [please refer to our documentation's 'How-To Modules' section.](https://godotsteam.com/howto/modules/) It will have the most up-to-date information.
Alternatively, you can just [download the pre-compiled versions in our Releases section](https://github.com/GodotSteam/GodotSteam/releases) and skip compiling it yourself!
[To start, check out our tutorial on initializing Steam.](https://godotsteam.com/tutorials/initializing/) There are additional tutorials with more in the works. You can also [check out additional Godot and Steam related videos, text, additional tools, plug-ins, etc. here.](https://godotsteam.com/tutorials/external/)
License
---
MIT license