Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/GodotSteam/GodotSteam

An open-source and fully functional Steamworks SDK / API module and plug-in for the Godot Game Engine.
https://github.com/GodotSteam/GodotSteam

game-development gamedev godot godot-engine godotengine steam-api steamworks

Last synced: about 2 months ago
JSON representation

An open-source and fully functional Steamworks SDK / API module and plug-in for the Godot Game Engine.

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-04-04T00:09:33.000Z (6 months ago)
Last Synced: 2024-04-12T09:06:33.748Z (5 months ago)
Topics: game-development, gamedev, godot, godot-engine, godotengine, steam-api, steamworks
Language: C++
Homepage: http://godotsteam.com/
Size: 306 MB
Stars: 2,289
Watchers: 46
Forks: 163
Open Issues: 11
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: license.txt

Awesome Lists containing this project

README

        # GodotSteam for Godot Engine

An open-source and fully functional Steamworks SDK / API module and plug-in for the Godot Game Engine (version 4.x). For the Windows, Linux, and Mac platforms.

Additional Flavors

---

Pre-Compiles | Plug-ins | Server | Examples/Demos

--- | --- | --- | ---

[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) | [Godot 3.x](https://github.com/GodotSteam/GodotSteam-Example-Project/tree/godot3)

[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-Example-Project/tree/godot4)

[Godot 4.x](https://github.com/GodotSteam/GodotSteam/tree/godot4) | --- | [GDNative](https://github.com/GodotSteam/GodotSteam-Server/tree/gdnative) | [Server 3.x](https://github.com/GodotSteam/GodotSteam-Example-Project/tree/server3)

[Multiplayer Peer](https://github.com/GodotSteam/GodotSteam/tree/multiplayer-peer)| --- | [GDExtension](https://github.com/GodotSteam/GodotSteam-Server/tree/gdextension) | [Server 4.x](https://github.com/GodotSteam/GodotSteam-Example-Project/tree/server4)

Documentation

---

[Documentation is available here](https://godotsteam.com/). You can also check out the Search Help section inside Godot Engine after compiling it with GodotSteam.

Feel free to chat with us about GodotSteam on the [Discord server](https://discord.gg/SJRSq6K).

Current Build

---

You can [download pre-compiled versions of this repo here](https://github.com/GodotSteam/GodotSteam/releases).

**Version 4.9 Changes**

- Added: missing `user_achievement_icon_fetched` callback

- Added: new functions and enums to Apps class

- Added: new Steam Timeline class functions, enums, and constants

- Added: new functions to UGC class

- Added: new enum BetaBranchFlags

- Added: new value NETWORKING_CONFIG_IP_LOCAL_HOST_ALLOW_WITHOUT_AUTH for NetworkingConfigValue enum

- Changed: updated for Steamworks SDK 1.60

- Changed: `network_messages_session_failed` callback now returns the Steam ID associated with the user whose session failed

- Changed: `global_stats_received` had call result name change under-the-hood, does not affect anything

- Changed: `sendMessages()` now returns the message result

- Changed: `getQueryUGCResult()` now passes back additional value total_files_size

- Changed: enum RemoteStoragePlatform now cast as uint32_t, fixes Rust compatibility, ***thanks to GreenFox***

- Changed: `item_installed` signal now returns additional data - legacy_content and manifest_id

- Fixed: incorrect signal name for `inventory_definition_update`, ***thanks to Foxushka***

[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

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.

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

"Quick" How-To

---

For complete instructions on how to build the Godot 4.x version of GodotSteam 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!

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)!

License

---

MIT license