@antha/multiplayer-p2p-lock-step 0.1.0 → 0.1.1

package/README.md

@@ -1,3 +1,49 @@
 # @antha/multiplayer-p2p-lock-step
 
-A multiplayer mod for the Antha engine that uses peer-to-peer lock-step for game state synchronization.
+This package provides a pre-built [Antha game engine](https://www.npmjs.com/package/@antha/engine) mod for peer-to-peer lock-step multiplayer state synchronization. Players submit actions, and the host distributes them as ordered frames so every client advances game state in the same order.
+
+## Install
+
+```sh
+npm i @antha/multiplayer-p2p-lock-step
+```
+
+## Usage
+
+<!-- example-link: src/readme-examples/creating-lock-step-game.example.ts -->
+
+```TypeScript
+import {AnthaEngine, defineAnthaMod} from '@antha/engine';
+import {
+    type AnthaMultiplayerP2pLockStepState,
+    createAnthaMultiplayerP2pLockStepMod,
+} from '@antha/multiplayer-p2p-lock-step';
+
+type GameState = AnthaMultiplayerP2pLockStepState<string>;
+
+const engine = new AnthaEngine<GameState>({
+    mods: [
+        createAnthaMultiplayerP2pLockStepMod<string>({
+            gameId: 'my-game',
+        }),
+        defineAnthaMod<GameState>({
+            modName: 'game-logic',
+            execute({state}) {
+                const controller = state.multiplayerP2pLockStep?.multiplayerController;
+
+                if (!controller) {
+                    return;
+                }
+                if (!controller.isConnected()) {
+                    controller.startSingleplayer();
+                    controller.act('move-left');
+                }
+
+                return `Network FPS: ${controller.getFps()}`;
+            },
+        }),
+    ],
+});
+
+engine.startLoop();
+```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/multiplayer-p2p-lock-step",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "Multiplayer mod for the Antha engine.",
     "keywords": [
         "vir",
@@ -49,7 +49,7 @@
         "istanbul-smart-text-reporter": "^1.1.5"
     },
     "peerDependencies": {
-        "@antha/multiplayer-core": "^0.1.0"
+        "@antha/multiplayer-core": "^0.1.1"
     },
     "engines": {
         "node": ">=22"