GDExtension

A history of all changes to the gdextension branch. As of version 4.22, however, all changes refer to the godot4 branch as they have been merged.

Version 4.22.1

Added: link to GodotSteam site in in-editor docs, thanks to RTalaro
Fixed: missing ! in singleton check in MultiplayerPeer close function

Version 4.22

Added: pre-commit static checks, thanks to fales
Changed: merged GDExtension branch into Godot 4, thanks to fales
Changed: improvements to the build system, thanks to fales
Changed: revised small bits of code
Removed: automatic API fix for Windows as it will not run due to failing to load

Version 4.21

Added: new enums for Apps, Inputs, UGC, Utils
Added: new functions for Apps, Matchmaking Servers, Utils
Added: new callbacks for Matchmaking Servers
Changed: sendMessages() now has delete_failed_messages parameter
Changed: updated for Steamworks SDK 1.65
Changed: ControllerPad enum changed to SteamControllerPad
Changed: updated in-editor docs
Changed: k_cchDeveloperMetadataMax now set to 10000 instead of 5000
Removed: isSteamRunningOnSteamDeck() as new functionality was introduced in SDK 1.65
Removed: GameIDType enum GAME_TYPE_P2P

Version 4.20.1

Changed: GodotSteam should now back-up the Steam version of Godot's steam_api64.dll when updating it (Windows only)
Changed: updated in-editor docs with examples for Matchmaking Server's request server list functions
Fixed: issue where defaults in ProjectSettings were incorrect
Fixed: getPersonaState() always sending back online regardless of real status, replaced with hack
Fixed: regression for serializeResult()
Fixed: crash when calling Matchmaking Server's request server list functions without a proper filters array, print error for invalid filter arrays
Fixed: signal names for: connected_chat_joined, connect_chat_left, connected_clan_chat_message
Fixed: incorrect array types for some signals

Version 4.20

Added: app type toggle in Project Settings
Added: various app ID fields for game, demo, playtest, and tool to ProjectSettings
Added: update process to convert old project settings to new format
Added: check for mismatched Steam API file on Windows and Steam
Added: new tutorial links to in-editor docs
Added: binds for get_connection_handle() and get_state() for SteamPacketPeer, thanks to jdbool
Changed: initialization process can use correct ID based on app type setting
Changed: initFilterText() no longer takes argument as it is meant for future use
Changed: lobby_data_update callback now returns bool for success parameter
Changed: PERSONA_CHANGE_FACEBOOK_INFO updated to PERSONA_CHANGE_BROADCAST
Fixed: filterText() breaking character encoding during filtering process
Fixed: missing networking enum binds
Fixed: minor in-editor doc regressions
Fixed: minor enum regressions
Fixed: crash in lobby_chat_update when lobby member leaves with MultiplayerPeer, thanks to bearlikelion

Version 4.19.1

Changed: commented out possible issue with removing dock node
Fixed: in-editor docs error, thanks to evanwang0

Version 4.19

Added: getAvailableVoice() has been added back in
Changed: updated last of constants for in-editor docs
Changed: sample_rate_override, buffer_size_override, buffer_out_size_override parameters all renamed to drop _override portion
Changed: set getVoice() defaults buffer_size to 1024, as in Valve's SpaceWar example
Changed: getVoice() key written is now size
Changed: decompressVoice() defaults sample_rate at 11025, as in Valve's SpaceWar example
Changed: decompressVoice() now clamps sample_rate between 11025 and 48000 per SDK decoder notes
Changed: getDecompressedVoice() was rewritten based on changes to getVoice() and decompressVoice()
Changed: getDecompressedVoice() returned dictionary key changes - compressed_written to compressed_size, output_result to decompressed_result, output_buffer to decompressed_buffer, output_written to decompressed_size
Changed: various Input action origin enum names for readability
Fixed: XBOX_ORIGIN_LEFT_STICK_DPAD_EAST misspelled as XBOX_ORIGIN_LEFT_STICK_DPAD_EAT
Removed: getDecompressedVoice() as the merged functions need to be separate for usefulness

Version 4.18.1

Fixed: dock scripts for Godot 4.4.x - 4.5.x

Version 4.18

