Update to Steamworks 1.61 (#19)

* Update to Steamworks 1.61
* Update docs, add `LobbyEnter_t` as callback

Author: johnfairh

.github/workflows/test.yml

@@ -9,31 +9,31 @@ on:
 jobs:
   macos:
     name: macOS SPM unit tests
-    runs-on: macos-14
+    runs-on: macos-15
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: true
           persist-credentials: false
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '16.0'
+          xcode-version: '16.1'
       - name: Set up SDK
         run: cd sdk && sudo make install
       - name: Run tests
         run: swift test
 
   macos_raw:
     name: macOS raw build
-    runs-on: macos-14
+    runs-on: macos-15
     steps:
       - uses: actions/checkout@v4
         with:
           submodules: true
           persist-credentials: false
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '16.0'
+          xcode-version: '16.1'
       - name: Raw build
         run: swift build
 

.jazzy.yaml

@@ -22,8 +22,8 @@ build_tool_arguments:
   - "-I${PWD}/sdk/public"
   - "-Xlinker"
   - "-lc++"
-title: Steamworks v1.0.0
-module_version: 1.0.0
+title: Steamworks v1.1.0
+module_version: 1.1.0
 topic_style: source-order-defs
 hide_coverage: true
 undocumented_text: ""
@@ -289,7 +289,6 @@ custom_groups:
       children:
         - GameServerItem
         - LobbyCreated
-        - LobbyEnter
         - LobbyMatchList
         - ServerNetAdr
     - name: Callbacks
@@ -299,6 +298,7 @@ custom_groups:
         - LobbyChatMsg
         - LobbyChatUpdate
         - LobbyDataUpdate
+        - LobbyEnter
         - LobbyGameCreated
         - LobbyInvite
         - LobbyKicked
@@ -530,10 +530,17 @@ custom_groups:
     - name: Interfaces
       children:
         - SteamTimeline
+    - name: Simple types
+      children:
+        - TimelineEventHandle
     - name: Enumerations and Option Sets
       children:
         - TimelineEventClipPriority
         - TimelineGameMode
+    - name: Structures
+      children:
+        - SteamTimelineEventRecordingExists
+        - SteamTimelineGamePhaseRecordingExists
   - name: SteamUGC
     topics:
     - name: Interfaces
@@ -630,12 +637,12 @@ custom_groups:
         - LeaderboardScoresDownloaded
         - LeaderboardUGCSet
         - NumberOfCurrentPlayers
+        - UserStatsReceived
     - name: Callbacks
       children:
         - PS3TrophiesInstalled
         - UserAchievementIconFetched
         - UserAchievementStored
-        - UserStatsReceived
         - UserStatsStored
         - UserStatsUnloaded
   - name: SteamUtils
@@ -671,6 +678,8 @@ custom_groups:
         - SteamVideo
     - name: Callbacks
       children:
+        - BroadcastUploadStart
+        - BroadcastUploadStop
         - GetOPFSettingsResult
         - GetVideoURLResult
   - name: Common Types

DocIndex/docc-steambase-callbacks.md

@@ -4,6 +4,8 @@
 - ``onAppResumingFromSuspend(_:)``
 - ``onAvailableBeaconLocationsUpdated(_:)``
 - ``onAvatarImageLoaded(_:)``
+- ``onBroadcastUploadStart(_:)``
+- ``onBroadcastUploadStop(_:)``
 - ``onClientGameServerDeny(_:)``
 - ``onDlcInstalled(_:)``
 - ``onDownloadItemResult(_:)``
@@ -68,6 +70,7 @@
 - ``onLobbyChatMsg(_:)``
 - ``onLobbyChatUpdate(_:)``
 - ``onLobbyDataUpdate(_:)``
+- ``onLobbyEnter(_:)``
 - ``onLobbyGameCreated(_:)``
 - ``onLobbyInvite(_:)``
 - ``onLobbyKicked(_:)``
@@ -136,7 +139,6 @@
 - ``onUnreadChatMessagesChanged(_:)``
 - ``onUserAchievementIconFetched(_:)``
 - ``onUserAchievementStored(_:)``
-- ``onUserStatsReceived(_:)``
 - ``onUserStatsStored(_:)``
 - ``onUserStatsUnloaded(_:)``
 - ``onUserSubscribedItemsListChanged(_:)``
@@ -149,6 +151,8 @@
 - ``appResumingFromSuspend``
 - ``availableBeaconLocationsUpdated``
 - ``avatarImageLoaded``
+- ``broadcastUploadStart``
+- ``broadcastUploadStop``
 - ``clientGameServerDeny``
 - ``dlcInstalled``
 - ``downloadItemResult``
@@ -213,6 +217,7 @@
 - ``lobbyChatMsg``
 - ``lobbyChatUpdate``
 - ``lobbyDataUpdate``
+- ``lobbyEnter``
 - ``lobbyGameCreated``
 - ``lobbyInvite``
 - ``lobbyKicked``
@@ -281,7 +286,6 @@
 - ``unreadChatMessagesChanged``
 - ``userAchievementIconFetched``
 - ``userAchievementStored``
-- ``userStatsReceived``
 - ``userStatsStored``
 - ``userStatsUnloaded``
 - ``userSubscribedItemsListChanged``

DocIndex/jazzy-custom-groups.yaml

@@ -258,7 +258,6 @@
       children:
         - GameServerItem
         - LobbyCreated
-        - LobbyEnter
         - LobbyMatchList
         - ServerNetAdr
     - name: Callbacks
@@ -268,6 +267,7 @@
         - LobbyChatMsg
         - LobbyChatUpdate
         - LobbyDataUpdate
+        - LobbyEnter
         - LobbyGameCreated
         - LobbyInvite
         - LobbyKicked
@@ -499,10 +499,17 @@
     - name: Interfaces
       children:
         - SteamTimeline
+    - name: Simple types
+      children:
+        - TimelineEventHandle
     - name: Enumerations and Option Sets
       children:
         - TimelineEventClipPriority
         - TimelineGameMode
+    - name: Structures
+      children:
+        - SteamTimelineEventRecordingExists
+        - SteamTimelineGamePhaseRecordingExists
   - name: SteamUGC
     topics:
     - name: Interfaces
@@ -599,12 +606,12 @@
         - LeaderboardScoresDownloaded
         - LeaderboardUGCSet
         - NumberOfCurrentPlayers
+        - UserStatsReceived
     - name: Callbacks
       children:
         - PS3TrophiesInstalled
         - UserAchievementIconFetched
         - UserAchievementStored
-        - UserStatsReceived
         - UserStatsStored
         - UserStatsUnloaded
   - name: SteamUtils
@@ -640,6 +647,8 @@
         - SteamVideo
     - name: Callbacks
       children:
+        - BroadcastUploadStart
+        - BroadcastUploadStop
         - GetOPFSettingsResult
         - GetVideoURLResult
   - name: Common Types

README.md

@@ -1,5 +1,5 @@
 ![macOS](https://shields.io/badge/platform-macOS%20|%20Linux%20|%20%3F%3F-lightgrey)
-![Steamworks 1.60](https://shields.io/badge/steamworks-1.60-lightgrey)
+![Steamworks 1.61](https://shields.io/badge/steamworks-1.61-lightgrey)
 [![Test](https://github.com/johnfairh/steamworks-swift/actions/workflows/test.yml/badge.svg)](https://github.com/johnfairh/steamworks-swift/actions/workflows/test.yml)
 ![MIT](https://shields.io/badge/license-MIT-black)
 
@@ -246,9 +246,9 @@ executors to look after gameservers or lower-priority work.
 ## How To Use This Project
 
 Prereqs:
-* Needs Swift 6 beta (Xcode 16 beta)
+* Needs Swift 6 beta (Xcode 16+)
 * Needs Steam client installed (and logged-in, running for the tests or to do anything useful)
-* I'm using macOS 14; should work on Linux; might work on Windows eventually
+* I'm using macOS 15; should work on Linux; might work on Windows eventually
 
 Install the Steamworks SDK:
 * Clone [steamworks-swift-sdk](https://github.com/johnfairh/steamworks-swift-sdk)
@@ -264,7 +264,7 @@ import PackageDescription
 let package = Package(
   name: "MySteamApp",
   platforms: [
-    .macOS("14.0"),
+    .macOS("15.0"),
   ],
   dependencies: [
     .package(url: "https://github.com/johnfairh/steamworks-swift", from: "1.0.0"),

Sources/CSteamworks/Generated/steam_struct_shims.h

@@ -260,6 +260,13 @@ static inline const char * _Nonnull SteamRemotePlayTogetherGuestInvite_t_m_szCon
     return s->m_szConnectURL;
 }
 
+__attribute__((swift_name("getter:SteamTimelineGamePhaseRecordingExists_t.m_rgchPhaseID_ptr(self:)")))
+static inline const char * _Nonnull SteamTimelineGamePhaseRecordingExists_t_m_rgchPhaseID_ptr(const SteamTimelineGamePhaseRecordingExists_t * _Nonnull s)
+{
+    const_cast<SteamTimelineGamePhaseRecordingExists_t *>(s)->m_rgchPhaseID[63] = 0;
+    return s->m_rgchPhaseID;
+}
+
 __attribute__((swift_name("getter:SteamUGCDetails_t.m_rgchTitle_ptr(self:)")))
 static inline const char * _Nonnull SteamUGCDetails_t_m_rgchTitle_ptr(const SteamUGCDetails_t * _Nonnull s)
 {

Sources/LibGenerate/Callbacks.swift

@@ -30,6 +30,7 @@ struct Callbacks {
                 }
                 if let cb = method.callback {
                     explicitCallbacks.insert(cb)
+                    print("Add ExCB: \(cb)")
                 }
             }
         }

Sources/LibGenerate/Resources/EXPECTED_SDK

@@ -1 +1 @@
-1.60
+1.61

Sources/LibGenerate/Resources/steam_api_patch.yaml

@@ -538,6 +538,8 @@ methods:
         type: RTime32
       unFlags:
         type: EFavoriteFlags
+  SteamAPI_ISteamMatchmaking_CreateLobby:
+    callback: LobbyEnter_t
   SteamAPI_ISteamMatchmaking_DeleteLobbyData:
     discardable_result: true
   SteamAPI_ISteamMatchmaking_GetFavoriteGame:

Sources/Steamworks/Documentation.docc/Generated/SteamMatchmaking Interface.md

@@ -18,7 +18,6 @@
 ### Structures
 - ``GameServerItem``
 - ``LobbyCreated``
-- ``LobbyEnter``
 - ``LobbyMatchList``
 - ``ServerNetAdr``
 
@@ -28,6 +27,7 @@
 - ``LobbyChatMsg``
 - ``LobbyChatUpdate``
 - ``LobbyDataUpdate``
+- ``LobbyEnter``
 - ``LobbyGameCreated``
 - ``LobbyInvite``
 - ``LobbyKicked``

Sources/Steamworks/Documentation.docc/Generated/SteamTimeline Interface.md

@@ -5,6 +5,13 @@
 ### Interfaces
 - ``SteamTimeline``
 
+### Simple types
+- ``TimelineEventHandle``
+
 ### Enumerations and Option Sets
 - ``TimelineEventClipPriority``
 - ``TimelineGameMode``
+
+### Structures
+- ``SteamTimelineEventRecordingExists``
+- ``SteamTimelineGamePhaseRecordingExists``

Sources/Steamworks/Documentation.docc/Generated/SteamUserStats Interface.md

@@ -24,11 +24,11 @@
 - ``LeaderboardScoresDownloaded``
 - ``LeaderboardUGCSet``
 - ``NumberOfCurrentPlayers``
+- ``UserStatsReceived``
 
 ### Callbacks
 - ``PS3TrophiesInstalled``
 - ``UserAchievementIconFetched``
 - ``UserAchievementStored``
-- ``UserStatsReceived``
 - ``UserStatsStored``
 - ``UserStatsUnloaded``

Sources/Steamworks/Documentation.docc/Generated/SteamVideo Interface.md

@@ -6,5 +6,7 @@
 - ``SteamVideo``
 
 ### Callbacks
+- ``BroadcastUploadStart``
+- ``BroadcastUploadStop``
 - ``GetOPFSettingsResult``
 - ``GetVideoURLResult``

Sources/Steamworks/Documentation.docc/SteamBaseAPI.md

@@ -25,6 +25,8 @@
 - ``onAppResumingFromSuspend(_:)``
 - ``onAvailableBeaconLocationsUpdated(_:)``
 - ``onAvatarImageLoaded(_:)``
+- ``onBroadcastUploadStart(_:)``
+- ``onBroadcastUploadStop(_:)``
 - ``onClientGameServerDeny(_:)``
 - ``onDlcInstalled(_:)``
 - ``onDownloadItemResult(_:)``
@@ -157,7 +159,6 @@
 - ``onUnreadChatMessagesChanged(_:)``
 - ``onUserAchievementIconFetched(_:)``
 - ``onUserAchievementStored(_:)``
-- ``onUserStatsReceived(_:)``
 - ``onUserStatsStored(_:)``
 - ``onUserStatsUnloaded(_:)``
 - ``onUserSubscribedItemsListChanged(_:)``
@@ -170,6 +171,8 @@
 - ``appResumingFromSuspend``
 - ``availableBeaconLocationsUpdated``
 - ``avatarImageLoaded``
+- ``broadcastUploadStart``
+- ``broadcastUploadStop``
 - ``clientGameServerDeny``
 - ``dlcInstalled``
 - ``downloadItemResult``
@@ -302,7 +305,6 @@
 - ``unreadChatMessagesChanged``
 - ``userAchievementIconFetched``
 - ``userAchievementStored``
-- ``userStatsReceived``
 - ``userStatsStored``
 - ``userStatsUnloaded``
 - ``userSubscribedItemsListChanged``

Sources/Steamworks/Generated/Constants.swift

@@ -64,6 +64,9 @@ public enum SteamConstants {
     /// Steamworks `k_nMaxLobbyKeyLength`
     public static let maxLobbyKeyLength = Int(255)
 
+    /// Steamworks `k_cchMaxPhaseIDLength`
+    public static let maxPhaseIDSize = Int(64)
+
     /// Steamworks `k_cbMaxSteamDatagramGameCoordinatorServerLoginAppData`
     public static let maxSteamDatagramGameCoordinatorServerLoginAppDataSize = Int(2048)
 
@@ -145,6 +148,9 @@ public enum SteamConstants {
     /// Steamworks `k_cchTagListMax`
     public static let tagListMaxSize = Int(1024 + 1)
 
+    /// Steamworks `k_unTimelinePriority_KeepCurrentValue`
+    public static let timelinePriorityKeepCurrentValue = Int(1000000)
+
     /// Steamworks `k_cubUFSTagValueMax`
     public static let ufsTagValueMaxSize = Int(255)