@arcware-cloud/pixelstreaming-websdk 0.1.0-beta → 0.1.2

package/README.md

@@ -1,70 +1,138 @@
-# Getting Started with Arcware Pixel Streaming WebSDK
+# Arcware CloudRT Pixel Streaming WebSDK
 
-This guide will walk you through the initial steps to integrate the New Arcware Pixel Streaming WebSDK into your web application. The process is streamlined to get you up and running quickly.
+## Introduction
 
-\*\*\*Note: This library wraps the "PixelStreamingInfrastructure" repository of EpicGames. For more info see the github repo: https://github.com/EpicGames/PixelStreamingInfrastructure
+Welcome to the `@arcware-cloud/pixelstreaming-websdk`, a robust solution tailored for integrating Unreal Engine's Pixel Streaming technology into web applications via Arcware CloudRT. This SDK is an extension of Epic Games' "PixelStreamingInfrastructure", enriching it with functionalities specifically designed for Arcware CloudRT. It empowers developers to deliver interactive 3D experiences of exceptional quality directly to modern web browsers, eliminating the need for any plugins or downloads.
 
-## Prerequisites
+If you are not familiar with Arcware CloudRT yet, check it out on [www.arcware.com](https://arcware.com/cloudrt).
 
-Before you begin, ensure you have the following:
+The WebSDK is designed to bring immersive experiences, similar to those found in native applications, to the web. It's enabled for a range of applications, from gaming and architectural visualization to interactive training. Bringing high quality real-time and ensures a seamless user experience.
 
-- Node.js installed on your system.
-- Access to Unreal Engine's Pixel Streaming setup.
-- A web application where you wish to implement the SDK.
+This README offers an initial guide to integrating the WebSDK into your application. For comprehensive instructions, including setup, configuration, advanced features, and best practices, please refer to our detailed documentation: [Arcware Pixel Streaming WebSDK Documentation](https://docs.arcware.cloud/web-integration/final-link-missing).
 
-## Installation
+For an in-depth understanding of the underlying technology and infrastructure, you can explore the original "PixelStreamingInfrastructure" repository by Epic Games on GitHub: [EpicGames/PixelStreamingInfrastructure](https://github.com/EpicGames/PixelStreamingInfrastructure).
 
-To install the Arcware Pixel Streaming WebSDK, run the following command in your project's root directory:
+## Getting Started
 
-`npm install @arcware-cloud/pixelstreaming-websdk --save`
+### Prerequisites
 
-Or if you prefer using Yarn:
+Before integrating the `@arcware-cloud/pixelstreaming-websdk` into your project, please ensure the following prerequisites are met:
 
-`yarn add @arcware-cloud/pixelstreaming-websdk`
+1. **Share ID**: You must have a valid Share ID set up for your project. This ID is crucial for establishing the connection between your application and the Arcware CloudRT pixel streaming service. If you need assistance in setting up your Share ID, please refer to our detailed guide: [Setting up Share ID](https://docs.arcware.cloud/cloudrt-user-portal/getting-started/07.-preview-and-share-the-stream#share-your-project).
 
-## Quick Start Guide
+2. **Web Application Development Environment**: Ensure that your web application development environment is set up with either `yarn` or `npm`. These package managers are required for installing the WebSDK.
 
-### Step 1: Import and Configure
+3. **TypeScript Recommendation**: While the SDK can be used with JavaScript, we strongly recommend using TypeScript in your development process. TypeScript offers enhanced code quality, readability, and will provide you with more intrinsic information during development, often surpassing what traditional documentation can offer.
 
-Import the necessary classes from the SDK and create a new `ArcwareConfig` object to configure your Pixel Streaming instance.
 
-    import { ArcwareConfig, ArcwarePixelStreaming } from "@arcware-cloud/pixelstreaming-websdk";
 
-    const config = new ArcwareConfig({
-      useUrlParams: false,
-      initialSettings: {
-        // Your initial settings here
-      },
-      settings: {
-        // Your custom settings here
-      },
-    });`
+### Installation
 
-### Step 2: Initialize ArcwarePixelStreaming
+To integrate the Arcware CloudRT Pixel Streaming WebSDK into your project, you can use either npm or yarn. Run one of the following commands in your project directory:
+
+```bash
+npm install @arcware-cloud/pixelstreaming-websdk --save
+```
+```bash
+yarn add @arcware-cloud/pixelstreaming-websdk
+```
+
+We recommend keeping the WebSDK up to date to ensure you have the latest features and bug fixes. Regularly check for and install updates.
+
+### Basic Usage
+Below is a simple example demonstrating how to use the WebSDK in an HTML file to set up pixel streaming. This example imports the SDK and initializes it with a share ID and initial settings. It then attaches the streaming application to a div element in your HTML.
+```html
+<html>
+  <head>
+    <title>Arcware CloudRT - Pixel Streaming</title>
+    <script type="module">
+      import * as PixelStreamingWebSdkCore from "https://unpkg.com/@arcware-cloud/pixelstreaming-websdk@latest/index.esm.js";
+
+      const { ArcwareInit } = PixelStreamingWebSdkCore;
+
+      const { Config, PixelStreaming, Application } = ArcwareInit(
+        {
+          // Replace with your actual share ID
+          shareId: "share-0be4620b-77aa-42b1-98cb-f7ee61be443?",
+        },
+        {
+          initialSettings: {
+            AutoConnect: false
+            // additional initial settings
+          },
+          settings: {
+            // additional settings
+          }
+        }
+      );
+
+      document.getElementById("videoContainer").appendChild(Application.rootElement);
+    </script>
+  </head>
+  <body>
+    <div id="videoContainer" style="height: 1000px; width: 1000px;"></div>
+  </body>
+</html>
+```
+
+For more detailed examples and advanced usage, please refer to our documentation: [Arcware CloudRT Pixelstreaming WebSDK Documentation](https://docs.arcware.cloud/final-link-missing).
 
-Create an instance of `ArcwarePixelStreaming` by passing the configuration object. This instance will manage the streaming session.
 
-`const pixelStreamingInstance = new ArcwarePixelStreaming(config);`
+# Changelog
 
-### Step 3: Embed into Your Application
+### 0.1.* (Initial Release)
+<!-- - Upcoming changes or improvements that are currently in development can be listed here.
 
-Append the `ArcwarePixelStreaming` instance to your application's DOM to start the streaming session.
+### [Version Number] - Release Date
 
-    document.getElementById('your-container-id').appendChild(pixelStreamingInstance.rootElement);
+#### Added
+- List of new features or additions to the WebSDK in this release.
 
-## Next Steps
+#### Changed
+- Updates to existing features or overall improvements to the WebSDK.
 
-After you've successfully integrated the basic streaming functionality, you can explore more advanced features of the SDK to enhance your application.
+#### Deprecated
+- Features that are planned to be removed in future releases.
 
-Remember, as this SDK is in beta, you are encouraged to provide feedback and report any issues you encounter. Your contributions are valuable to the continuous improvement of the WebSDK.
+#### Removed
+- Features or functionalities that have been removed from the WebSDK.
 
-## Configuration and Initialization
+#### Fixed
+- Bug fixes and corrections made in this release.
 
-Configuration and Initialization the New Arcware Pixel Streaming WebSDK is designed to be flexible and easily configurable to fit the needs of various web applications.
+### [Previous Version Number] - Previous Release Date
+- Changes for previous versions follow the same format. -->
 
-Below, we'll explain the configuration options and initialization process based on the provided React code example.
 
-### Configuration Options
+# LICENSE
+
+MIT License
+
+Copyright 2023 Arcware GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 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.
+
+## Dependency Licenses
+
+This software inherits code from several other libraries, namely:
+
+- [zod](https://github.com/colinhacks/zod/blob/master/LICENSE)
+- [moment.js](https://github.com/moment/moment/blob/develop/LICENSE)
+- [loadash](https://github.com/lodash/lodash/blob/main/LICENSE)
+- [lottie-web](https://github.com/airbnb/lottie-web/blob/master/LICENSE.md)
+- [@epicgames-ps/lib-pixelstreamingfrontend-ue5.2](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/LICENSE.md)
+- [@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/LICENSE.md)
+
+Here's a summary of these [Dependency Licenses](https://www.npmjs.com/package/@arcware-cloud/pixelstreaming-websdk?activeTab=code)/DEPENDENCY_LICENSE.md.
+
+We appreciate the contributions of these libraries, as they are essential in supporting our development efforts.
+
+
+<!-- # Configuration Options
 
 When creating a new instance of `ArcwareConfig`, you provide an object with two main properties: `initialSettings` and `settings`.
 
@@ -110,95 +178,4 @@ Once initialized, `pixelStreamingInstance` can be used to interact with the stre
     });
 
 - ` application.getApplicationResponse(``string``) `: This method can be called to get a response from the application, which might include status updates or other messages.
-- `application.emitUIInteraction(descriptor:` ` object | string``) `: This method allows you to send UI interaction events to the streaming application, such as button presses or command inputs.
-
-# Implementation Examples
-
-## Plain HTML
-
-Please ensure in the following examples, to use
-
-### index.esm.js (recommended)
-
-```html
-<html>
-  <head>
-    <title>Arcware CloudRT - Pixel Streaming</title>
-    <script type="module">
-      import * as PixelStreamingWebSdkCore from "https://unpkg.com/@arcware-cloud/pixelstreaming-websdk@0.0.2-beta/index.esm.js";
-
-      const { ArcwareConfig, ArcwarePixelStreaming, ArcwareApplication } = PixelStreamingWebSdkCore;
-
-      const application = new ArcwareApplication({
-        stream: new ArcwarePixelStreaming(
-          new ArcwareConfig({
-            useUrlParams: true,
-            initialSettings: {
-              ss: "wss://signalling-client.ragnarok.arcware.cloud/",
-              StartVideoMuted: true,
-              AutoConnect: true,
-              AutoPlayVideo: true,
-            },
-            settings: {
-              // If you figure out the last digit of the id, feel free to try :)
-              shareId: "share-0be4620b-77aa-42b1-98cb-f7ee61be443?",
-              audioButton: true,
-              fullscreenButton: true,
-            },
-          })
-        ),
-      });
-
-      document.getElementById("videoContainer").appendChild(application.rootElement);
-    </script>
-  </head>
-  <body>
-    <div id="videoContainer" style="height: 1000px; width: 1000px;"></div>
-  </body>
-</html>
-```
-
-### index.esm.js
-
-```html
-<script src="https://unpkg.com/@arcware-cloud/pixelstreaming-websdk@0.0.2-beta/index.umd.js"></script>
-<script type="module">
-  const { ArcwareConfig, ArcwarePixelStreaming, ArcwareApplication } = window.arcware; // Module name, subject to change.
-  // Rest of the script as above (esm).
-</script>
-```
-
-## Library implementation examples
-
-### React
-
-coming soon
-
-### Other
-
-coming soon
-
-# LICENSE
-
-MIT License
-
-Copyright 2023 Arcware GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-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 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 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.
-
-## Dependency Licenses
-
-This software inherits code from several other libraries, namely:
-
-- [zod](https://github.com/colinhacks/zod/blob/master/LICENSE)
-- [moment.js](https://github.com/moment/moment/blob/develop/LICENSE)
-- [loadash](https://github.com/lodash/lodash/blob/main/LICENSE)
-- [lottie-web](https://github.com/airbnb/lottie-web/blob/master/LICENSE.md)
-- [@epicgames-ps/lib-pixelstreamingfrontend-ue5.2](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/LICENSE.md)
-- [@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.2](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/LICENSE.md)
-
-Here's a summary of these [Dependency Licenses](DEPENDENCY_LICENSE.md).
+- `application.emitUIInteraction(descriptor:` ` object | string``) `: This method allows you to send UI interaction events to the streaming application, such as button presses or command inputs. -->