tachyon-protocol 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/dist/index.d.ts +1 -4
- package/dist/meta.json +1 -1
- package/dist/system/version/response.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,12 +4,14 @@ Tachyon is the name of the protocol designed to replace the old [Spring Lobby Pr
|
|
|
4
4
|
|
|
5
5
|
[Schema Reference](docs/README.md)
|
|
6
6
|
|
|
7
|
+
## Authorization
|
|
8
|
+
|
|
9
|
+
See [dedicated authorization documentation page](docs/authorization.md).
|
|
10
|
+
|
|
7
11
|
## Connecting
|
|
8
12
|
|
|
9
13
|
To connect to a Tachyon WebSocket server, the client should add a `tachyonVersion` query parameter which specifies which version of Tachyon they're using, e.g. `wss://tachyon-server.com?tachyonVersion=1.2.3`. The server should send a [`system/version/response`](docs/system.md/#version) command containing the version of the Tachyon protocol that is being served and `versionParity` field stating how it differs to the client's version. Ideally, clients should ensure their implementation is using the same version of the protocol, which can be found in this repo's [`package.json`](package.json). However, it is up to the client to decide how to handle version mismatches, and the server should not terminate clients because of a version disparity.
|
|
10
14
|
|
|
11
|
-
TODO: document auth
|
|
12
|
-
|
|
13
15
|
## Terminology
|
|
14
16
|
|
|
15
17
|
| Term | Meaning |
|
package/dist/index.d.ts
CHANGED
|
@@ -749,7 +749,7 @@ export type SystemVersionResponse =
|
|
|
749
749
|
commandId: "system/version/response";
|
|
750
750
|
status: "success";
|
|
751
751
|
data: {
|
|
752
|
-
tachyonVersion: "0.2.
|
|
752
|
+
tachyonVersion: "0.2.1";
|
|
753
753
|
versionParity: "major_mismatch" | "minor_mismatch" | "patch_mismatch" | "match" | "unknown";
|
|
754
754
|
};
|
|
755
755
|
}
|
|
@@ -1016,8 +1016,6 @@ export interface SystemDisconnectRequest {
|
|
|
1016
1016
|
messageId: string;
|
|
1017
1017
|
commandId: "system/disconnect/request";
|
|
1018
1018
|
}
|
|
1019
|
-
export type Email = string;
|
|
1020
|
-
|
|
1021
1019
|
export interface BattleStatus {
|
|
1022
1020
|
lobbyId: number | null;
|
|
1023
1021
|
inGame: boolean;
|
|
@@ -1096,7 +1094,6 @@ export interface PrivateUserClient {
|
|
|
1096
1094
|
partyId: number | null;
|
|
1097
1095
|
muted: boolean;
|
|
1098
1096
|
} | null;
|
|
1099
|
-
email: string;
|
|
1100
1097
|
friends: number[];
|
|
1101
1098
|
friendRequests: number[];
|
|
1102
1099
|
ignores: number[];
|
package/dist/meta.json
CHANGED