steamutils 1.0.5 → 1.0.6

package/protos/steammessages_useraccount.steamclient.proto

@@ -0,0 +1,210 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+enum EInternalAccountType {
+	k_EInternalSteamAccountType = 1;
+	k_EInternalClanType = 2;
+	k_EInternalAppType = 3;
+	k_EInternalBroadcastChannelType = 4;
+}
+
+enum EExternalAccountType {
+	k_EExternalNone = 0;
+	k_EExternalSteamAccount = 1;
+	k_EExternalGoogleAccount = 2;
+	k_EExternalFacebookAccount = 3;
+	k_EExternalTwitterAccount = 4;
+	k_EExternalTwitchAccount = 5;
+	k_EExternalYouTubeChannelAccount = 6;
+	k_EExternalFacebookPage = 7;
+}
+
+message CUserAccount_GetAvailableValveDiscountPromotions_Request {
+	optional string country_code = 1;
+}
+
+message CUserAccount_GetAvailableValveDiscountPromotions_Response {
+	message ValveDiscountPromotionDetails {
+		optional uint32 promotionid = 1;
+		optional string promotion_description = 2;
+		optional int64 minimum_cart_amount = 3;
+		optional int64 minimum_cart_amount_for_display = 4;
+		optional int64 discount_amount = 5;
+		optional int32 currency_code = 6;
+		optional int32 available_use_count = 7;
+		optional int32 promotional_discount_type = 8;
+		optional int32 loyalty_reward_id = 9;
+		optional string localized_name_token = 10;
+		optional int32 max_use_count = 11;
+	}
+
+	repeated .CUserAccount_GetAvailableValveDiscountPromotions_Response.ValveDiscountPromotionDetails promotions = 1;
+}
+
+message CUserAccount_GetAccountLinkStatus_Request {
+}
+
+message CUserAccount_GetAccountLinkStatus_Response {
+	optional uint32 pwid = 1;
+	optional uint32 identity_verification = 2;
+	optional bool performed_age_verification = 3;
+}
+
+message CUserAccount_CancelLicenseForApp_Request {
+	optional uint32 appid = 1;
+}
+
+message CUserAccount_CancelLicenseForApp_Response {
+}
+
+message CUserAccount_CreateFriendInviteToken_Request {
+	optional uint32 invite_limit = 1;
+	optional uint32 invite_duration = 2;
+	optional string invite_note = 3;
+}
+
+message CUserAccount_CreateFriendInviteToken_Response {
+	optional string invite_token = 1;
+	optional uint64 invite_limit = 2;
+	optional uint64 invite_duration = 3;
+	optional fixed32 time_created = 4;
+	optional bool valid = 5;
+}
+
+message CUserAccount_GetFriendInviteTokens_Request {
+}
+
+message CUserAccount_GetFriendInviteTokens_Response {
+	repeated .CUserAccount_CreateFriendInviteToken_Response tokens = 1;
+}
+
+message CUserAccount_ViewFriendInviteToken_Request {
+	optional fixed64 steamid = 1;
+	optional string invite_token = 2;
+}
+
+message CUserAccount_ViewFriendInviteToken_Response {
+	optional bool valid = 1;
+	optional uint64 steamid = 2;
+	optional uint64 invite_duration = 3;
+}
+
+message CUserAccount_RedeemFriendInviteToken_Request {
+	optional fixed64 steamid = 1;
+	optional string invite_token = 2;
+}
+
+message CUserAccount_RedeemFriendInviteToken_Response {
+}
+
+message CUserAccount_RevokeFriendInviteToken_Request {
+	optional string invite_token = 1;
+}
+
+message CUserAccount_RevokeFriendInviteToken_Response {
+}
+
+message CUserAccount_RegisterCompatTool_Request {
+	optional uint32 compat_tool = 1;
+}
+
+message CUserAccount_RegisterCompatTool_Response {
+}
+
+message CAccountLinking_GetLinkedAccountInfo_Request {
+	optional .EInternalAccountType account_type = 1 [default = k_EInternalSteamAccountType];
+	optional uint64 account_id = 2 [(description) = "Internal account ID"];
+	optional .EExternalAccountType filter = 3 [default = k_EExternalNone, (description) = "if specified then only return this external account type"];
+	optional bool return_access_token = 4 [(description) = "if provided and true, then returns valid access token if available. It may refresh the token. "];
+}
+
+message CAccountLinking_GetLinkedAccountInfo_Response {
+	message CExternalAccountTuple_Response {
+		optional .EExternalAccountType external_type = 1 [default = k_EExternalNone];
+		optional string external_id = 2 [(description) = "unique external account identifier"];
+		optional string external_user_name = 3 [(description) = "user readable; best effort"];
+		optional string external_url = 4 [(description) = "required for all, can be a sentinal to verify correctness"];
+		optional string access_token = 5 [(description) = "provided if requeest and it was valid."];
+		optional string access_token_secret = 6 [(description) = "required for OAuth v1 and signing the message, provided with access token."];
+		optional bool is_valid = 7 [(description) = "If false, it means access token no longer work (expired, disconnected) and the link is now broken. Inform user to refresh."];
+	}
+
+	repeated .CAccountLinking_GetLinkedAccountInfo_Response.CExternalAccountTuple_Response external_accounts = 1;
+}
+
+message CEmbeddedClient_AuthorizeCurrentDevice_Request {
+	optional fixed64 steamid = 1;
+	optional uint32 appid = 2;
+	optional string device_info = 3;
+	optional uint32 deviceid = 4;
+}
+
+message CEmbeddedClient_Token {
+	optional fixed64 steamid = 1;
+	optional bytes client_token = 2;
+	optional uint32 expiry = 3;
+	optional uint32 deviceid = 4;
+}
+
+message CEmbeddedClient_AuthorizeDevice_Response {
+	optional uint32 result = 1;
+	optional .CEmbeddedClient_Token token = 2;
+}
+
+service UserAccount {
+	option (service_description) = "A service to get user account information";
+
+	rpc GetAvailableValveDiscountPromotions (.CUserAccount_GetAvailableValveDiscountPromotions_Request) returns (.CUserAccount_GetAvailableValveDiscountPromotions_Response) {
+		option (method_description) = "Gets the available promotional discounts available to the user";
+	}
+
+	rpc GetAccountLinkStatus (.CUserAccount_GetAccountLinkStatus_Request) returns (.CUserAccount_GetAccountLinkStatus_Response) {
+		option (method_description) = "Fetches account link status";
+	}
+
+	rpc CancelLicenseForApp (.CUserAccount_CancelLicenseForApp_Request) returns (.CUserAccount_CancelLicenseForApp_Response) {
+		option (method_description) = "Cancels a free license for a user";
+	}
+
+	rpc CreateFriendInviteToken (.CUserAccount_CreateFriendInviteToken_Request) returns (.CUserAccount_CreateFriendInviteToken_Response) {
+		option (method_description) = "Create a limited-use token that can be used to create a friend request";
+	}
+
+	rpc GetFriendInviteTokens (.CUserAccount_GetFriendInviteTokens_Request) returns (.CUserAccount_GetFriendInviteTokens_Response) {
+		option (method_description) = "Get the set of active tokens for the user";
+	}
+
+	rpc ViewFriendInviteToken (.CUserAccount_ViewFriendInviteToken_Request) returns (.CUserAccount_ViewFriendInviteToken_Response) {
+		option (method_description) = "View details about an invite token ";
+	}
+
+	rpc RedeemFriendInviteToken (.CUserAccount_RedeemFriendInviteToken_Request) returns (.CUserAccount_RedeemFriendInviteToken_Response) {
+		option (method_description) = "Create a friend relationship using the given invite token";
+	}
+
+	rpc RevokeFriendInviteToken (.CUserAccount_RevokeFriendInviteToken_Request) returns (.CUserAccount_RevokeFriendInviteToken_Response) {
+		option (method_description) = "Revoke an active friend invite token";
+	}
+
+	rpc RegisterCompatTool (.CUserAccount_RegisterCompatTool_Request) returns (.CUserAccount_RegisterCompatTool_Response) {
+		option (method_description) = "Register intended account usage of a tool";
+	}
+}
+
+service AccountLinking {
+	option (service_description) = "A service to manage and link to external accounts";
+
+	rpc GetLinkedAccountInfo (.CAccountLinking_GetLinkedAccountInfo_Request) returns (.CAccountLinking_GetLinkedAccountInfo_Response) {
+		option (method_description) = "List all my active linked external accounts; may be requested to return the access token";
+	}
+}
+
+service EmbeddedClient {
+	option (service_description) = "Service to authorize and manage Steam functions directly embedded in games";
+
+	rpc AuthorizeCurrentDevice (.CEmbeddedClient_AuthorizeCurrentDevice_Request) returns (.CEmbeddedClient_AuthorizeDevice_Response) {
+		option (method_description) = "Use a logged-in (password/etc) session to create a durable access token";
+	}
+}

