# Arcware Cloud Pixel Streaming WebSDK

## Introduction

Welcome to the `@arcware-cloud/pixelstreaming-websdk`, a robust solution tailored for integrating Unreal Engine's Pixel Streaming technology into web applications via Arcware Cloud. This SDK is an extension of Epic Games' "PixelStreamingInfrastructure", enriching it with functionalities specifically designed for Arcware Cloud. It empowers developers to deliver interactive 3D experiences of exceptional quality directly to modern web browsers, eliminating the need for any plugins or downloads.

If you are not familiar with Arcware Cloud yet, check it out on [www.arcware.com](https://arcware.com/).

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.

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).

## Getting Started

### Prerequisites

Before integrating the `@arcware-cloud/pixelstreaming-websdk` into your project, please ensure the following prerequisites are met:

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 Cloud 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/arcware-cloud-platform/getting-started-with-arcware-cloud/sharing-your-project.-preview-and-share-the-stream).

2. **Web Application Development Environment**: Please check out our documentation [Arcware Pixel Streaming WebSDK Getting started](https://docs.arcware.cloud/web-integration/new-websdk/getting-started)

# CHANGELOG

Our changelog moved to the documentation: [CHANGELOG](https://docs.arcware.cloud/web-integration/new-websdk/changelog)

# LICENSE

MIT License

Copyright 2026 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:

- [@epicgames-ps/lib-pixelstreamingfrontend-ue5.5](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/LICENSE.md)
- [@epicgames-ps/lib-pixelstreamingfrontend-ui-ue5.5](https://github.com/EpicGames/PixelStreamingInfrastructure/blob/master/LICENSE.md)
- [@epicgames-ps/lib-pixelstreamingcommon-ue5.5](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.