Added: new functions and enums from Steamworks SDK 1.64
Added: updater to simplify updating GDExtension plug-in
Changed: part one of in-editor doc updates, adding text for constants and enums
Changed: getBetaInfo now returns last_updated timestamp
Changed: various NULLs to nullptr
Changed: changed_id to user_changed_id in lobby_chat_update callback
Changed: updated in-editor docs for SDK 1.64
Changed: receiveMessageOnPollGroup and receiveMessagesOnChannel message releasing to Flat API version
Fixed: enum namespace qualification for proper extension_api.json generation, thanks to leetleaf
Fixed: some incorrect linking to Steam Flat API objects

Version 4.17.1

Changed: SCsub and config.py for ARM64 and Android
Fixed: potential crash in disconnect_peer; thanks to bearlikelion

Version 4.17

Added: new enums to Result, HTTPStatusCode, RemotePlayScanCode, MarketNotAllowedReasonFlags, ActionOrigin per Steam SDK 1.63
Added: getDecompressedVoice() as custom function to wrap up getVoice() and decompressVoice() in C++
Changed: converted functions entirely over to the Flat API system to fix MinGW compatibility
Changed: activateGameOverlayInviteDialog() changed argument name from steam_id to lobby_id for clarity
Changed: renamed some minor parameters
Changed: getAPICallFailureReason() now returns enum instead of string
Changed: error messages if Steam is not initialized or classes are missing
Fixed: initFilterText() now takes filter options
Fixed: sendMessages() not compiling correctly
Fixed: VOICE_RESULT_NO_DATA incorrectly named VOICE_RESULT_NO_DATE
Removed: GameSearch and Music Remote classes, constants, enums per Steam SDK 1.63

Version 4.16.2

Changed: converted Input, NetworkingUtils and UGC class to Flat API to stop MinGW crashes
Changed: int to uint64_t in file_share_result callback which broke the UGC handle
Removed: remnant bind for current_stats_received which was removed long ago

Version 4.16.1

Fixed: duplicate signal binds
Fixed: character support in getAllLobbyData()
Fixed: code related to checking for manual run_callbacks() and embedded callbacks
Fixed: misspelled signal call in friend_rich_presence_update
Fixed: compiling flag set outside of compiler check

Version 4.16

Added: missing Friends function activateGameOverlayRemotePlayTogetherInviteDialog() and getNumChatsWithUnreadPriorityMessages()
Added: missing User function getMarketEligibility() and related call result market_eligibility_response
Added: missing UGC functions setAllowLegacyUpload(), removeAllItemKeyValueTags()
Added: missing Networking Sockets function setConnectionUserData()
Added: missing Networking Utils functions setDebugOutputFunction(), getIPv4FakeIPType(), getRealIdentityForFakeIP(), setGlobalCallbackSteamNetConnectionStatusChanged(), setGlobalCallbackSteamNetAuthenticationStatusChanged(), setGlobalCallbackSteamRelayNetworkStatusChanged(), setGlobalCallbackFakeIPResult(), setGlobalCallbackMessagesSessionRequest(), setGlobalCallbackMessagesSessionFailed(), iterateGenericEditableConfigValues()
Added: missing Remote Storage call results published_file_subscribed, published_file_unsubscribed
Added: missing Remote Play callback remote_play_guest_invite
Added: Steam ID constants for game servers
Added: some missing constants
Added: default values to getQueryUGCContentDdescriptors() and getUserContentDescriptorPreferences() for max_entries as there are only five values currently
Added: missing releaseCurrentThreadMemory() function
Added: patch file for MinGW compatibility
Changed: included file ID in returned callback item_updated
Changed: included next cursor in returned callback ugc_query_completed
Changed: MarketNotAllowedReasonFlags enums corrected to bitwise
Changed: added missing result response to steam_server_disconnected callback
Changed: minor swaps from integers to enums where needed
Changed: corrected STEAM_PARTY_BEACON_LOCATION_DATA to STEAM_PARTY_BEACON_LOCATION_DATA_INVALID
Changed: some argument or variable names for clarity
Changed: advertiseGame() now has defaults to clear game advertisement is nothing is passed
Changed: connected_clan_chat_message and connected_friend_chat_message to no longer send dictionaries
Changed: getLeaderboardDisplayType() now returns the direct enum value instead of a dictionary
Changed: getLeaderboardSortMethod() now returns the direct enum value instead of a dictionary
Changed: getMostAchievedAchievementInfo() and getNextMostAchievedAchievementInfo() first key to iterator from rank to be more clear
Changed: global_achievement_percentages_ready now returns the enum / int instead of string for result
Changed: global_stats_received now returns the enum / int instead of string for result
Changed: leaderboard_ugc_set now returns the enum /int instead of string for result
Changed: getAppInstallDir() now just returns the string location of the app
Changed: getSyncPlatforms() now returns the direct enum value instead of a dictionary
Changed: enumerate_following_list callback to better fit the actual Steam callback
Changed: request_clan_officer_list callback now returns bool instead of message for success
Changed: retrieveConnectionDetails() now returns a dictionary instead of the connection details string
Changed: base_prices to base_price in getItemsWithPrices()
Fixed: added missing "app_ids" hint to get_app_dependencies_result callback
Fixed: published file ID not being uint64_t in some Remote Storage signals
Fixed: various types
Fixed: using direct values instead of constants when the names could not be found
Fixed: missing store_flag argument for activateGameOverlayToStore()
Fixed: downloadClanActivity() now takes multiple clans are intended
Fixed: constant name from LEADERBOARD_DETAIL_MAX to LEADERBOARD_DETAILS_MAX
Fixed: setOverlayNotificationPosition() not using given argument
Fixed: set limit to requestGlobalStats(), values over 60 defaults to 60 now
Fixed: some incorrect variable names
Fixed: getAchievementProgressLimitsInt() and getAchievementProgressLimitsFloat() using wrong variable name and removing unncessary name key from returned dictionary
Fixed: incorrect spelling in enum name
Removed: getClanChatMessage() as it can only be used in response to connected_clan_chat_message which it is called in anyway
Removed: getFriendMessage() as it can only be used in response to connected_friend_chat_message which it is called in anyway
Removed: getAvailableVoice() as it did nothing useful; was already incorporated into related functions
Removed: branch_size key from returned dictionary in getSupportedGameVersionData() as it was misleading and useless
Removed: sender_user_data key from returned dictionaries in receiveMessageOnChannel()
Removed: temporarily removed setDualSenseTriggerEffect() until it can be overhauled
Removed: buffer from returned dictionary in getConfigValue() as it was just the size
Removed: unnecessary keys in certain Networking Socket functions where messages are received or sent
Removed: createHostedDedicatedServerListenSocket() as it should only be in the GodotSteam Server version