package/protos/steammessages_vac.steamclient.proto

@@ -0,0 +1,44 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+message CFileVerification_SignatureCheck_Request {
+	optional fixed64 steamid = 1;
+	optional uint32 appid = 2;
+	optional uint64 file_size = 3;
+	optional uint32 file_timestamp = 4;
+	optional uint32 file_timestamp2 = 5;
+	optional uint32 signature_result = 6;
+	optional string filename = 7;
+	optional uint32 client_package_version = 8;
+	optional bytes sha1hash = 9;
+}
+
+message CFileVerification_SignatureCheck_Response {
+	optional bool deny_operation = 1;
+}
+
+message CFileVerification_SteamServiceCheck_Request {
+	optional uint32 service_status = 2;
+	optional uint32 client_package_version = 3;
+	optional uint32 launcher_type = 4;
+	optional uint32 os_type = 5;
+	optional uint32 service_repair = 6;
+}
+
+message CFileVerification_SteamServiceCheck_Response {
+	optional bool attempt_repair = 1;
+}
+
+service FileVerification {
+	option (service_description) = "File verification services";
+
+	rpc SignatureCheck (.CFileVerification_SignatureCheck_Request) returns (.CFileVerification_SignatureCheck_Response) {
+		option (method_description) = "File signature check was performed";
+	}
+
+	rpc SteamServiceCheck (.CFileVerification_SteamServiceCheck_Request) returns (.CFileVerification_SteamServiceCheck_Response) {
+		option (method_description) = "Steam Service check was performed";
+	}
+}

