@3dsource/angular-unreal-module 0.0.64 → 0.0.66

package/README.md

@@ -15,8 +15,8 @@ This package provides:
 
 ### Prerequisites
 
-- Angular 19+
-- NgRx store and effects
+- Angular 18+
+- NgRx store and effects (v18+)
 
 ### Peer Dependencies
 
@@ -25,14 +25,14 @@ This library requires the following peer dependencies (match or exceed versions)
 ```json
 {
   "@3dsource/source-ui-native": ">=1.0.9",
-  "@3dsource/types-unreal": ">=0.0.5",
+  "@3dsource/types-unreal": ">=0.0.7",
   "@3dsource/utils": ">=1.0.21",
-  "@angular/cdk": ">=19.0.0",
-  "@angular/common": ">=19.0.0",
-  "@angular/core": ">=19.0.0",
-  "@angular/forms": ">=19.0.0",
-  "@ngrx/effects": ">=19.0.0",
-  "@ngrx/store": ">=19.0.0"
+  "@angular/cdk": ">=18.0.0",
+  "@angular/common": ">=18.0.0",
+  "@angular/core": ">=18.0.0",
+  "@angular/forms": ">=18.0.0",
+  "@ngrx/effects": ">=18.0.0",
+  "@ngrx/store": ">=18.0.0"
 }
 ```
 
@@ -65,7 +65,8 @@ export const appConfig: ApplicationConfig = {
     provideEffects(),
 
     // Unreal providers (adds feature state and effects internally)
-    ...provideAngularUnrealModule(),
+    // Tip: pass { playwright: true } to switch to testing/dummy services
+    ...provideAngularUnrealModule({ playwright: false }),
 
     // Optional initial config
     {
@@ -76,6 +77,7 @@ export const appConfig: ApplicationConfig = {
         // regionsPingUrl?: string,
         // screenLockerContainerId?: string,
         // dataChannelConnectionTimeout?: number,
+        // playwright?: boolean, // mirrors the provider flag; can be used by services/effects
       },
     },
   ],
@@ -117,16 +119,16 @@ Outputs:
 
 ### 3) Send commands / interactions to Unreal
 
-Use UnrealCommunicatorPlaywrightService to send commands or UI interactions. Types for command packets are provided by @3dsource/types-unreal.
+Inject `UnrealCommunicatorService` to send commands or UI interactions. Types for command packets are provided by `@3dsource/types-unreal`.
 
 ```ts
 import { Component, inject } from '@angular/core';
-import { UnrealCommunicatorPlaywrightService } from '@3dsource/angular-unreal-module';
+import { UnrealCommunicatorService } from '@3dsource/angular-unreal-module';
 import type { MetaBoxCommandPacket } from '@3dsource/types-unreal';
 
 @Component({ standalone: true, template: '' })
 export class MyComponent {
-  private unreal = inject(UnrealCommunicatorPlaywrightService);
+  private unreal = inject(UnrealCommunicatorService);
 
   sendSomeCommand() {
     const packet: MetaBoxCommandPacket = {
@@ -148,7 +150,7 @@ export class MyComponent {
 ## Features
 
 - Standalone Unreal Scene Component
-- Command and UI Interaction API via UnrealCommunicatorPlaywrightService
+- Command and UI Interaction API via UnrealCommunicatorService
 - Event-driven status UI (freeze frame, video stats, play overlay)
 - NgRx-powered state management and effects
 - Optional initial configuration via UNREAL_CONFIG token
@@ -160,3 +162,8 @@ Check the demo application for complete usage examples:
 ```shell
 npm run demo:start
 ```
+
+## Engine requirements
+
+- Node.js: >=20
+- npm: >9