Version 4.15

Added: missing functions checkFileSignature(), getConnectedUniverse() and getIPv6ConnectivityState() to Utils class
Changed: added default of true to setVRHeadsetStreamingEnabled()
Fixed: embedding callbacks not working correctly
Fixed: incorrect argument defaults for steamInitEx()
Fixed: check_file_signature variant now int instead of string
Removed: storeStats() from deconstructor as it should be storing them automatically

Version 4.14

Added: new functions and enums to SteamRemotePlay
Added: Steam icon to the class
Added: Project Settings for Steam, optional app ID, can set auto-initialization, can set embedded callbacks, thanks to TriMay
Added: new functions to UGC
Changed: replaced previous MouseCursor enum with new HTMLMouseCursor enum
Changed: updated docs
Changed: updated to Steamworks SDK 1.62
Changed: getNumSubscribedItems and getSubscribedItems now take include_locally_disabled argument
Changed: steamInit now return intended boolean and first argument removed since client syncs stats/achieves at boot
Fixed: various bits in the in-editor docs
Fixed: network_messages_session_failed missing returned properties in bind
Removed: UserRestrictions enum
Removed: SetPersonaName function and related callback name_changed
Removed: GetUserRestrictions function

Version 4.13

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

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
Added: properties for all variants GodotSteam stores
Changed: using Godot's macros for error reporting back to the editor
Changed: buffer_size argument to decompressVoice with default of original value
Changed: steamworksError replaced with prints to editor
Changed: all options array parameters for all Sockets class functions changed to dictionaries, check class docs
Changed: deprecated getAvailableVoice, merged functionality into getVoice
Changed: setLeaderboardDetailsMax changed to the set/get for leaderboard_details_max, now set_leaderboard_details_max
Changed: Steam singleton now removed during uninitialization
Fixed: proper type for network_connection_status_changed, thanks to stickyShift
Fixed: getResultItemProperty now takes empty string to send all property list, thanks to Stralor
Fixed: missing return value hints from lobby_data_update
Fixed: get_app_dependencies_result now passed back app_ids array
Fixed: missing argument hints for item_installed callback
Fixed: both global stat history functions - getGlobalStatIntHistory and getGlobalStatFloatHistory
Fixed: broken returned variable in network_connection_status_changed
Fixed: a variety of small tweaks
Removed: duplicate call on setting embedded callbacks

Version 4.10

Changed: now using Steam Flat API, should allow compiling with MinGW
Changed: updated in-editor docs

