|
@@ -0,0 +1,67 @@
|
|
|
+# GodotSteam for GDExtension
|
|
|
+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/CoaguCo-Industries/GodotSteam/tree/godot2)| [GDNative](https://github.com/CoaguCo-Industries/GodotSteam/tree/gdnative) | [Server 3.x](https://github.com/CoaguCo-Industries/GodotSteam-Server/tree/godot3) | [Godot 3.x](https://github.com/CoaguCo-Industries/GodotSteam-Example-Project/tree/godot3)
|
|
|
+[Godot 3.x](https://github.com/CoaguCo-Industries/GodotSteam/tree/godot3) | [GDExtension](https://github.com/CoaguCo-Industries/GodotSteam/tree/gdextension) | [Server 4.x](https://github.com/CoaguCo-Industries/GodotSteam-Server/tree/godot4) | [Godot 4.x](https://github.com/CoaguCo-Industries/GodotSteam-Example-Project/tree/godot4)
|
|
|
+[Godot 4.x](https://github.com/CoaguCo-Industries/GodotSteam/tree/godot4) | --- | [GDNative](https://github.com/CoaguCo-Industries/GodotSteam-Server/tree/gdnative) | [Server 3.x](https://github.com/CoaguCo-Industries/GodotSteam-Example-Project/tree/server3)
|
|
|
+--- | --- | [GDExtension](https://github.com/CoaguCo-Industries/GodotSteam-Server/tree/gdextension) | [Server 4.x](https://github.com/CoaguCo-Industries/GodotSteam-Example-Project/tree/server4)
|
|
|
+
|
|
|
+Documentation
|
|
|
+---
|
|
|
+[Documentation is available here](https://godotsteam.com/).
|
|
|
+
|
|
|
+Feel free to chat with us about GodotSteam on the [CoaguCo Discord server](https://discord.gg/SJRSq6K).
|
|
|
+
|
|
|
+Current Build
|
|
|
+---
|
|
|
+You can [download pre-compiled versions _(currently v4.5.2)_ of this repo here](https://github.com/CoaguCo-Industries/GodotSteam/releases).
|
|
|
+
|
|
|
+**Version 4.5.2 Changes**
|
|
|
+- Fixed: crashes on `generateItems`, `startPurchase`, and `exchangeItems`, thanks to _sepTN_
|
|
|
+
|
|
|
+**Version 4.5.1 Changes**
|
|
|
+- Fixed: app ID automatically being set to 480, now default is 0 which makes GodotSteam ignore auto-setting app ID
|
|
|
+
|
|
|
+**Version 4.5 Changes**
|
|
|
+- Added: two new arguments to `steamInit` and `steamInitEx` to set your app ID, thanks to _GreenFox_
|
|
|
+- Added: two Music class callbacks
|
|
|
+- Changed: `generateItems`, `exchangeItems`, `getItemsByID`, and `startPurchase` all list-based arguments are now PoolIntArrays
|
|
|
+- Changed: `getItemsByID` now takes one argument, counts the elements in the passed array instead
|
|
|
+- Changed: `getItemsWithPrices` no longer requires any arguments passed to it
|
|
|
+- Changed: in-editor docs have been updated
|
|
|
+- Fixed: `getResultItems` now returns all item data
|
|
|
+- Fixed: missing DEFVAL for `steamInitEx`
|
|
|
+- Fixed: Joy Con name in `getInputTypeForHandle`
|
|
|
+- Removed: `getNumItemsWithPrices` as it was unnecessary
|
|
|
+
|
|
|
+[You can read more change-logs here](https://godotsteam.com/changelog/gdextension/).
|
|
|
+
|
|
|
+Known Issues
|
|
|
+---
|
|
|
+- GDExtension for 4.1 is **not** compatible with 4.0.3 or lower. Please check the versions you are using.
|
|
|
+- Overlay will not work in the editor but will work in export projects when uploaded to Steam. This seems to a limitation with Vulkan currently.
|
|
|
+- **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 GDExtension version of GodotSteam, [please refer to our documentation's 'How-To GDExtension' section.](https://godotsteam.com/howto/gdextension/) 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/CoaguCo-Industries/GodotSteam/releases) or [from the Godot Asset Library](https://godotengine.org/asset-library/asset/1972) and skip compiling it yourself!
|
|
|
+
|
|
|
+Usage
|
|
|
+----------
|
|
|
+Do not use the GDExtension version of GodotSteam with any of the module versions whether it be our pre-compiled versions or ones you compile. They are not compatible with each other.
|
|
|
+
|
|
|
+When exporting with the GDExtension version, please use the normal Godot Engine templates instead of our GodotSteam templates or you will have a lot of issues.
|
|
|
+
|
|
|
+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), [Ko-Fi](https://ko-fi.com/grampsgarcia) or [Paypal](https://www.paypal.me/sithlordkyle)!
|
|
|
+
|
|
|
+License
|
|
|
+---
|
|
|
+MIT license
|