@3dsource/angular-unreal-module 0.0.28 → 0.0.30

package/LICENSE

@@ -1,14 +1,14 @@
-Copyright (c) 2025 3dsource
-All Rights Reserved.
-
-This software and associated documentation files (the “Software”) are proprietary
-and confidential. Unauthorized copying, modification, distribution, or any other
-use of the Software, in whole or in part, without the prior written consent of
-the copyright holder is strictly prohibited.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2025 3dsource
+All Rights Reserved.
+
+This software and associated documentation files (the “Software”) are proprietary
+and confidential. Unauthorized copying, modification, distribution, or any other
+use of the Software, in whole or in part, without the prior written consent of
+the copyright holder is strictly prohibited.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,36 +1,117 @@
-# @3dsource/angular-unreal-module
-
-### An unreal scene standalone component for a metabox studio and configurators for communicate with unreal applications
-
-## Installation
-
-### peer dependencies
-
-_List of peer dependencies_
-
-```json
-{
-  "@3dsource/source-ui-native": "^1.0.7",
-  "@3dsource/types-unreal": "^0.0.1",
-  "@3dsource/utils": "^1.0.13",
-  "@angular/cdk": "^19.2.0",
-  "@angular/common": "^19.2.0",
-  "@angular/core": "^19.2.0",
-  "@angular/forms": "^19.2.0",
-  "@ngrx/effects": "^19.1.0",
-  "@ngrx/operators": "^19.1.0",
-  "@ngrx/store": "^19.1.0"
-}
-```
-
-```shell
-  npx install-peerdeps @3dsource/angular-unreal-module
-```
-
-### library
-
-```shell
-  npm i @3dsource/angular-unreal-module
-```
-
-## Usage
+# @3dsource/angular-unreal-module
+
+A standalone Angular component for integrating Unreal Engine scenes into web applications. This module facilitates communication between Angular applications and Unreal Engine, enabling interactive 3D experiences.
+
+## Overview
+
+The Angular Unreal Module provides:
+
+- Seamless integration of Unreal Engine content in Angular applications
+- Communication bridge between Angular and Unreal Engine
+- State management for 3D scene interactions
+- Configurators for customizing Unreal Engine applications
+
+## Installation
+
+### Prerequisites
+
+- Angular 19+
+- NgRx store and effects
+
+### Peer Dependencies
+
+This library requires the following peer dependencies:
+
+```json
+{
+  "@3dsource/source-ui-native": "^1.0.7",
+  "@3dsource/types-unreal": "^0.0.1",
+  "@3dsource/utils": "^1.0.13",
+  "@angular/cdk": "^19.2.0",
+  "@angular/common": "^19.2.0",
+  "@angular/core": "^19.2.0",
+  "@angular/forms": "^19.2.0",
+  "@ngrx/effects": "^19.1.0",
+  "@ngrx/operators": "^19.1.0",
+  "@ngrx/store": "^19.1.0"
+}
+```
+
+Install peer dependencies:
+
+```shell
+  npx install-peerdeps @3dsource/angular-unreal-module
+```
+
+### Library Installation
+
+```shell
+  npm i @3dsource/angular-unreal-module
+```
+
+## Usage
+
+### Basic Integration
+
+1. Import the UnrealModule in your Angular application:
+
+```typescript
+import { UnrealModule } from '@3dsource/angular-unreal-module';
+
+@NgModule({
+  imports: [
+    UnrealModule.forRoot({
+      // Configuration options
+    })
+  ]
+})
+export class AppModule {
+}
+```
+
+2. Use the Unreal scene component in your templates:
+
+```html
+
+<unreal-scene
+  [config]="unrealConfig"
+  (sceneReady)="onSceneReady($event)">
+</unreal-scene>
+```
+
+### Communication with Unreal Engine
+
+The module provides services for sending commands to and receiving events from Unreal Engine:
+
+```typescript
+import { UnrealService } from '@3dsource/angular-unreal-module';
+
+@Component({ ... })
+export class MyComponent {
+  constructor(private unrealService: UnrealService) {
+  }
+
+  sendCommand() {
+    this.unrealService.sendCommand({
+      command: 'SomeCommand',
+      parameters: { /* command parameters */ }
+    });
+  }
+}
+```
+
+## Features
+
+- **Unreal Scene Component**: Embed Unreal Engine content in Angular applications
+- **Command API**: Send commands to Unreal Engine
+- **Event Handling**: React to events from Unreal Engine
+- **State Management**: NgRx integration for managing 3D scene state
+- **Configuration Options**: Customize the Unreal Engine integration
+
+## Examples
+
+Check the demo application for complete usage examples:
+
+```shell
+npm run demo:start
+```