package/protos/steammessages_video.steamclient.proto

@@ -0,0 +1,84 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+message CVideo_ClientGetVideoURL_Request {
+	optional uint64 video_id = 1 [(description) = "Video ID"];
+	optional uint32 client_cellid = 2 [(description) = "Cell ID of client, zero if unknown"];
+}
+
+message CVideo_ClientGetVideoURL_Response {
+	optional uint64 video_id = 1 [(description) = "Video ID"];
+	optional string video_url = 2 [(description) = "URL for video manifest"];
+}
+
+message VideoBookmark {
+	optional uint32 app_id = 1 [(description) = "App ID"];
+	optional uint32 playback_position_in_seconds = 2 [(description) = "How many seconds into the video the bookmark is for"];
+	optional uint64 video_track_id = 3 [(description) = "video track choice."];
+	optional uint64 audio_track_id = 4 [(description) = "audio track choice."];
+	optional uint64 timedtext_track_id = 5 [(description) = "timedtimed or subtitle track choice"];
+	optional uint32 last_modified = 6 [(description) = "when we recorded it was last modified. Not settable."];
+	optional bool hide_from_watch_history = 7 [default = false, (description) = "Whether I want to show this in my history"];
+	optional bool hide_from_library = 8 [default = false, (description) = "Whether I want to show this in my library"];
+}
+
+message CVideo_SetVideoBookmark_Notification {
+	repeated .VideoBookmark bookmarks = 1 [(description) = "list of bookmarks we want to store."];
+}
+
+message CVideo_GetVideoBookmarks_Request {
+	repeated uint32 appids = 1 [(description) = "List of App IDs to grab bookmarks for. Can be empty if using updated_since."];
+	optional uint32 updated_since = 2 [(description) = "Only return results after time. Min value is 1. (seconds since epoch January 1st, 1970 Unix Time)"];
+}
+
+message CVideo_GetVideoBookmarks_Response {
+	repeated .VideoBookmark bookmarks = 1 [(description) = "List of bookmarks we found. Can be empty."];
+}
+
+message CVideo_UnlockedH264_Notification {
+	optional bytes encryption_key = 1;
+}
+
+message CFovasVideo_ClientGetOPFSettings_Request {
+	optional uint32 app_id = 1 [(description) = "App ID"];
+	optional uint32 client_cellid = 2 [(description) = "Cell ID of client, zero if unknown"];
+}
+
+message CFovasVideo_ClientGetOPFSettings_Response {
+	optional uint32 app_id = 1 [(description) = "App ID"];
+	optional string opf_settings = 2 [(description) = "JSON blob of OPF Settings"];
+}
+
+service Video {
+	option (service_description) = "Video methods";
+
+	rpc ClientGetVideoURL (.CVideo_ClientGetVideoURL_Request) returns (.CVideo_ClientGetVideoURL_Response) {
+		option (method_description) = "Get the initial URL to begin streaming a video";
+	}
+
+	rpc SetVideoBookmark (.CVideo_SetVideoBookmark_Notification) returns (.NoResponse) {
+		option (method_description) = "Bookmarks the locations in the video the user has reached. As as record playback settings per video. Fire and forget.";
+	}
+
+	rpc GetVideoBookmarks (.CVideo_GetVideoBookmarks_Request) returns (.CVideo_GetVideoBookmarks_Response) {
+		option (method_description) = "Returns the video bookmarks locations for the specific videos. Includes playback settings per video";
+	}
+}
+
+service VideoClient {
+	option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
+
+	rpc NotifyUnlockedH264 (.CVideo_UnlockedH264_Notification) returns (.NoResponse) {
+		option (method_description) = "Notification from server to client that h264 has been unlocked";
+	}
+}
+
+service FovasVideo {
+	option (service_description) = "Fovas Video Service Methods";
+
+	rpc ClientGetOPFSettings (.CFovasVideo_ClientGetOPFSettings_Request) returns (.CFovasVideo_ClientGetOPFSettings_Response) {
+		option (method_description) = "Retrieve the OPF settings JSON blob. Available via the Client for 360 Player App";
+	}
+}

