@volorio/games-web 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.
Files changed (3) hide show
  1. package/LICENSE +16 -0
  2. package/README.md +33 -11
  3. package/package.json +20 -3
package/LICENSE ADDED
@@ -0,0 +1,16 @@
1
+ Volorio SDK Commercial License
2
+
3
+ Copyright (c) 2026 Volorio. All rights reserved.
4
+
5
+ Permission to install and use this SDK is granted only to an authorized Volorio
6
+ customer or evaluator, solely to integrate an application with Volorio services,
7
+ and subject to the Volorio Terms at https://volor.io/terms.
8
+
9
+ Except where the Volorio Terms expressly allow it, you may not redistribute,
10
+ sublicense, sell, publish, reverse engineer, or create a competing service from
11
+ this SDK or its source code. No ownership rights are transferred.
12
+
13
+ Third-party dependencies remain subject to their respective licenses.
14
+
15
+ THE SDK IS PROVIDED WITHOUT WARRANTIES EXCEPT TO THE EXTENT EXPRESSLY STATED IN
16
+ THE VOLORIO TERMS.
package/README.md CHANGED
@@ -1,20 +1,42 @@
1
1
  # @volorio/games-web
2
2
 
3
- Browser Volorio Games SDK.
3
+ Browser Volorio Games client for short-lived token WebSocket gameplay connections.
4
4
 
5
- This package connects to the Game Gateway with a short-lived game token created by your backend through `@volorio/games-node`. It never accepts or sends a Volorio server API key.
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install @volorio/games-web@0.2.1
9
+ ```
10
+
11
+ ## Runtime and security
12
+
13
+ - Runtime: Browser application
14
+ - Source version: `0.2.1`
15
+ - Registry status: published as 0.2.1
16
+ - API base URL for server calls: `https://api.volor.io`
17
+ - License: proprietary commercial SDK; see the included `LICENSE` and [Volorio Terms](https://volor.io/terms).
18
+ - Never expose a Volorio API key in browser, React Native, or Flutter code. Create short-lived sessions in your backend.
19
+ - Capability note: Requested products must be granted to the API key and accepted by the session endpoint.
20
+
21
+ ## Public API
22
+
23
+ - `VolorioGamesWebEventName`
24
+ - `VolorioGamesWebHandler`
25
+ - `VolorioGamesWebClientOptions`
26
+ - `VolorioGameWebSocketLike`
27
+ - `VolorioGamesWebClient`
6
28
 
7
29
  ```ts
8
30
  import { VolorioGamesWebClient } from "@volorio/games-web";
31
+ ```
9
32
 
10
- const client = new VolorioGamesWebClient({
11
- gatewayUrl: "wss://games.volor.io",
12
- token: gameTokenFromYourBackend,
13
- gameInstanceId: "game_123",
14
- playerId: "user_123",
15
- });
16
33
 
17
- await client.connect();
18
- await client.sendAction("ROLL_DICE", {});
19
- ```
34
+ ## Dependencies
35
+
36
+ - `@volorio/games-core` `^0.2.0`
37
+
38
+ ## Documentation
20
39
 
40
+ - [Volorio npm integration guide](https://volor.io/docs/packages/npm-overview)
41
+ - [REST and SDK documentation](https://volor.io/docs)
42
+ - [Volorio Console](https://app.volor.io)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@volorio/games-web",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "private": false,
5
5
  "description": "Browser Volorio Games client for short-lived token WebSocket gameplay connections.",
6
6
  "main": "dist/src/index.js",
@@ -13,7 +13,8 @@
13
13
  },
14
14
  "files": [
15
15
  "dist/src",
16
- "README.md"
16
+ "README.md",
17
+ "LICENSE"
17
18
  ],
18
19
  "publishConfig": {
19
20
  "access": "public",
@@ -26,5 +27,21 @@
26
27
  },
27
28
  "dependencies": {
28
29
  "@volorio/games-core": "^0.2.0"
29
- }
30
+ },
31
+ "homepage": "https://volor.io/docs/packages/npm-overview",
32
+ "license": "SEE LICENSE IN LICENSE",
33
+ "keywords": [
34
+ "volorio",
35
+ "realtime",
36
+ "rtc",
37
+ "sdk",
38
+ "games-web",
39
+ "browser",
40
+ "games",
41
+ "client",
42
+ "short-lived",
43
+ "token",
44
+ "websocket",
45
+ "gameplay"
46
+ ]
30
47
  }