Version 4.9.1

Fixed: fixed typo in RESULT_ADMINISTRATOR_OK, thanks to sepTN
Fixed: fixed a variety of types and code corrections, thanks to bobsayhilol

Version 4.9

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

Version 4.8

Added: doc_classes back in for Godot 4.3 or higher
Added: Steam Matchmaking response handlers, thanks to jeremybeier
Added: all missing Messages and Sockets constants
Changed: Networking Messages, Sockets, and Utils now use Steam IDs instead of identity system
Changed: UserUGCListSortOrder enums for readability
Changed: UGCContentDescriptorID enums for readability
Changed: getResultStatus() now returns the integer / enum
Changed: cleaned up addItemPreviewFile(), check_file_signature, and showGamepadTextInput()
Changed: various bits and pieces
Changed: IP logic for all related functions
Changed: addFavoriteGame(), initiateGameConnection(), terminateGameConnection(), and removeFavoriteGame() now take strings for IP
Changed: getAuthSessionTicket() now defaults to 0 for Steam ID
Changed: IP address now accepted instead of IP references
Fixed: getFriendCount() has correct bit-wise value
Fixed: server browser functionality, thanks to jeremybeier
Fixed: wrong string IP conversions, thanks to jeremybeier
Fixed: server list request filters, thanks to jeremybeier
Fixed: typo with UGC_MATCHING_UGC_TYPE_ITEMS enum
Fixed: minor case issue with Workshop enums
Fixed: playerDetails(), requestFavoritesServerList(), requestInternetServerList(), requestSpectatorServerList(), requestFriendsServerList(), requestHistoryServerList(), and pingServer(), thanks to jeremybeier
Fixed: regressions caused by minor update
Fixed: typo with NETWORKING_CONFIG_TYPE_STRING enum
Fixed: typo with LOBBY_COMPARISON_EQUAL_TO_GREATER_THAN
Fixed: in-editor docs
Removed: Networking Types identity system and related bits
Removed: P2P Networking constants as they are duplicates of the P2PSend enum
Removed: previous, non-functioning Matchmaking Server call results
Removed: getIdentity() as it is redundant now

Version 4.7

Changed: minor organization and readability changes
Fixed: htmlInit() not returning bool for success
Fixed: regression in receiveMessagesOnChannel()
Fixed: missing argument bind in getListenSocketAddress()
Removed: unused docs XML

Version 4.6.3

Changed: returned values for getFriendGamePlayed, thanks to SlejmUr
Changed: getItemPrice() now returns base price and price, thanks to SlejmUr
Changed: getFriendMessage() and callback connected_friend_chat_message now returns the type, thanks to SlejmUr
Changed: updated in-editor docs with changes
Changed: updated submodule to Godot-cpp 4.2.2
Fixed: missing info_flags key in getSessionConnectionInfo(), thanks to SlejmUr
Fixed: getServerDetails() not sending back needed struct, thanks to SlejmUr

Version 4.6.2

Added: internal notes about where enums are found
Added: minor extra helper functions from Steam's client header
Added: getSteamID32() function to convert SteamID64 to SteamID
Changed: replaced deprecated Controller struct with Inputs struct in getDigitalActionData()
Changed: leaderboard details max now set at highest instead of zero by default
Fixed: incorrect constant for PUBLISHED_FILE_UPDATE_HANDLE_INVALID
Fixed: getAllLobbyData() sending back all pairs, thanks to freehuntx

Version 4.6.1

Skipped to keep versioning the game with 4.x module

Version 4.6

Added: new Remote Storage enum to WorkshopFileType
Added: two new UGC enums to ItemState and ItemPreviewType
Added: two new Friends class constants
Added: new function dismissGamepadTextInput()
Added: new Remote Play enum, form factor for VR headset
Added: two new result enums; not supported and family size limit exceeded
Added: three new enums to NetworkingConfigValue
Added: new general constant ACCOUNT_ID_INVALID
Changed: FEATURE_KIOSK_MODE enum now deprecated
Changed: minor housekeeping by rearranging some functions
Changed: k_ESteamNetworkingConfig_SDRClient_DebugTicketAddress was replaced by k_ESteamNetworkingConfig_SDRClient_DevTicket, value is the same but reference changed
Changed: updated in-editor docs
Fixed: spelling error in getProfileItemPropertyInt() bind
Removed: App Lists class functions, callbacks, etc. due to SDK 1.59 changes
Removed: Remote Play enums mistakenly added as constants

