@3dsource/angular-unreal-module 0.0.34 → 0.0.35

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/LICENSE CHANGED
@@ -1,14 +1,14 @@
1
- Copyright (c) 2025 3dsource
2
- All Rights Reserved.
3
-
4
- This software and associated documentation files (the “Software”) are proprietary
5
- and confidential. Unauthorized copying, modification, distribution, or any other
6
- use of the Software, in whole or in part, without the prior written consent of
7
- the copyright holder is strictly prohibited.
8
-
9
- THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
11
- FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
12
- COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
13
- IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
14
- CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ Copyright (c) 2025 3dsource
2
+ All Rights Reserved.
3
+
4
+ This software and associated documentation files (the “Software”) are proprietary
5
+ and confidential. Unauthorized copying, modification, distribution, or any other
6
+ use of the Software, in whole or in part, without the prior written consent of
7
+ the copyright holder is strictly prohibited.
8
+
9
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
11
+ FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
12
+ COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
13
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
14
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md CHANGED
@@ -1,112 +1,112 @@
1
- # @3dsource/angular-unreal-module
2
-
3
- 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.
4
-
5
- ## Overview
6
-
7
- The Angular Unreal Module provides:
8
-
9
- - Seamless integration of Unreal Engine content in Angular applications
10
- - Communication bridge between Angular and Unreal Engine
11
- - State management for 3D scene interactions
12
- - Configurators for customizing Unreal Engine applications
13
-
14
- ## Installation
15
-
16
- ### Prerequisites
17
-
18
- - Angular 19+
19
- - NgRx store and effects
20
-
21
- ### Peer Dependencies
22
-
23
- This library requires the following peer dependencies:
24
-
25
- ```json
26
- {
27
- "@3dsource/source-ui-native": "^1.0.7",
28
- "@3dsource/types-unreal": "^0.0.1",
29
- "@3dsource/utils": "^1.0.13",
30
- "@angular/cdk": "^19.2.0",
31
- "@angular/common": "^19.2.0",
32
- "@angular/core": "^19.2.0",
33
- "@angular/forms": "^19.2.0",
34
- "@ngrx/effects": "^19.1.0",
35
- "@ngrx/operators": "^19.1.0",
36
- "@ngrx/store": "^19.1.0"
37
- }
38
- ```
39
-
40
- Install peer dependencies:
41
-
42
- ```shell
43
- npx install-peerdeps @3dsource/angular-unreal-module
44
- ```
45
-
46
- ### Library Installation
47
-
48
- ```shell
49
- npm i @3dsource/angular-unreal-module
50
- ```
51
-
52
- ## Usage
53
-
54
- ### Basic Integration
55
-
56
- 1. Import the UnrealModule in your Angular application:
57
-
58
- ```typescript
59
- import { UnrealModule } from '@3dsource/angular-unreal-module';
60
-
61
- @NgModule({
62
- imports: [
63
- UnrealModule.forRoot({
64
- // Configuration options
65
- }),
66
- ],
67
- })
68
- export class AppModule {}
69
- ```
70
-
71
- 2. Use the Unreal scene component in your templates:
72
-
73
- ```html
74
- <unreal-scene [config]="unrealConfig" (sceneReady)="onSceneReady($event)"> </unreal-scene>
75
- ```
76
-
77
- ### Communication with Unreal Engine
78
-
79
- The module provides services for sending commands to and receiving events from Unreal Engine:
80
-
81
- ```typescript
82
- import { UnrealService } from '@3dsource/angular-unreal-module';
83
-
84
- @Component({ ... })
85
- export class MyComponent {
86
- constructor(private unrealService: UnrealService) {
87
- }
88
-
89
- sendCommand() {
90
- this.unrealService.sendCommand({
91
- command: 'SomeCommand',
92
- parameters: { /* command parameters */ }
93
- });
94
- }
95
- }
96
- ```
97
-
98
- ## Features
99
-
100
- - **Unreal Scene Component**: Embed Unreal Engine content in Angular applications
101
- - **Command API**: Send commands to Unreal Engine
102
- - **Event Handling**: React to events from Unreal Engine
103
- - **State Management**: NgRx integration for managing 3D scene state
104
- - **Configuration Options**: Customize the Unreal Engine integration
105
-
106
- ## Examples
107
-
108
- Check the demo application for complete usage examples:
109
-
110
- ```shell
111
- npm run demo:start
112
- ```
1
+ # @3dsource/angular-unreal-module
2
+
3
+ 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.
4
+
5
+ ## Overview
6
+
7
+ The Angular Unreal Module provides:
8
+
9
+ - Seamless integration of Unreal Engine content in Angular applications
10
+ - Communication bridge between Angular and Unreal Engine
11
+ - State management for 3D scene interactions
12
+ - Configurators for customizing Unreal Engine applications
13
+
14
+ ## Installation
15
+
16
+ ### Prerequisites
17
+
18
+ - Angular 19+
19
+ - NgRx store and effects
20
+
21
+ ### Peer Dependencies
22
+
23
+ This library requires the following peer dependencies:
24
+
25
+ ```json
26
+ {
27
+ "@3dsource/source-ui-native": "^1.0.7",
28
+ "@3dsource/types-unreal": "^0.0.1",
29
+ "@3dsource/utils": "^1.0.13",
30
+ "@angular/cdk": "^19.2.0",
31
+ "@angular/common": "^19.2.0",
32
+ "@angular/core": "^19.2.0",
33
+ "@angular/forms": "^19.2.0",
34
+ "@ngrx/effects": "^19.1.0",
35
+ "@ngrx/operators": "^19.1.0",
36
+ "@ngrx/store": "^19.1.0"
37
+ }
38
+ ```
39
+
40
+ Install peer dependencies:
41
+
42
+ ```shell
43
+ npx install-peerdeps @3dsource/angular-unreal-module
44
+ ```
45
+
46
+ ### Library Installation
47
+
48
+ ```shell
49
+ npm i @3dsource/angular-unreal-module
50
+ ```
51
+
52
+ ## Usage
53
+
54
+ ### Basic Integration
55
+
56
+ 1. Import the UnrealModule in your Angular application:
57
+
58
+ ```typescript
59
+ import { UnrealModule } from '@3dsource/angular-unreal-module';
60
+
61
+ @NgModule({
62
+ imports: [
63
+ UnrealModule.forRoot({
64
+ // Configuration options
65
+ }),
66
+ ],
67
+ })
68
+ export class AppModule {}
69
+ ```
70
+
71
+ 2. Use the Unreal scene component in your templates:
72
+
73
+ ```html
74
+ <unreal-scene [config]="unrealConfig" (sceneReady)="onSceneReady($event)"> </unreal-scene>
75
+ ```
76
+
77
+ ### Communication with Unreal Engine
78
+
79
+ The module provides services for sending commands to and receiving events from Unreal Engine:
80
+
81
+ ```typescript
82
+ import { UnrealService } from '@3dsource/angular-unreal-module';
83
+
84
+ @Component({ ... })
85
+ export class MyComponent {
86
+ constructor(private unrealService: UnrealService) {
87
+ }
88
+
89
+ sendCommand() {
90
+ this.unrealService.sendCommand({
91
+ command: 'SomeCommand',
92
+ parameters: { /* command parameters */ }
93
+ });
94
+ }
95
+ }
96
+ ```
97
+
98
+ ## Features
99
+
100
+ - **Unreal Scene Component**: Embed Unreal Engine content in Angular applications
101
+ - **Command API**: Send commands to Unreal Engine
102
+ - **Event Handling**: React to events from Unreal Engine
103
+ - **State Management**: NgRx integration for managing 3D scene state
104
+ - **Configuration Options**: Customize the Unreal Engine integration
105
+
106
+ ## Examples
107
+
108
+ Check the demo application for complete usage examples:
109
+
110
+ ```shell
111
+ npm run demo:start
112
+ ```