Provides helper methods for unlocking and querying Steam achievements.

var achievements = new AchievementManager(logger);
achievements.UnlockAchievement("ACH_WIN_ONE_GAME");

Attempts to unlock the provided achievement and store user stats.

• achievementId: string

• achievementId: Steam achievement identifier to unlock.

Checks whether a Steam achievement is currently unlocked.

• achievementId: string
• unlocked: out bool

• achievementId: Steam achievement identifier to check.
• unlocked: True when the achievement is unlocked.

Provides access checks for ISteamController.

Provides access checks for ISteamFriends.

Gets the friend count filtered by Steam friend flags.

• friendFlags: int

• friendFlags: Bitmask value matching Steam EFriendFlags.

Gets the persona name of a friend by SteamID64.

• steamIdFriend: ulong

• steamIdFriend: Friend SteamID64.

Opens the Steam invite dialog for a lobby.

• steamIdLobby: ulong

• steamIdLobby: Lobby SteamID64.

Sets a rich presence key/value pair for the local user.

• key: string
• value: string

• key: Rich presence key.
• value: Rich presence value.

Clears all rich presence values for the local user.

Gets a rich presence value for a specific friend.

• steamIdFriend: ulong
• key: string

• steamIdFriend: Friend SteamID64.
• key: Rich presence key.

Invites a friend to the current game session using a connect string.

• steamIdFriend: ulong
• connectString: string

• steamIdFriend: Friend SteamID64.
• connectString: Game connect string passed through Steam invite.

Provides access checks for ISteamGameCoordinator.

Provides access checks for ISteamGameServer.

Provides access checks for ISteamGameServerStats.

Provides access checks for ISteamHTMLSurface.

Provides access checks for ISteamInput.

Initializes Steam Input for the application.

• explicitlyCallRunFrame: bool

• explicitlyCallRunFrame: Set true when your game will manually call RunFrame each frame.

Shuts down Steam Input.

Runs a Steam Input frame update.

Provides access checks for ISteamInventory.

Requests latest inventory item definitions from Steam.

Requests all inventory items and returns a result handle.

• inventoryResultHandle: out int

• inventoryResultHandle: Inventory result handle to use with additional inventory API calls.

Releases an inventory result handle returned from Steam Inventory API calls.

• inventoryResultHandle: int

• inventoryResultHandle: Inventory result handle to release.

Manages Steamworks initialization, callback polling, and shutdown for applications using the Steam API.

SteamManager.ConfigureLogger(logger);
SteamManager.ConfigureAppId(480);
var steam = SteamManager.Instance;
steam.Update();

Singleton access to the Steam manager.

Indicates whether Steamworks is initialized and ready for API calls.

Provides access to Steam Workshop (UGC) helper operations.

Provides access to Steam Remote Play helper operations.

Provides access to ISteamController bindings.

Provides access to ISteamFriends bindings.

Provides access to ISteamGameCoordinator bindings.

Provides access to ISteamGameServer bindings.

Provides access to ISteamGameServerStats bindings.

Provides access to ISteamHTMLSurface bindings.

Provides access to ISteamInput bindings.

Provides access to ISteamInventory bindings.

Provides access to ISteamMatchmaking bindings.

Provides access to ISteamMatchmakingServers bindings.

Provides access to ISteamMusic bindings.

Provides access to ISteamParties bindings.

Provides access to ISteamRemoteStorage bindings.

Provides access to ISteamScreenshots bindings.

Provides access to ISteamUserStats bindings.

Provides access to ISteamUtils bindings.

Provides access to ISteamVideo bindings.

Configures the logger used by Steamworks helper classes.

• logger: ILogger

• logger: ILogger instance to receive Steamworks logs.

Configures the Steam AppId used during initialization. Must be called before accessing the singleton instance.

• appId: uint

• appId: Steam application identifier.

Executes Steamworks callbacks. Call every frame from your game loop.

Shuts down Steamworks and clears the initialized state.

Gets the current Steam persona name. Returns "Player" when Steamworks is unavailable.

Provides access checks for ISteamMatchmaking.

Requests a lobby list and returns a Steam API call handle.

Sets the maximum number of lobbies returned by RequestLobbyList.

• maxResults: int

• maxResults: Maximum number of lobby results.

Creates a lobby and returns a Steam API call handle.

• lobbyType: int
• maxMembers: int

• lobbyType: Numeric ELobbyType value.
• maxMembers: Maximum lobby member count.

Joins a lobby by SteamID64 and returns a Steam API call handle.

• steamIdLobby: ulong

• steamIdLobby: Lobby SteamID64.