Version 4.5.4

Added: missing k_nSteamNetworkingSend_AutoRestartBrokenSession to constants
Added: two missing Input constants: INPUT_HANDLE_ALL_CONTROLLERS and INPUT_MAX_ACTIVE_LAYERS
Changed: getInputTypeForHandle() now returns int / enum instead of string for device models
Changed: createBrowser now like module version
Changed: html_browser_ready now call result instead of callback
Changed: order of constants to be alphabetic
Changed: changed returned variable name to need_to_accept_tos in item_updated callback
Changed: Github Actions scripts, one for Vulkan and another for version numbers

Version 4.5.3

Fixed: requestClanOfficerList() using wrong internal function, thanks to sepTN

Version 4.5.2

Fixed: crashes on generateItems(), startPurchase(), and exchangeItems(), thanks to sepTN

Version 4.5.1

Fixed: app ID automatically being set to 480, now default is 0 which makes GodotSteam ignore auto-setting app ID

Version 4.5

Added: two new arguments to steamInit() and steamInitEx() to set your app ID and run_callbacks interally, 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

Version 4.4.3

Fixed: requestEquippedProfileItems() was missing method bind, thanks to BOTLANNER
Fixed: get_ticket_for_web_api callback for getting actual ticket buffer, thanks to dicarne
Fixed: compiler complaining about comparison between Steam enum and GodotSteam enum for steamInitEx()
Fixed: getListenSocketAddress() fixed to provide the actual address and optional port
Changed: different defaults in Github Actions files
Changed: createBrowser() now sends proper NULL when empty string passed
Changed: html_browser_ready from callback to proper call result
Changed: cast handle in setSize() as Steam HHTMLBrowser
Removed: unnecessary steam_appid.txt from zips in Github Actions

Version 4.4.2

Changed: bump for Godot 4.1.2

Version 4.4.1

Fixed: missing descriptions for some in-editor functions/signals
Fixed: receiveMessagesOnChannel(), receiveMessagesOnPollGroup(), and receiveMessagesOnConnection() had overwriting dictionary keys

Version 4.4

Added: new enums and constant related to new Steam initialization function
Added: new enums for NetworkingConfigValue
Added: new intialization function steamInitEx() that is more verbose
Added: new UGC function getUserContentDescriptorPreferences()
Added: new Remote Play function startRemotePlayTogether()
Changed: UGC functionsetItemTags() to have new argument for admin tags
Changed: compatible with Steamworks SDK 1.58

Version 4.3.1

Fixed: wrong variant type for join_requested

Version 4.3

Added: full GodotSteam documentation into the editor
Added: steamShutdown() to allow Steamworks to be manually shutdown
Added: requestEquippedProfileItems() function and equipped_profile_items callback
Added: Steam Deck as Steam Input type
Changed: all enums are now directly linked to their SDK counterparts
Changed: getDigitalActionData() returned keys are now state and active
Changed: names of some Steam enums to be cleaner and leaner
Changed: getAppInstallDir() now returns dictionary with absolute path and install size
Fixed: some missing enum binds
Fixed: missing function argument binds
Fixed: get_ticket_for_web_api sending back strings
Removed: enums that are not in the SDK but Valve's docs

Version 4.2.5

Changed: updated submodule for Godot 4.1.1
Fixed: more stuff in godotsteam.gdextension file

Version 4.2.4

Added: new Input callback input_gamepad_slot_change
Added: new User callback get_ticket_for_web_api
Added: new User function getAuthTicketForWebApi()
Changed: getAuthSessionTicket() argument is now optional, defaults to NULL

Version 4.2.3

Added: new return values for overlay_toggled; this will break compatibility with this
Added: new Input and Parental Settings enums
Added: new UGC Content Descriptor ID enums
Added: new UGC functions removeContentDescriptor(), addContentDescriptor(), and getQueryUGCContentDescriptors()
Added: new signal filter_text_dictionary_changed
Changed: getAuthSessionTicket() now uses networking identities
Changed: gamepad_text_input_dismissed now passes back the app ID
Changed: Steam Input max analog and digital actions values
Removed: ERegisterActivationCodeResult due to removal in SDK

Version 4.2.2

Changed: names of all godotsteam dll/so/dylib files to be less verbose

Version 4.2.1

Added: compiled dylib files for OSX, thanks to definitelyokay
Fixed: names of OSX files in the godotsteam.gdextension file

Version 4.2

Changed: brought the plug-in version up to speed with the module version