package/protos/steammessages_virtualcontroller.proto

@@ -0,0 +1,138 @@
+enum EInputMode {
+	k_EInputModeUnknown = 0;
+	k_EInputModeMouse = 1;
+	k_EInputModeController = 2;
+	k_EInputModeMouseAndController = 3;
+}
+
+enum EMouseMode {
+	k_EMouseModeUnknown = 0;
+	k_EMouseModeRelativeCursor = 1;
+	k_EMouseModeAbsoluteCursor = 2;
+	k_EMouseModeTouch = 3;
+	k_EMouseModeRelative = 4;
+}
+
+enum EControllerElementType {
+	k_EControllerElementTypeNone = -1;
+	k_EControllerElementTypeThumb = 0;
+	k_EControllerElementTypeButtonSteam = 1;
+	k_EControllerElementTypeJoystickLeft = 2;
+	k_EControllerElementTypeButtonJoystickLeft = 3;
+	k_EControllerElementTypeJoystickRight = 4;
+	k_EControllerElementTypeButtonJoystickRight = 5;
+	k_EControllerElementTypeDPad = 6;
+	k_EControllerElementTypeButtonA = 7;
+	k_EControllerElementTypeButtonB = 8;
+	k_EControllerElementTypeButtonX = 9;
+	k_EControllerElementTypeButtonY = 10;
+	k_EControllerElementTypeButtonSelect = 11;
+	k_EControllerElementTypeButtonStart = 12;
+	k_EControllerElementTypeButtonTriggerLeft = 13;
+	k_EControllerElementTypeButtonTriggerRight = 14;
+	k_EControllerElementTypeButtonBumperLeft = 15;
+	k_EControllerElementTypeButtonBumperRight = 16;
+	k_EControllerElementTypeButtonMacro0 = 17;
+	k_EControllerElementTypeButtonMacro1 = 18;
+	k_EControllerElementTypeButtonMacro2 = 19;
+	k_EControllerElementTypeButtonMacro3 = 20;
+	k_EControllerElementTypeButtonMacro4 = 21;
+	k_EControllerElementTypeButtonMacro5 = 22;
+	k_EControllerElementTypeButtonMacro6 = 23;
+	k_EControllerElementTypeButtonMacro7 = 24;
+	k_EControllerElementTypeTrackpadCenter = 25;
+	k_EControllerElementTypeTrackpadLeft = 26;
+	k_EControllerElementTypeTrackpadRight = 27;
+	k_EControllerElementTypeKeyboard = 28;
+	k_EControllerElementTypeMagnifyingGlass = 29;
+	k_EControllerElementTypeButtonMacro1Finger = 30;
+	k_EControllerElementTypeButtonMacro2Finger = 31;
+	k_EControllerElementTypeRecordInput = 32;
+	k_EControllerElementTypePlaybackInput = 33;
+	k_EControllerElementTypePaste = 34;
+	k_EControllerElementTypeMax = 35;
+}
+
+message CVirtualControllerElement {
+	optional .EControllerElementType type = 1 [default = k_EControllerElementTypeNone];
+	optional bool visible = 2;
+	optional float x_position = 3;
+	optional float y_position = 4;
+	optional float x_scale = 5 [default = 1];
+	optional float y_scale = 6 [default = 1];
+}
+
+message CVirtualControllerColor {
+	optional float r = 1 [default = 1];
+	optional float g = 2 [default = 1];
+	optional float b = 3 [default = 1];
+	optional float a = 4 [default = 1];
+}
+
+message CVirtualControllerLayout {
+	optional int32 layout_version = 1;
+	optional int32 actionset_id = 2;
+	repeated .CVirtualControllerElement elements = 4;
+	optional .CVirtualControllerColor color = 5;
+}
+
+message CVirtualControllerLayouts {
+	repeated .CVirtualControllerLayout layouts = 1;
+	optional .EInputMode input_mode = 2 [default = k_EInputModeController];
+	optional .EMouseMode mouse_mode = 3 [default = k_EMouseModeUnknown];
+	optional float trackpad_sensitivity = 4 [default = 1];
+	optional bool pinch_zoom_enabled = 5 [default = false];
+	optional float pinch_zoom_x = 6 [default = 0];
+	optional float pinch_zoom_y = 7 [default = 0];
+	optional float pinch_zoom_scale = 8 [default = 1];
+	optional bool shaken = 9;
+	optional bool mouse_offscreen = 10;
+}
+
+message CVirtualControllerConfig {
+	message Control {
+		optional string name = 1;
+		optional string icon = 2;
+		optional int32 input_source = 3;
+		optional int32 input_mode = 4;
+		optional int32 input_element = 5;
+		optional int32 output_gamepad = 6;
+		optional int32 output_keyboard = 7;
+		optional int32 output_mouse = 8;
+		optional string icon_foreground = 9;
+		optional string icon_background = 10;
+		optional bool input_toggle = 11;
+		optional int32 input_activate_stick_or_trackpad = 12;
+		optional int32 activation_type = 13;
+		optional int32 long_press_ms = 14;
+		optional int32 double_press_ms = 15;
+	}
+
+	message ActionSet {
+		optional int32 id = 1;
+		optional int32 parent_id = 2;
+		optional string name = 3;
+		repeated .CVirtualControllerConfig.Control controls = 4;
+	}
+
+	optional string name = 1;
+	repeated .CVirtualControllerConfig.ActionSet actionsets = 2;
+	optional .EMouseMode default_mouse_mode = 3 [default = k_EMouseModeRelative];
+}
+
+message CVirtualControllerLayoutPackage {
+	optional uint32 appid = 1;
+	optional uint64 creator = 2;
+	optional uint32 initial_revision = 3;
+	optional uint32 saved_revision = 4;
+	optional .CVirtualControllerConfig config = 5;
+	optional .CVirtualControllerLayouts layouts = 6;
+}
+
+message CVirtualControllerGlobalConfig {
+	optional bool feedback_enabled = 1;
+	optional bool gyroscope_enabled = 2 [default = true];
+	optional bool auto_fade_enabled = 3 [default = true];
+	optional bool rumble_enabled = 4 [default = true];
+	optional bool shake_fade_enabled = 5;
+}

package/protos/steammessages_workshop.steamclient.proto

@@ -0,0 +1,23 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+message CWorkshop_GetEULAStatus_Request {
+	optional uint32 appid = 1;
+}
+
+message CWorkshop_GetEULAStatus_Response {
+	optional uint32 version = 1;
+	optional uint32 timestamp_action = 2;
+	optional bool accepted = 3;
+	optional bool needs_action = 4;
+}
+
+service Workshop {
+	option (service_description) = "A service to access published file data";
+
+	rpc GetEULAStatus (.CWorkshop_GetEULAStatus_Request) returns (.CWorkshop_GetEULAStatus_Response) {
+		option (method_description) = "Retrieve the status of the user's EULA acceptance.";
+	}
+}