Various updates

GodotSteam · Dec 27, 2024 · 957d504 · 957d504
1 parent de582bb
commit 957d504
Show file tree

Hide file tree

Showing 22 changed files with 174 additions and 95 deletions.
diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css
@@ -95,10 +95,16 @@ h3 {
 .md-tabs {
   background-color: #478CBF !important;
 }
+
 .critic {
+		margin: 0em 0 2em !important;
+}
+
+.critic ~ .critic {
 	background-color: #35688E !important;
-	margin: 0em 0 2em !important;
+	margin: 8em 0 2em !important;	
 }
+
 .md-typeset .critic.block h2 {
 	font-weight: bold;
 }
@@ -129,7 +135,7 @@ h3 {
 }
 .md-typeset code {
 	background-color: #282828;
-  padding: .295em .295em;
+  padding: .05em .295em;
 }
 .md-typeset pre>code {
 	scrollbar-color:#478CBF #3A526A !important;
@@ -517,7 +523,7 @@ html .md-footer-meta.md-typeset a:is(:focus, :hover) {
 .md-typeset .grid {
   grid-gap: 3rem;
   display: grid;
-  grid-template-columns: repeat(auto-fit,minmax(min(100%,16rem),1fr));
+  grid-template-columns: repeat(auto-fit,minmax(min(100%,25rem),1fr));
   margin: 1em 0;
 }
 .grid {

diff --git a/docs/changelog/gdextension.md b/docs/changelog/gdextension.md
@@ -1,13 +1,28 @@
 ---
 title: GDExtension Changelog
 description: A history of all changes made to the gdextension branch.
-icon: material/clipboard-clock-outline
+icon: material/power-plug-outline
 ---
 
 A history of all changes to [the ***gdextension*** branch.](https://github.com/GodotSteam/GodotSteam/tree/gdextension){ target="\_blank" }
 
 ---
 
+## Version 4.12
+
+- 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
+
 ## Version 4.11
 
 - Added: `getDLCData` to get all DLC information and `getDLCDataByIndex` now acts as Steam intended with an index passed

diff --git a/docs/changelog/gdnative.md b/docs/changelog/gdnative.md
@@ -1,10 +1,10 @@
 ---
 title: GDNative Changelog
 description: A history of all changes made to the gdnative branch.
-icon: material/clipboard-clock-outline
+icon: material/power-plug-outline
 ---
 
-A history of all changes to [the ***gdnative*** branch.](https://github.com/GodotSteam/GodotSteam/tree/gdnative){ target="\_blank" }
+A history of all changes to [the ***gdnative*** branch;](https://github.com/GodotSteam/GodotSteam/tree/gdnative){ target="\_blank" } which is now retired. This branch still works fine but will not receive any further updates.
 
 ---
 
@@ -260,7 +260,7 @@ A history of all changes to [the ***gdnative*** branch.](https://github.com/Godo
 
 * Removed: not logged in as a failure condition for `steamInit()`
 
-## Version 3.1**
+## Version 3.1
 
 * Added: various Steam Deck specific functions, ***thanks to EIREXE***
 * Added: new AppLists class of functions and callbacks
@@ -279,30 +279,30 @@ A history of all changes to [the ***gdnative*** branch.](https://github.com/Godo
 * Removed: `receiveRelayAuthTicket()`, `findRelayAuthTicketForServer()`, `getHostedDedicatedServerAddress()`, and `getGameCoordinatorServerLogin()` as they rely on datagram header that was removed from base SDK
 * Removed: second call for steam_api.h in godotsteam.cpp
 
-## Version 3.0.1**
+## Version 3.0.1
 
 * Fixed: two issues with godotsteam.cpp that causes compiling error on Linux
 
-## Version 3.0.0**
+## Version 3.0.0
 
 * Added: all missing functions to bring GDNative version in-line with module version
 * Changed: rebuilt and restructured layout of project folder
 * Removed: enums as they don't work in GDNative
 * Removed: default arguments for functions as they don't work in GDNative
 
-## Version 2.1.0**
+## Version 2.1.0
 
 * Added: Steamworks P2P functions thanks to Antokolos
 
-## Version 2.0.0**
+## Version 2.0.0
 
 * Added: all current GodotSteam functions and signals
 * Added: [godotsteam.h] file
 * Changed: compile process; ***thanks to willnationsdev***
 * Changed: various parts of the CPP files
 * Removed: pre-compiled TSCN and TRES files
 
-## Version 1.1.0**
+## Version 1.1.0
 
 * Added: [godotsteam.h] file
 * Added: `getCurrentGameLanguage()`
@@ -312,7 +312,7 @@ A history of all changes to [the ***gdnative*** branch.](https://github.com/Godo
 * Changed: minor things in godotsteam.cpp
 * Removed: pre-compiled TSCN and TRES files
 
-## Version 1.0.0**
+## Version 1.0.0
 
 * Added: most pre-existing GodotSteam code over
 * Added: GodotSteam GDNative documentation

diff --git a/docs/changelog/godot2.md b/docs/changelog/godot2.md
@@ -1,10 +1,10 @@
 ---
 title: Godot 2.x Changelog
 description: A history of all changes made to the godot2 branch.
-icon: material/clipboard-clock-outline
+icon: material/gamepad-square
 ---
 
-A history of all to [the ***godot2*** branch.](https://github.com/GodotSteam/GodotSteam/tree/godot2){ target="\_blank" }
+A history of all changes to [the ***godot2*** branch;](https://github.com/GodotSteam/GodotSteam/tree/godot2){ target="\_blank" } which is now retired. This branch still works fine but will not receive any further updates.
 
 ---
 

diff --git a/docs/changelog/godot3.md b/docs/changelog/godot3.md
@@ -1,10 +1,10 @@
 ---
 title: Godot 3.x Changelog
 description: A history of all changes made to the godot3 branch.
-icon: material/clipboard-clock-outline
+icon: material/gamepad-square
 ---
 
-A history of all to [the ***godot3*** branch.](https://github.com/GodotSteam/GodotSteam/tree/godot3){ target="\_blank" }
+A history of all changes to [the ***godot3*** branch.](https://github.com/GodotSteam/GodotSteam/tree/godot3){ target="\_blank" }
 
 ---
 

diff --git a/docs/changelog/godot4.md b/docs/changelog/godot4.md
@@ -1,7 +1,7 @@
 ---
 title: Godot 4.x Changelog
 description: A history of all changes made to the godot4 branch.
-icon: material/clipboard-clock-outline
+icon: material/gamepad-square
 ---
 
 A history of all changes to [the ***godot4*** branch.](https://github.com/GodotSteam/GodotSteam/tree/godot4){ target="\_blank" }

diff --git a/docs/changelog/multiplayer_peer.md b/docs/changelog/multiplayer_peer.md
@@ -1,13 +1,17 @@
 ---
 title: MultiplayerPeer Changelog
 description: A history of all changes made to the multiplayer-peer branch.
-icon: material/clipboard-clock-outline
+icon: material/account-supervisor
 ---
 
 A history of all changes to [the ***MultiplayerPeer*** repo.](https://github.com/GodotSteam/MultiplayerPeer){ target="\_blank" }
 
 ---
 
+## Version 4.12
+
+- Changed: version bump to match Godot 4.x branch update
+
 ## Version 4.11
 
 - Changed: in-editor docs

diff --git a/docs/changelog/server3.md b/docs/changelog/server3.md
@@ -1,4 +1,8 @@
-# Server 3.x Change-Log
+---
+title: Server 3.x Changelog
+description: A history of all changes made to the server godot3 branch.
+icon: material/server-outline
+---
 
 A history of all changes to [the ***server3*** branch.](https://github.com/GodotSteam/GodotSteam-Server/tree/godot3){ target="\_blank" }
 

diff --git a/docs/changelog/server4.md b/docs/changelog/server4.md
@@ -1,9 +1,28 @@
-# Server 4.x Change-Log
+---
+title: Server 4.x Changelog
+description: A history of all changes made to the server godot4 branch.
+icon: material/server-outline
+---
 
 A history of all changes to [the ***server4*** branch.](https://github.com/GodotSteam/GodotSteam-Server/tree/godot4){ target="\_blank" }
 
 ---
 
+## Version 4.4
+
+- Added: public properties with set/get functions
+- Added: failures now print to editor
+- Changed: updated to Steamworks SDK 1.61
+- Changed: added new enums from newest SDK, removed the now missing ones
+- Changed: deprecating `serverInit` in next patch, migrate to `serverInitEx`
+- Changed: return typed for `getHTTPResponseHeaderValue` and `getHTTPStreamingResponseBodyData`
+- Changed: `configureConnectionLanes` now has correct type for lanes argument
+- Changed: NetworkingSockets now take dictionary for options, based on godot4 branch in main GodotSteam repo
+- Changed: reworked `getUserAchievement`, `getUserStatFloat`, `getUserStatInt` to mirror godot4 branch in main GodotSteam repo
+- Fixed: `setHTTPRequestRawPostBody`, backport from godot4 branch in main GodotSteam repo
+- Fixed: `serializeResult` now returns PackedByteArray
+- Fixed: misspelled enum
+
 ## Version 4.3
 
 - Changed: constants list to add missing and remove unused

diff --git a/docs/changelog/server_gdextension.md b/docs/changelog/server_gdextension.md
@@ -1,9 +1,29 @@
-# Server GDExtension Change-Log
+---
+title: Server GDExtension Changelog
+description: A history of all changes made to the server gdextension branch.
+icon: material/power-plug-outline
+---
+
 
 A history of all changes to [the ***server gdextension*** branch.](https://github.com/GodotSteam/GodotSteam-Server/tree/gdextension){ target="\_blank" }
 
 ---
 
+## Version 4.4
+
+- Added: public properties with set/get functions
+- Added: failures now print to editor
+- Changed: updated to Steamworks SDK 1.61
+- Changed: added new enums from newest SDK, removed the now missing ones
+- Changed: deprecating `serverInit` in next patch, migrate to `serverInitEx`
+- Changed: return typed for `getHTTPResponseHeaderValue` and `getHTTPStreamingResponseBodyData`
+- Changed: `configureConnectionLanes` now has correct type for lanes argument
+- Changed: NetworkingSockets now take dictionary for options, based on godot4 branch in main GodotSteam repo
+- Changed: reworked `getUserAchievement`, `getUserStatFloat`, `getUserStatInt` to mirror godot4 branch in main GodotSteam repo
+- Fixed: `setHTTPRequestRawPostBody`, backport from godot4 branch in main GodotSteam repo
+- Fixed: `serializeResult` now returns PackedByteArray
+- Fixed: misspelled enum
+
 ## Version 4.3
 
 - Changed: constants list to add missing and remove unused

diff --git a/docs/changelog/server_gdnative.md b/docs/changelog/server_gdnative.md
@@ -1,6 +1,10 @@
-# Server GDNative Change-Log
+---
+title: Server GDNative Changelog
+description: A history of all changes made to the server gdnative branch.
+icon: material/power-plug-outline
+---
 
-A history of all changes to [the ***server gdnative*** branch.](https://github.com/GodotSteam/GodotSteam-Server/tree/gdnative){ target="\_blank" }
+A history of all changes to [the ***server gdnative*** branch;](https://github.com/GodotSteam/GodotSteam-Server/tree/gdnative){ target="\_blank" } which is now retired. This branch still works fine but will not receive any further updates.
 
 ---
 

diff --git a/docs/changelog/skillet_assets.md b/docs/changelog/skillet_assets.md
@@ -1,4 +1,8 @@
-# Skillet Assets Change-Log
+---
+title: Skillet Asset Change-Log
+description: A history of all changes made to the Skillet asset branch.
+icon: material/format-paint
+---
 
 A history of all changes to [the ***assets*** branch of the Skillet repository.](https://github.com/GodotSteam/Skillet/tree/assets){ target="\_blank" }
 

diff --git a/docs/changelog/skillet_editor.md b/docs/changelog/skillet_editor.md
@@ -1,4 +1,8 @@
-# Skillet Assets Change-Log
+---
+title: Skillet Editor Change-Log
+description: A history of all changes made to the Skillet editor branch.
+icon: material/radiator
+---
 
 A history of all changes to [the ***editor*** branch of the Skillet repository.](https://github.com/GodotSteam/Skillet/tree/editor){ target="\_blank" }
 

diff --git a/docs/classes/main.md b/docs/classes/main.md
@@ -119,9 +119,15 @@
 
 ### steamInit
 
-!!! function "steamInit( ```bool``` retrieve_stats = true, ```uint32_t``` app_id, ```bool``` embed_callbacks )"
+!!! function "steamInit( ```bool``` retrieve_stats = false, ```uint32_t``` app_id, ```bool``` embed_callbacks )"
     Starts up the Steam API.
 
+    As of Steamworks SDK 1.61, the first argument defaults to false and will do nothing even is set to true. Prior to SDK 1.61, this argument defaults to true and will request the player's current statistics and achievements.
+
+    You can pass your app ID to the second argument and GodotSteam will set the OS environment for you so you do not have to do this manually anymore. If nothing is passed, it will not be set.
+
+    You can pass true to the third argument to have GodotSteam connect and use run_callbacks internally so you do not have to do this manually anymore. If nothing is passed, it will not run callbacks internally.
+
     **Return:** dictionary
 
     * status (int)
@@ -134,20 +140,22 @@
     * 20 / "Steam not running"
     * 79 / "Invalid app ID or app not installed"
 
-    You can pass your app ID to the second argument and GodotSteam will set the OS environment for you so you do not have to do this manually anymore. If nothing is passed, it will not be set.
-
-    You can pass true to the third argument to have GodotSteam connect and use run_callbacks internally so you do not have to do this manually anymore. If nothing is passed, it will not run callbacks internally.
-
     **Note:** This function **does not** contain the second or third argument in **GDNative**. Also, this function **does not** contain the third argument in **GDExtension**.
 
     ------
     [:fontawesome-brands-steam: Read more in the official Steamworks SDK documentation](https://partner.steamgames.com/doc/api/steam_api#SteamAPI_Init){ .md-button .md-button--store target="_blank" }
 
 ### steamInitEx
 
-!!! function "steamInitEx( ```bool``` retrieve_stats = true, ```uint32_t``` app_id, ```bool``` embed_callbacks )"
+!!! function "steamInitEx( ```bool``` retrieve_stats = false, ```uint32_t``` app_id, ```bool``` embed_callbacks )"
     Initialize the Steamworks SDK. On success **STEAM_API_INIT_RESULT_OK** is returned. Otherwise, if **error_message** is non-NULL, it will receive a non-localized message that explains the reason for the failure.
 
+    As of Steamworks SDK 1.61, the first argument defaults to false and will do nothing even is set to true. Prior to SDK 1.61, this argument defaults to true and will request the player's current statistics and achievements.
+
+    You can pass your app ID to the second argument and GodotSteam will set the OS environment for you so you do not have to do this manually anymore. If nothing is passed, it will not be set.
+
+    You can pass true to the third argument to have GodotSteam connect and use run_callbacks internally so you do not have to do this manually anymore. If nothing is passed, it will not run callbacks internally.
+
     **Returns:** dictionary
 
     * status (int)
@@ -160,10 +168,6 @@
     * 2 / "Cannot connect to Steam, client probably isn't running"
     * 3 / "Steam client appears to be out of date"
 
-    You can pass your app ID to the second argument and GodotSteam will set the OS environment for you so you do not have to do this manually anymore. If nothing is passed, it will not be set.
-
-    You can pass true to the third argument to have GodotSteam connect and use run_callbacks internally so you do not have to do this manually anymore. If nothing is passed, it will not run callbacks internally.
-
     **Note:** This function **does not** contain the second or third argument in **GDNative**. Also, this function **does not** contain the third argument in **GDExtension**.
 
 ### steamShutdown
@@ -173,24 +177,6 @@
 
     **Returns:** nothing
 
-{==
-## :material-signal: Signals
-==}
-
-These callbacks require you to run ```Steam.run_callbacks()``` in your ```_process()``` function to receive them.
-
-### steamworks_error
-
-!!! function "steamworks_error"
-	Intended to serve as generic error messaging for failed call results.
-
-	**Returns:**
-
-	* failed_signal (string)
-	* message (string)
-
-	**Note:** this callback is unique to GodotSteam.
-
 {==
 ## :material-numeric: Enums
 ==}

diff --git a/docs/games/games-s.md b/docs/games/games-s.md
@@ -223,6 +223,13 @@ Here is a showcase of games using the GodotSteam module. Have a game on Steam us
 [ :fontawesome-brands-firefox-browser: ](https://www.spacekraken.studio/){ target="\_blank" .md-button .md-button--store }
 </figure>
 
+## The SS Destiny Disaster
+<figure class="game" markdown>
+[![The SS Destiny Disaster](https://steamcdn-a.akamaihd.net/steam/apps/3197230/header.jpg){ loading=lazy align=left }](https://store.steampowered.com/app/3197230/The_SS_Destiny_Disaster/){ target="\_blank" }
+
+[ :fontawesome-brands-steam: ](https://store.steampowered.com/app/3197230/The_SS_Destiny_Disaster/){ target="\_blank" .md-button .md-button--store }
+</figure>
+
 ## Starveil
 <figure class="game" markdown>
 [![Starveil](https://steamcdn-a.akamaihd.net/steam/apps/2357590/header.jpg){ loading=lazy align=left }](https://store.steampowered.com/app/2357590/Starveil/){ target="\_blank" }

diff --git a/docs/howto/gdextension.md b/docs/howto/gdextension.md
@@ -1,4 +1,9 @@
-# How-To GDExtension
+---
+title: How To Compile GDExtension From Scratch
+description: Complete instructions on how to compile GDExtension from source code.
+icon: material/book-cog
+---
+
 
 For those of you who are comfortable compiling or want to give it a shot, here are some steps to follow.