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: 17 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 (almost 9 years ago)
- Default Branch: godot4
- Last Pushed: 2024-10-16T18:17:23.000Z (6 months ago)
- Last Synced: 2024-10-29T17:12:02.856Z (6 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.13 Changes**
- Added: missing functions `openDeveloperTools` and `setDPIScalingFactor`
- Added: two missing Video class callbacks: `broadcast_upload_start` and `broadcast_upload_stop`
- Changed: minor housekeeping
- Changed: updated docs
- Changed: `getItemDefinitionProperty` now returns dictionary, thanks to ***gkwaerp***
- Changed: returned dictionary of `html_needs_paint` signal key 'bgra' renamed to 'rbga', thanks to ***obscurelyme***
- Fixed: history variables not initialized in `getGlobalStatIntHistory` and `getGlobalStatFloatHistory`
- Fixed: missing argument in `activateGameOverlayToWebPage`
- Fixed: missing argument in `keyDown`
- Fixed: incorrect callback signal for `get_opf_settings_result`
[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.61 or newer | 4.12 or newer
1.60 | 4.6 to 4.11
1.59 | 4.6 to 4.8
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
4.13 | getItemDefinitionProperty return a dictionary, html_needs_paint key 'bgra' changed to 'rbga'
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