ball2d 0.2.0 → 0.2.2
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 +14 -4
- package/dist/browser.js +649 -627
- package/dist/node.js +33 -33
- package/dist/types/player.d.ts +2 -0
- package/dist/types/room.d.ts +3 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,9 +4,10 @@ Host a Ball2D football room on your own server and control it through a typed
|
|
|
4
4
|
JavaScript API. The host runs the simulation; players connect directly over
|
|
5
5
|
WebRTC. Ball2D provides authorization, room discovery and signaling.
|
|
6
6
|
|
|
7
|
-
**
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
**SDK version: 0.2.2.** Requires the matching Ball2D web engine. Production
|
|
8
|
+
API acceptance verified account-issued keys, Node admission, quota rejection and
|
|
9
|
+
revocation. Local Chrome acceptance verified player input, signed stadium physics
|
|
10
|
+
and replay preservation. These checks do not establish broad device or WAN support.
|
|
10
11
|
|
|
11
12
|
Repository maintainers: [local setup](https://github.com/fillbyte/ball2d/blob/main/docs/DEVELOPMENT.md) · [release procedure](https://github.com/fillbyte/ball2d/blob/main/docs/RELEASING.md) · [changelog](https://github.com/fillbyte/ball2d/blob/main/CHANGELOG.md).
|
|
12
13
|
|
|
@@ -16,7 +17,7 @@ Use Node.js 24 or newer. The verified native runtime is Node.js 24.19.0 on macOS
|
|
|
16
17
|
arm64; other systems need independent acceptance. Native transport is experimental.
|
|
17
18
|
|
|
18
19
|
```sh
|
|
19
|
-
npm install ball2d@0.2.
|
|
20
|
+
npm install ball2d@0.2.2
|
|
20
21
|
```
|
|
21
22
|
|
|
22
23
|
Create an API key through your Ball2D account.
|
|
@@ -199,3 +200,12 @@ installed-package hosting, gameplay, replay and cleanup. This evidence does not
|
|
|
199
200
|
establish broad WAN/NAT reachability,
|
|
200
201
|
Linux compatibility, sustained capacity or an uptime guarantee. Direct WebRTC
|
|
201
202
|
requires peer reachability; no TURN relay is provided.
|
|
203
|
+
|
|
204
|
+
## Player mute
|
|
205
|
+
|
|
206
|
+
`await room.setPlayerMuted(id, true)` suppresses a player's room chat; pass `false`
|
|
207
|
+
to restore it. `player.muted` exposes the current state.
|
|
208
|
+
`onPlayerMuteChange(player, byPlayer)` reports the actor (null for SDK commands).
|
|
209
|
+
Muted messages do not reach `onPlayerChat`. Remote admins may mute other players
|
|
210
|
+
but cannot mute the room owner. Mute ends when a player leaves; use a ban to
|
|
211
|
+
prevent rejoining. Losing the room host closes the room without transferring it.
|