Leaves a lobby by SteamID64.

• steamIdLobby: ulong

• steamIdLobby: Lobby SteamID64.

Gets the number of members currently in a lobby.

• steamIdLobby: ulong

• steamIdLobby: Lobby SteamID64.

Provides access checks for ISteamMatchmakingServers.

Provides access checks for ISteamMusic.

Checks whether Steam Music is enabled.

Checks whether Steam Music is currently playing.

Starts Steam Music playback.

Pauses Steam Music playback.

Advances to the next music track.

Moves to the previous music track.

Gets Steam Music volume (0..1 range).

Sets Steam Music volume (0..1 range).

• volume: float

• volume: New volume value.

Provides access checks for ISteamParties.

Provides helper methods for Steam Remote Play session inspection.

var remotePlay = SteamManager.Instance.RemotePlay;
var sessionCount = remotePlay.GetSessionCount();

Gets the number of active Remote Play sessions for the current user.

Gets a Remote Play session ID by zero-based session index.

• sessionIndex: int

• sessionIndex: Zero-based index into the active sessions list.

Gets the SteamID for the remote user in a session.

• sessionId: uint

• sessionId: Remote Play session ID.

Gets the client device name for a remote session.

• sessionId: uint

• sessionId: Remote Play session ID.

Gets the client form-factor value for a session (matches Steam's ESteamDeviceFormFactor numeric values).

• sessionId: uint

• sessionId: Remote Play session ID.

Gets the streaming client resolution for a session.

• sessionId: uint
• resolutionX: out int
• resolutionY: out int

• sessionId: Remote Play session ID.
• resolutionX: Width output.
• resolutionY: Height output.

Provides access checks for ISteamRemoteStorage.

Checks whether a file exists in Steam Remote Storage.

• fileName: string

• fileName: Cloud file path/name.

Gets the number of files in Steam Remote Storage for the current app/user context.

Checks whether Steam Cloud is enabled for this app.

Writes a byte array to a Steam Cloud file.

• fileName: string
• data: byte[]

• fileName: Cloud file path/name.
• data: Raw file bytes to write.

Reads a Steam Cloud file into a byte array.

• fileName: string
• data: out byte[]

• fileName: Cloud file path/name.
• data: Output file bytes when read succeeds.

Deletes a Steam Cloud file.

• fileName: string

• fileName: Cloud file path/name.

Gets file size in bytes for a Steam Cloud file.

• fileName: string

• fileName: Cloud file path/name.

Provides access checks for ISteamScreenshots.

Adds an existing screenshot to the Steam screenshot library.

• fileNameJpg: string
• fileNameThumbnail: string
• width: int
• height: int

• fileNameJpg: Screenshot image path.
• fileNameThumbnail: Thumbnail path.
• width: Image width.
• height: Image height.

Triggers an in-game screenshot event.

Enables or disables screenshot hooks for custom handling.

• hook: bool

• hook: True to hook screenshots.

Checks whether screenshot hooks are currently enabled.

Declarative update payload for workshop item editing convenience APIs.

Workshop item title.

Workshop item description.

Workshop item metadata string.

Numeric ERemoteStoragePublishedFileVisibility value.

Workshop tag list.

Absolute path to workshop content folder.

Absolute path to workshop preview image.

Fluent helper for editing and submitting a workshop item update.

Submits the fluent update session and returns a Steam API call handle.

• changeNote: string
• failedStep: out string

• changeNote: Changelog note for this update.
• failedStep: Name of the failed step if submission returns 0.

Provides helper methods for common Steam Workshop (UGC) operations such as queries and subscriptions.

var ugc = new SteamUgcManager();
var items = ugc.GetSubscribedItems();

Begins a fluent UGC update session for an existing workshop item.

• consumerAppId: uint
• publishedFileId: ulong

• consumerAppId: Your game AppId.
• publishedFileId: Existing workshop item ID.

Applies all non-null/non-empty fields from a UGC update options object to an existing update handle.

• updateHandle: ulong
• options: SteamUgcItemUpdateOptions
• failedStep: out string

• updateHandle: Handle from StartItemUpdate.
• options: Options object containing fields to apply.
• failedStep: Name of the field that failed to apply, if any.

Convenience method that starts an item update, applies option fields, and submits the update in one call.

• consumerAppId: uint
• publishedFileId: ulong
• options: SteamUgcItemUpdateOptions
• changeNote: string
• failedStep: out string

• consumerAppId: Your game AppId.
• publishedFileId: Existing workshop item ID.
• options: Options object containing fields to update.
• changeNote: Changelog note for submission.
• failedStep: Name of the failed step when the call returns 0.

Creates a new Workshop item and returns a Steam API call handle.

• consumerAppId: uint
• fileType: uint

• consumerAppId: Your game AppId.
• fileType: Numeric EWorkshopFileType value.

Starts an update transaction for an existing Workshop item.

• consumerAppId: uint
• publishedFileId: ulong

• consumerAppId: Your game AppId.
• publishedFileId: Existing workshop item ID.

Sets workshop item title for a pending update.

• updateHandle: ulong
• title: string

• updateHandle: Handle from StartItemUpdate.
• title: New item title.

Sets workshop item description for a pending update.

• updateHandle: ulong
• description: string

• updateHandle: Handle from StartItemUpdate.
• description: New item description.

Sets workshop item metadata for a pending update.

• updateHandle: ulong
• metadata: string

• updateHandle: Handle from StartItemUpdate.
• metadata: Metadata string (up to Steam's size limits).

Sets workshop item visibility for a pending update.

• updateHandle: ulong
• visibility: uint

• updateHandle: Handle from StartItemUpdate.
• visibility: Numeric ERemoteStoragePublishedFileVisibility value.

Sets workshop item tags for a pending update.

• updateHandle: ulong
• tags: string[]

• updateHandle: Handle from StartItemUpdate.
• tags: Array of tag strings.

Sets workshop item content folder path for a pending update.

• updateHandle: ulong
• contentFolder: string

• updateHandle: Handle from StartItemUpdate.
• contentFolder: Absolute path to content folder.

Sets workshop item preview image path for a pending update.

• updateHandle: ulong
• previewFile: string

• updateHandle: Handle from StartItemUpdate.
• previewFile: Absolute path to preview image file.

Submits a pending workshop item update and returns a Steam API call handle.

• updateHandle: ulong
• changeNote: string

• updateHandle: Handle from StartItemUpdate.
• changeNote: Changelog note for the update.

Gets progress state for a pending item update upload.

• updateHandle: ulong
• bytesProcessed: out ulong
• bytesTotal: out ulong

• updateHandle: Handle from StartItemUpdate.
• bytesProcessed: Uploaded bytes output.
• bytesTotal: Total bytes output.

Creates a UGC query request handle for workshop discovery.

• queryType: uint
• matchingType: uint
• creatorAppId: uint
• consumerAppId: uint
• page: uint

• queryType: Numeric EUGCQuery value from Steamworks docs.
• matchingType: Numeric EUGCMatchingUGCType value from Steamworks docs.
• creatorAppId: AppId filter for creator app.
• consumerAppId: AppId filter for consumer app.
• page: Query page number, starting at 1.

Submits an existing UGC query request and returns a Steam API call handle.

• queryHandle: ulong

• queryHandle: UGC query handle returned from CreateQueryAllUgcRequest.

Releases a UGC query handle after you are done with query results.

• queryHandle: ulong

• queryHandle: UGC query handle to release.

Gets the number of workshop items the current user is subscribed to.

Gets subscribed workshop item IDs for the current user.

• maxEntries: uint

• maxEntries: Maximum number of subscribed IDs to retrieve.

Subscribes the current user to a workshop item.

• publishedFileId: ulong

• publishedFileId: Published file ID of the workshop item.

Unsubscribes the current user from a workshop item.

• publishedFileId: ulong

• publishedFileId: Published file ID of the workshop item.

Provides access checks for ISteamUserStats.

Requests user stats for a target SteamID64 and returns a Steam API call handle.

• steamIdUser: ulong

• steamIdUser: Target SteamID64.

Requests global stats history and returns a Steam API call handle.

• historyDays: int

• historyDays: Number of days of history to request.

Resets local user stats, optionally including achievements.

• achievementsToo: bool

• achievementsToo: True to also clear achievement state.

Gets a named integer stat value.

• name: string
• data: out int

• name: Stat API name.
• data: Output integer stat value.

Sets a named integer stat value.

• name: string
• data: int

• name: Stat API name.
• data: Integer stat value to set.

Stores pending stats and achievement changes to Steam.

Provides access checks for ISteamUtils.

Gets the current Steam AppId reported by SteamUtils.

Gets the two-letter country code inferred by Steam based on the current IP.

Checks whether Steam Overlay is currently enabled.

Provides access checks for ISteamVideo.

Requests a video URL for a given Steam video app id.

• videoAppId: uint

• videoAppId: Steam video app id.

Checks whether the user is broadcasting and returns current viewer count.

• numberOfViewers: out int

• numberOfViewers: Viewer count output when broadcasting.