@antha/multiplayer-core 0.1.0 → 0.1.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 +21 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,23 @@
|
|
|
1
1
|
# @antha/multiplayer-core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This package provides the room, signaling, WebRTC, and identifier utilities behind the [Antha game engine](https://www.npmjs.com/package/@antha/engine)'s peer-to-peer multiplayer features. Use it directly to build a custom multiplayer strategy, or use one of the strategy packages for a ready-made approach.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm i @antha/multiplayer-core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
<!-- example-link: src/readme-examples/creating-multiplayer-client.example.ts -->
|
|
14
|
+
|
|
15
|
+
```TypeScript
|
|
16
|
+
import {createMultiplayerApiClient, createMultiplayerId} from '@antha/multiplayer-core';
|
|
17
|
+
|
|
18
|
+
const roomId = createMultiplayerId.room();
|
|
19
|
+
const multiplayerApiClient = await createMultiplayerApiClient({
|
|
20
|
+
backendOrigin: 'http://localhost:9348',
|
|
21
|
+
portScanOptions: false,
|
|
22
|
+
});
|
|
23
|
+
```
|