Skip to content

Commit

Permalink
Update protobuf links
Browse files Browse the repository at this point in the history
  • Loading branch information
seishun committed Nov 29, 2018
1 parent 667abdf commit d246c5e
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Connection closed by the server. Only emitted if the encryption handshake is com
Encryption handshake complete. From now on, it's your responsibility to handle disconnections and reconnect (see ['error'](#error)). You'll likely want to log on now (see [SteamUser#logOn](lib/handlers/user#logonlogondetails)).

### 'logOnResponse'
* [`CMsgClientLogonResponse`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto)
* [`CMsgClientLogonResponse`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_login.proto)

Logon response received. If `eresult` is `EResult.OK`, [`loggedOn`](#loggedon) is now `true`.

Expand All @@ -151,6 +151,6 @@ Sending and receiving client messages is designed to be symmetrical, so the even

* `header` - an object representing the message header. It has the following properties:
* `msg` - `EMsg` (no protomask).
* `proto` - a [`CMsgProtoBufHeader`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_base.proto) object if this message is protobuf-backed, otherwise `header.proto` is falsy. The following fields are reserved for internal use and shall be ignored: `steamid`, `client_sessionid`, `jobid_source`, `jobid_target`. (Note: pass an empty object if you don't need to set any fields)
* `proto` - a [`CMsgProtoBufHeader`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_base.proto) object if this message is protobuf-backed, otherwise `header.proto` is falsy. The following fields are reserved for internal use and shall be ignored: `steamid`, `client_sessionid`, `jobid_source`, `jobid_target`. (Note: pass an empty object if you don't need to set any fields)
* `body` - a Buffer containing the rest of the message. (Note: in SteamKit2's terms, this is "Body" plus "Payload")
* `callback` (optional) - if not falsy, then this message is a request, and `callback` shall be called with any response to it instead of 'message'/send. `callback` has the same arguments as 'message'/send.
8 changes: 4 additions & 4 deletions lib/handlers/friends/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Chat-related methods automatically convert ClanIDs (group's SteamID) to ChatIDs.

### personaStates

Information about users you have encountered. It's an object whose keys are SteamIDs and values are [`CMsgClientPersonaState.Friend`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto) objects.
Information about users you have encountered. It's an object whose keys are SteamIDs and values are [`CMsgClientPersonaState.Friend`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_friends.proto) objects.

### clanStates

Information about groups you have encountered. It's an object whose keys are SteamIDs and values are [`CMsgClientClanState`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto) objects.
Information about groups you have encountered. It's an object whose keys are SteamIDs and values are [`CMsgClientClanState`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver.proto) objects.

### chatRooms

Expand Down Expand Up @@ -119,12 +119,12 @@ Blocks a friend if `setIgnore` is `true`, unblocks them if it's `false`. The fir
* SteamID of the user who invited you

### 'personaState'
* [`CMsgClientPersonaState.Friend`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto)
* [`CMsgClientPersonaState.Friend`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_friends.proto)

Someone has gone offline/online, started a game, changed their nickname or something else. Note that the [`personaStates`](#personastates) property is not yet updated when this event is fired, so you can compare the new state with the old one to see what changed.

### 'clanState'
* [`CMsgClientClanState`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto)
* [`CMsgClientClanState`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver.proto)

Some group has posted an event or an announcement, changed their avatar or something else. Note that the [`clanStates`](#clanstates) property is not yet updated when this event is fired, so you can compare the new state with the old one to see what changed.

Expand Down
2 changes: 1 addition & 1 deletion lib/handlers/game_coordinator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Sending and receiving Game Coordinator messages is designed to be symmetrical, s

* `header` - an object representing the message header. It has the following properties:
* `msg` - the game-specific "type" of the message (no protomask).
* `proto` - a [`CMsgProtoBufHeader`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/dota/steammessages.proto) object if this message is protobuf-backed, otherwise `header.proto` is falsy. The fields `job_id_source` and `job_id_target` are reserved for internal use and shall be ignored. (Note: pass an empty object if you don't need to set any fields)
* `proto` - a [`CMsgProtoBufHeader`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protogen/gc.proto) object if this message is protobuf-backed, otherwise `header.proto` is falsy. The fields `job_id_source` and `job_id_target` are reserved for internal use and shall be ignored. (Note: pass an empty object if you don't need to set any fields)
* `body` - a Buffer containing the rest of the message. (Note: in SteamKit2's terms, this is "Body" plus "Payload")
* `callback` (optional) - if not falsy, then this message is a request, and `callback` shall be called with any response to it instead of 'message'/send. `callback` has the same arguments as 'message'/send.

Expand Down
6 changes: 3 additions & 3 deletions lib/handlers/rich_presence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ var steamRichPresence = new Steam.SteamRichPresence(steamClient, 570);

### upload(body)

Uploads rich presence for the AppID this SteamRichPresence instance was initialized with. `body` is a [`CMsgClientRichPresenceUpload`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver_2.proto) object.
Uploads rich presence for the AppID this SteamRichPresence instance was initialized with. `body` is a [`CMsgClientRichPresenceUpload`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_2.proto) object.

### request(body)

Requests rich presence for the AppID this SteamRichPresence instance was initialized with. `body` is a [`CMsgClientRichPresenceRequest`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver_2.proto) object.
Requests rich presence for the AppID this SteamRichPresence instance was initialized with. `body` is a [`CMsgClientRichPresenceRequest`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_2.proto) object.

## Events

### 'info'
* [`CMsgClientRichPresenceInfo`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver_2.proto)
* [`CMsgClientRichPresenceInfo`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_2.proto)

Rich presence info was received for the AppID this SteamRichPresence instance was initialized with.
10 changes: 5 additions & 5 deletions lib/handlers/user/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ var steamUser = new Steam.SteamUser(steamClient);

### logOn(logOnDetails)

Sets `SteamClient#steamID` to the default value for user accounts and sends a ClientLogon message. `logOnDetails` is a [`CMsgClientLogon`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto) object. It's used as-is except `protocol_version` is set to the currently implemented protocol version.
Sets `SteamClient#steamID` to the default value for user accounts and sends a ClientLogon message. `logOnDetails` is a [`CMsgClientLogon`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_login.proto) object. It's used as-is except `protocol_version` is set to the currently implemented protocol version.

### requestWebAPIAuthenticateUserNonce(callback)

Requests a nonce for WebAPI's AuthenticateUser method. The first argument to `callback` will be a [`CMsgClientRequestWebAPIAuthenticateUserNonceResponse`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto) object.
Requests a nonce for WebAPI's AuthenticateUser method. The first argument to `callback` will be a [`CMsgClientRequestWebAPIAuthenticateUserNonceResponse`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_login.proto) object.

### gamesPlayed(gamesPlayed)

Tells Steam you are playing game(s). `gamesPlayed` is a [`CMsgClientGamesPlayed`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver.proto) object.
Tells Steam you are playing game(s). `gamesPlayed` is a [`CMsgClientGamesPlayed`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver.proto) object.

## Events

### 'updateMachineAuth'
* [`CMsgClientUpdateMachineAuth`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver_2.proto)
* [`CMsgClientUpdateMachineAuth`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_2.proto)
* `callback`

Call `callback` with a [`CMsgClientUpdateMachineAuthResponse`](https://github.com/SteamRE/SteamKit/blob/master/Resources/Protobufs/steamclient/steammessages_clientserver_2.proto) object to accept this sentry update.
Call `callback` with a [`CMsgClientUpdateMachineAuthResponse`](https://github.com/SteamDatabase/Protobufs/blob/master/steam/steammessages_clientserver_2.proto) object to accept this sentry update.

### 'tradeOffers'
* New count (can be zero)
Expand Down

0 comments on commit d246c5e

Please sign in to comment.