@volorio/games-dice 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 +36 -13
  3. package/package.json +19 -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,22 +1,45 @@
1
1
  # @volorio/games-dice
2
2
 
3
- Typed browser client for the Volorio Dice game.
3
+ Volorio Dice game client built on the Volorio Games Web runtime.
4
4
 
5
- Install only the Dice package in the browser app. It depends on `@volorio/games-web` and `@volorio/games-core`; it does not accept a Volorio server API key.
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install @volorio/games-dice@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
+ - `VolorioDiceClientOptions`
24
+ - `VolorioDiceRoll`
25
+ - `VolorioDiceSnapshotState`
26
+ - `VolorioDiceRollHandler`
27
+ - `VolorioDiceSnapshotHandler`
28
+ - `VolorioDiceErrorHandler`
29
+ - `VolorioDiceClient`
6
30
 
7
31
  ```ts
8
32
  import { VolorioDiceClient } from "@volorio/games-dice";
33
+ ```
9
34
 
10
- const dice = new VolorioDiceClient({
11
- gatewayUrl: "wss://games.volor.io/v1/games/gateway",
12
- token: shortLivedGameTokenFromYourBackend,
13
- gameInstanceId: "ginst_123",
14
- playerId: "user_123",
15
- });
16
35
 
17
- await dice.connect();
18
- dice.onRoll((roll) => console.log(roll.playerId, roll.value));
19
- dice.roll();
20
- ```
36
+ ## Dependencies
37
+
38
+ - `@volorio/games-core` `^0.2.0`
39
+ - `@volorio/games-web` `^0.2.0`
40
+
41
+ ## Documentation
21
42
 
22
- Your backend creates the game session and game token through `@volorio/games-node` using the server API key.
43
+ - [Volorio npm integration guide](https://volor.io/docs/packages/npm-overview)
44
+ - [REST and SDK documentation](https://volor.io/docs)
45
+ - [Volorio Console](https://app.volor.io)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@volorio/games-dice",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "private": false,
5
5
  "description": "Volorio Dice game client built on the Volorio Games Web runtime.",
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",
@@ -27,5 +28,20 @@
27
28
  "dependencies": {
28
29
  "@volorio/games-core": "^0.2.0",
29
30
  "@volorio/games-web": "^0.2.0"
30
- }
31
+ },
32
+ "homepage": "https://volor.io/docs/packages/npm-overview",
33
+ "license": "SEE LICENSE IN LICENSE",
34
+ "keywords": [
35
+ "volorio",
36
+ "realtime",
37
+ "rtc",
38
+ "sdk",
39
+ "games-dice",
40
+ "dice",
41
+ "game",
42
+ "client",
43
+ "built",
44
+ "games",
45
+ "runtime"
46
+ ]
31
47
  }