Update to GodotSteam 3.18

.github/workflows/build-releases.yml

@@ -9,7 +9,7 @@ env:
   STEAMWORKS_SDK_TAG: "sdk-1.55"
   GODOT_TAG: "3.5.1-stable"
   VERSION_TAG: "351"
-  ZIP_TAG: "g351-s155-gs3174"
+  ZIP_TAG: "g351-s155-gs3175"
 
 jobs:
   env-setup:

README.md

@@ -17,60 +17,57 @@ Feel free to chat with us about GodotSteam on the [CoaguCo Discord server](https
 
 Current Build
 ----------
-You can [download pre-compiled versions _(currently v3.17.5)_ of this repo here](https://github.com/Gramps/GodotSteam/releases).
+You can [download pre-compiled versions _(currently v3.18)_ of this repo here](https://github.com/Gramps/GodotSteam/releases).
 
-**Version 3.17.5 Changes**
-- Changed: submitItemUpdate to use null if no notes are passed, thanks to _mashumafi_
-- Removed: unused server signals
-
-**Version 3.17.4 Changes**
-- Changed: leaderboard_scores_downloaded and leaderboard_score_updated now pass back their handles; this is incompatible with earlier versions
-- Fixed: issue where leaderboard_score_uploaded would not fire if passed leaderboard_handle was not internally stored
-
-**Version 3.17.3 Changes**
-- Fixed: getVoice and getAvailableVoice functions
-- Removed: all server functionality, put back into server branch
-
-**Version 3.17.2 Changes**
-- Changed: ping to data_age in getLocalPingLocation to accurately label the returned data
-
-**Version 3.17.1 Changes**
-- Fixed: missing comma in getVideoURL argument function
-- Fixed: argument name mismatch with file_details_result
-- Fixed: wrong int type for inventory update handle
-- Fixed: not casting app ID for addFavoriteGame
-- Fixed: wrong int type for server ID in getLobbyGameServer
-- Fixed: not casting account ID for createQueryUserUGCRequest
-
-**Version 3.17 Changes**
-- Added: new functions, enums for Steamworks SDK 1.55
-- Fixed: getPublicIP in Game Servers class
+**Version 3.18 Changes**
+- Added: avatar_image_loaded callback to get raw response from Steamworks
+- Changed: project layout to be Git clone friendly
+- Fixed: getSessionConnectionInfo using old networking struct
+- Fixed: incorrectly named io_failure for steamworks_error signal, thanks to _raulsntos_
+- Removed: unused networking stricts
 
 [You can read more change-logs here](https://gramps.github.io/GodotSteam/changelog-godot3.html).
 
 Known Issues
 ----------
 - **Using MinGW causes crashes.** I strongly recommend you **do not use MinGW** to compile at this time.
-- As of Steamworks SDK 1.53, you cannot compile with previous version of GodotSteam (3.11.1 or earlier) due to a code change in the SDK.
-  - Using Steamworks SDK 1.53 or newer, you must use GodotSteam 3.12 or newer.
-  - Using Steamworks SDK 1.53 or earlier, you must use GodotSteam 3.11.1 or earlier.
+- **As of Steamworks SDK 1.53,** you cannot compile with previous version of GodotSteam (3.11.1 or earlier) due to a code change in the SDK.
+  - Using _**Steamworks SDK 1.53 or newer**_, you must use _**GodotSteam 3.12 or newer**_.
+  - Using _**Steamworks SDK 1.53 or earlier**_, you must use _**GodotSteam 3.11.1 or earlier**_.
 
-Quick How-To
+"Quick" How-To
 ----------
+#### 1a. Downloading
+By far the easiest way to use GodotSteam is to download our pre-compiled editors and templates; especially good for folks who don't want to set up the tools for compiling and just want to get going.
 - Download the [pre-compiled editor from the Release section](https://github.com/Gramps/GodotSteam/releases) and unpack it.
+- Alternatively you can download and install the [GDNative plug-in through Godot Asset Library](https://godotengine.org/asset-library/asset/1045).
+- Everything you need should be included.
+  - Users on Linux may have issues with the libsteam_api.so, if so then [read our Linux Caveats doc](https://gramps.github.io/GodotSteam/tutorials-linux-caveats.html).
 
-**Alternatively, to compile it yourself:**
+At this point you can skip all the following steps and check our our tutorials to learn more about integrating Steamworks or just explore the SDK!
 
-- Download this repository and unpack it.
-- Download and unpack the [Steamworks SDK 1.55](https://partner.steamgames.com); this requires a Steam developer account.
-  - Please see "Known Issues" above about versions.
+#### 1b. Compile Yourself
+For those of you who are comfortable compiling or want to give it a shot, here are some steps to follow.
+- Set your system up for [compiling based on Godot's recommendations / required tools.](https://docs.godotengine.org/en/stable/development/compiling/index.html)
 - Download and unpack the [Godot source 3.x](https://github.com/godotengine/godot).
-- Move the following to godotsteam/sdk/ folder:
+- Acquire the GodotSteam source either by downloading it here or cloning the repo:
+  - Download this repository then unpack it into a folder called **godotsteam** inside your Godot Engine source code **/modules** folder.
+    - You will have to create the **godotsteam** folder and it must be named exactly this.
+  - Alternatively, clone this repository into your Godot Engine source code **/modules** folder
+    - Use ````git clone https://github.com/Gramps/GodotSteam.git godotsteam````
+- Download and unpack the [Steamworks SDK 1.55](https://partner.steamgames.com).
+  - This requires a Steam developer account.
+  - Please see "Known Issues" above about versions.
+
+##### 2. Setting Up the SDK
+Move the following from the unzipped Steamworks SDK to the **/modules/godotsteam/sdk/** folder:
 ````
     sdk/public/
     sdk/redistributable_bin/
 ````
-- The repo's directory contents should now look like this:
+
+##### 3. Double-Checking Folder / File Structure
+The repo's directory contents should now look like this:
 ````
     godotsteam/sdk/public/*
     godotsteam/sdk/redistributable_bin/*
@@ -81,20 +78,26 @@ Quick How-To
     godotsteam/register_types.cpp
     godotsteam/register_types.h
 ````
-- Now move the "godotsteam" directory into the "modules" directory of the unpacked Godot Engine source.
-  - You can also just put the godotsteam directory where ever you like and just apply the ````custom_modules=.../path/to/dir/godotsteam```` flag in SCONS when compiling.  Make sure the ````custom_modules=```` flag points to where godotsteam is located.
-- Recompile for your platform:
-  - **NOTE:** use SCONS flags ````production=yes tools=yes target=release_debug```` for your editor and ````production=yes tools=no target=release```` for your templates.
-  - Windows ( http://docs.godotengine.org/en/stable/reference/compiling_for_windows.html )
-  - Linux ( http://docs.godotengine.org/en/stable/reference/compiling_for_x11.html )
-    - If using Ubuntu 16.10 or higher and having issues with PIE security in GCC, use LINKFLAGS='-no-pie' to get an executable instead of a shared library.
-  - MacOS ( http://docs.godotengine.org/en/stable/reference/compiling_for_osx.html )
-    - When creating templates for this, please refer to this post for assistance as the documentation is a bit lacking ( http://steamcommunity.com/app/404790/discussions/0/364042703865087202/ ).
-- When recompiling the engine is finished do the following before running it the first time:
+
+You can also just put the godotsteam directory where ever you like and just apply the ````custom_modules=.../path/to/dir/godotsteam```` flag in SCONS when compiling.  Make sure the ````custom_modules=```` flag points to where the godotsteam folder is located.
+
+##### 4. Compiling Time
+Recompile for your platform:
+  - For editors: ````scons platform=<your platform> production=yes tools=yes target=release_debug````
+  - For debug templates: ````scons platform=<your platform> production=yes tools=no target=release_debug````
+  - For release templates: ````scons platform=<your platform> production=yes tools=no target=release````
+
+Some things to be aware of:
+- If using Ubuntu 16.10 or higher and having issues with PIE security in GCC, use ````LINKFLAGS='-no-pie'```` to get an executable instead of a shared library.
+- When creating templates for OSX, please refer to this post for assistance as the documentation is a bit lacking ( http://steamcommunity.com/app/404790/discussions/0/364042703865087202/ ).
+
+##### 5. Altogether Now
+When recompiling the engine is finished, do the following before running it the first time:
   - Copy the shared library (steam_api), for your OS, from sdk/redistributable_bin/ folders to the Godot binary location (by default in the godot source /bin/ file but you can move them to a new folder).
-  - Create a steam_appid.txt file with your game's app ID or 480 in this folder.  Necessary if the editor or game is run _outside_ of Steam.
+    - These files are called **steam_api.dll, steam_api64.dll, libsteam_api.so, or libsteam_api.dylib**; no other files are needed.
+  - Create a **steam_appid.txt** file with your game's app ID or 480 in this folder.  Necessary if the editor or game is run _outside_ of Steam.
 
-- The finished hierarchy should look like this (if you downloaded the pre-compiles, the editor files go in place of these tools files, which are the same thing):
+The finished hierarchy should look like this (if you downloaded the pre-compiles, the editor files go in place of these tools files, which are the same thing):
   - Linux 32/64-bit
   ```
   libsteam_api.so
@@ -119,9 +122,11 @@ Quick How-To
   steam_appid.txt
   ./godot.windows.tools.64.exe
   ```
-- Lack of the Steam API DLL/SO/DyLib (for your respective OS) or the steam_appid.txt will cause it fail and crash when testing or running the game outside of the Steam client.
-  - **NOTE:** For MacOS, the libsteam_api.dylib and steam_appid.txt must be in the Content/MacOS/ folder in your application zip or the game will crash.
-  - **NOTE:** For Linux, you may have to load the overlay library for Steam overlay to work:
+
+Lack of the **Steam API .dll/.so/.dylib**, for your respective OS, or the **steam_appid.txt** will cause the editor or game fail and crash when testing or running the game _outside_ of the Steam client.
+- **NOTE:** Some people report putting the Steam API file inside their project folder fixes some issues.
+- **NOTE:** For MacOS, the libsteam_api.dylib and steam_appid.txt must be in the Content/MacOS/ folder in your application zip or the game will crash.
+- **NOTE:** For Linux, you may have to load the overlay library for Steam overlay to work:
   ```
   export LD_PRELOAD=~/.local/share/Steam/ubuntu12_32/gameoverlayrenderer.so;~/.local/share/Steam/ubuntu12_64/gameoverlayrenderer.so
   
@@ -130,11 +135,14 @@ Quick How-To
   export LD_PRELOAD=~/.local/share/Steam/ubuntu12_32/gameoverlayrenderer.so;
   export LD_PRELOAD=~/.local/share/Steam/ubuntu12_64/gameoverlayrenderer.so;
   ```
-  This can be done in an .sh file that runs these before running your executable.  This issue may not arise for all users and can also just be done by the user in a terminal separately.
+  This can be done in an .sh file that runs these before running your executable.  This issue may not arise for all users and can also just be done by the user in a terminal separately.  You can [read more about it in our Linux Caveats doc](https://gramps.github.io/GodotSteam/tutorials-linux-caveats.html).
+
+##### 6. Good To Go
 
-From here you should be able to call various functions of Steamworks. You should be able to look up the functions in Godot itself under the search section. In addition, you should be able to read the Steamworks API documentation to see what all is available and cross-reference with GodotSteam.
+From here you should be able to call various functions of Steamworks. You should be able to look up the functions in Godot itself under the search section. In addition, you should be able to [read the Steamworks API documentation](https://partner.steamgames.com/doc/home) to see what all is available and [cross-reference with GodotSteam's documentation](https://gramps.github.io/GodotSteam/).
 
-- When uploading your game to Steam, you *must* upload your game's executable and Steam API DLL/SO/DyLIB (steam_api.dll, steam_api64.dll, libsteam_api.dylib, and/or libsteam_api.so).  *Do not* include the steam_appid.txt or any .lib files as they are unnecessary.
+##### 7. Shipping Your Game
+When uploading your game to Steam, you _**must**_ upload your game's executable and **Steam API .dll/.so/.dylb** (steam_api.dll, steam_api64.dll, libsteam_api.dylib, and/or libsteam_api.so).  *Do not* include the steam_appid.txt or any .lib files as they are unnecessary; however, they won't hurt anything.
 
 Donate
 -------------

godotsteam/godotsteam.cpp → godotsteam.cpp

@@ -138,16 +138,6 @@
 #define STAT_NAME_MAX 128
 
 
-/////////////////////////////////////////////////
-///// DECLARING STRUCTS
-/////////////////////////////////////////////////
-//
-struct SteamNetworkingIdentity networkingIdentity;
-struct SteamNetworkingConfigValue_t networkingConfigValue;
-struct SteamNetworkingIPAddr networkingIPAddress;
-struct SteamNetworkPingLocation_t networkPingLocation;
-
-
 /////////////////////////////////////////////////
 ///// STEAM SINGLETON? STEAM SINGLETON
 /////////////////////////////////////////////////
@@ -4439,7 +4429,7 @@ Dictionary Steam::getSessionConnectionInfo(const String& identity_reference, boo
 	if(SteamNetworkingMessages() != NULL){
 		SteamNetConnectionInfo_t this_info;
 		SteamNetConnectionRealTimeStatus_t this_status;
-		int connection_state = SteamNetworkingMessages()->GetSessionConnectionInfo(networkingIdentity, &this_info, &this_status);
+		int connection_state = SteamNetworkingMessages()->GetSessionConnectionInfo(networking_identities[identity_reference.utf8().get_data()], &this_info, &this_status);
 		// Parse the data to a dictionary
 		connection_info["connection_state"] = connection_state;
 		// If getting the connection information